rgb-cln/hsmd/hsmd_wire.csv

1	# Clients should not give a bad request but not the HSM's decision to crash.
2	msgtype,hsmstatus_client_bad_request,1000
3	msgdata,hsmstatus_client_bad_request,id,node_id,
4	msgdata,hsmstatus_client_bad_request,description,wirestring,
5	msgdata,hsmstatus_client_bad_request,len,u16,
6	msgdata,hsmstatus_client_bad_request,msg,u8,len
7	#include <bitcoin/chainparams.h>
8	# Start the HSM.
9	msgtype,hsmd_init,11
10	msgdata,hsmd_init,bip32_key_version,bip32_key_version,
11	msgdata,hsmd_init,chainparams,chainparams,
12	msgdata,hsmd_init,hsm_encryption_key,?secret,
13	msgdata,hsmd_init,dev_force_privkey,?privkey,
14	msgdata,hsmd_init,dev_force_bip32_seed,?secret,
15	msgdata,hsmd_init,dev_force_channel_secrets,?secrets,
16	msgdata,hsmd_init,dev_force_channel_secrets_shaseed,?sha256,
17	#include <common/bip32.h>
18	msgtype,hsmd_init_reply,111
19	msgdata,hsmd_init_reply,node_id,node_id,
20	msgdata,hsmd_init_reply,bip32,ext_key,
21	msgdata,hsmd_init_reply,bolt12,point32,
22	msgdata,hsmd_init_reply,onion_reply_secret,secret,
23	# Get a new HSM FD, with the specified capabilities
24	msgtype,hsmd_client_hsmfd,9
25	# Which identity to use for requests
26	msgdata,hsmd_client_hsmfd,id,node_id,
27	# Database id for this client, if any.
28	msgdata,hsmd_client_hsmfd,dbid,u64,
29	msgdata,hsmd_client_hsmfd,capabilities,u64,
30	# No content, just an fd.
31	msgtype,hsmd_client_hsmfd_reply,109
32	#include <common/derive_basepoints.h>
33	# Get the basepoints and funding key for this specific channel.
34	msgtype,hsmd_get_channel_basepoints,10
35	msgdata,hsmd_get_channel_basepoints,peerid,node_id,
36	msgdata,hsmd_get_channel_basepoints,dbid,u64,
37	msgtype,hsmd_get_channel_basepoints_reply,110
38	msgdata,hsmd_get_channel_basepoints_reply,basepoints,basepoints,
39	msgdata,hsmd_get_channel_basepoints_reply,funding_pubkey,pubkey,
40	# Return signature for a funding tx.
41	#include <common/utxo.h>
42	# Master asks the HSM to sign a node_announcement
43	msgtype,hsmd_node_announcement_sig_req,6
44	msgdata,hsmd_node_announcement_sig_req,annlen,u16,
45	msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen
46	msgtype,hsmd_node_announcement_sig_reply,106
47	msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
48	# Sign a withdrawal request
49	#include <bitcoin/psbt.h>
50	msgtype,hsmd_sign_withdrawal,7
51	msgdata,hsmd_sign_withdrawal,num_inputs,u16,
52	msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
53	msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,
54	msgtype,hsmd_sign_withdrawal_reply,107
55	msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,
56	# Sign an invoice
57	msgtype,hsmd_sign_invoice,8
58	msgdata,hsmd_sign_invoice,len,u16,
59	msgdata,hsmd_sign_invoice,u5bytes,u8,len
60	msgdata,hsmd_sign_invoice,hrplen,u16,
61	msgdata,hsmd_sign_invoice,hrp,u8,hrplen
62	msgtype,hsmd_sign_invoice_reply,108
63	msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
64	# Give me ECDH(node-id-secret,point)
65	msgtype,hsmd_ecdh_req,1
66	msgdata,hsmd_ecdh_req,point,pubkey,
67	msgtype,hsmd_ecdh_resp,100
68	msgdata,hsmd_ecdh_resp,ss,secret,
69	msgtype,hsmd_cannouncement_sig_req,2
70	msgdata,hsmd_cannouncement_sig_req,calen,u16,
71	msgdata,hsmd_cannouncement_sig_req,ca,u8,calen
72	msgtype,hsmd_cannouncement_sig_reply,102
73	msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
74	msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
75	msgtype,hsmd_cupdate_sig_req,3
76	msgdata,hsmd_cupdate_sig_req,culen,u16,
77	msgdata,hsmd_cupdate_sig_req,cu,u8,culen
78	msgtype,hsmd_cupdate_sig_reply,103
79	msgdata,hsmd_cupdate_sig_reply,culen,u16,
80	msgdata,hsmd_cupdate_sig_reply,cu,u8,culen
81	# Master asks HSM to sign a commitment transaction.
82	msgtype,hsmd_sign_commitment_tx,5
83	msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
84	msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
85	msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
86	msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
87	msgtype,hsmd_sign_commitment_tx_reply,105
88	msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
89	# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
90	# of keys is derived differently...
91	# FIXME: Have master tell hsmd the keyindex, so it can validate output!
92	msgtype,hsmd_sign_delayed_payment_to_us,12
93	msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
94	msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
95	msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
96	msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len
97	msgtype,hsmd_sign_remote_htlc_to_us,13
98	msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
99	msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
100	msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
101	msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
102	msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,
103	msgtype,hsmd_sign_penalty_to_us,14
104	msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
105	msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
106	msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
107	msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len
108	# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
109	msgtype,hsmd_sign_local_htlc_tx,16
110	msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
111	msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
112	msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
113	msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
114	msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,
115	# Openingd/channeld asks HSM to sign the other sides' commitment tx.
116	msgtype,hsmd_sign_remote_commitment_tx,19
117	msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
118	msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
119	msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
120	msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
121	# channeld asks HSM to sign remote HTLC tx.
122	msgtype,hsmd_sign_remote_htlc_tx,20
123	msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
124	msgdata,hsmd_sign_remote_htlc_tx,len,u16,
125	msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
126	msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
127	msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,
128	# closingd asks HSM to sign mutual close tx.
129	msgtype,hsmd_sign_mutual_close_tx,21
130	msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
131	msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,
132	# Reply for all the above requests.
133	msgtype,hsmd_sign_tx_reply,112
134	msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,
135	# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
136	msgtype,hsmd_get_per_commitment_point,18
137	msgdata,hsmd_get_per_commitment_point,n,u64,
138	msgtype,hsmd_get_per_commitment_point_reply,118
139	msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
140	msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,
141	# master -> hsmd: do you have a memleak?
142	msgtype,hsmd_dev_memleak,33
143	msgtype,hsmd_dev_memleak_reply,133
144	msgdata,hsmd_dev_memleak_reply,leak,bool,
145	# channeld asks to check if claimed future commitment_secret is correct.
146	msgtype,hsmd_check_future_secret,22
147	msgdata,hsmd_check_future_secret,n,u64,
148	msgdata,hsmd_check_future_secret,commitment_secret,secret,
149	msgtype,hsmd_check_future_secret_reply,122
150	msgdata,hsmd_check_future_secret_reply,correct,bool,
151	# lightningd asks us to sign a string.
152	msgtype,hsmd_sign_message,23
153	msgdata,hsmd_sign_message,len,u16,
154	msgdata,hsmd_sign_message,msg,u8,len
155	msgtype,hsmd_sign_message_reply,123
156	msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,
157	# lightningd needs to get a scriptPubkey for a utxo with closeinfo
158	msgtype,hsmd_get_output_scriptpubkey,24
159	msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
160	msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
161	msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,
162	msgtype,hsmd_get_output_scriptpubkey_reply,124
163	msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
164	msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len
165	# Sign a bolt12-style merkle hash
166	msgtype,hsmd_sign_bolt12,25
167	msgdata,hsmd_sign_bolt12,messagename,wirestring,
168	msgdata,hsmd_sign_bolt12,fieldname,wirestring,
169	msgdata,hsmd_sign_bolt12,merkleroot,sha256,
170	# This is for invreq payer_id (temporary keys)
171	msgdata,hsmd_sign_bolt12,publictweaklen,u16,
172	msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen
173	msgtype,hsmd_sign_bolt12_reply,125
174	msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,
175	# Sign an option_will_fund offer hash
176	msgtype,hsmd_sign_option_will_fund_offer,26
177	msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
178	msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
179	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
180	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,
181	msgtype,hsmd_sign_option_will_fund_offer_reply,126
182	msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,