core-lightning/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	msgdata,hsmd_init,hsm_wire_min_version,u32,
18	msgdata,hsmd_init,hsm_wire_max_version,u32,
19	#include <common/bip32.h>
20	# DEPRECATED after 23.05, remove in two versions!
21	msgtype,hsmd_init_reply_v2,113
22	msgdata,hsmd_init_reply_v2,node_id,node_id,
23	msgdata,hsmd_init_reply_v2,bip32,ext_key,
24	msgdata,hsmd_init_reply_v2,bolt12,pubkey,
25	# Sorry: I should have put version in v2 :(
26	msgtype,hsmd_init_reply_v4,114
27	# This gets upgraded when the wire protocol changes in incompatible
28	# ways:
29	msgdata,hsmd_init_reply_v4,hsm_version,u32,
30	# Capabilities, by convention are message numbers, indicating
31	# that the HSM supports you sending this message.
32	msgdata,hsmd_init_reply_v4,num_hsm_capabilities,u16,
33	msgdata,hsmd_init_reply_v4,hsm_capabilities,u32,num_hsm_capabilities
34	msgdata,hsmd_init_reply_v4,node_id,node_id,
35	msgdata,hsmd_init_reply_v4,bip32,ext_key,
36	msgdata,hsmd_init_reply_v4,bolt12,pubkey,
37	# Declare a new channel.
38	msgtype,hsmd_new_channel,30
39	msgdata,hsmd_new_channel,id,node_id,
40	msgdata,hsmd_new_channel,dbid,u64,
41	# No value returned.
42	msgtype,hsmd_new_channel_reply,130
43	# Get a new HSM FD, with the specified permissions
44	msgtype,hsmd_client_hsmfd,9
45	# Which identity to use for requests
46	msgdata,hsmd_client_hsmfd,id,node_id,
47	# Database id for this client, if any.
48	msgdata,hsmd_client_hsmfd,dbid,u64,
49	msgdata,hsmd_client_hsmfd,permissions,u64,
50	# No content, just an fd.
51	msgtype,hsmd_client_hsmfd_reply,109
52	#include <common/derive_basepoints.h>
53	# Get the basepoints and funding key for this specific channel.
54	msgtype,hsmd_get_channel_basepoints,10
55	msgdata,hsmd_get_channel_basepoints,peerid,node_id,
56	msgdata,hsmd_get_channel_basepoints,dbid,u64,
57	msgtype,hsmd_get_channel_basepoints_reply,110
58	msgdata,hsmd_get_channel_basepoints_reply,basepoints,basepoints,
59	msgdata,hsmd_get_channel_basepoints_reply,funding_pubkey,pubkey,
60	#include <common/channel_type.h>
61	# Provide channel parameters.
62	msgtype,hsmd_setup_channel,31
63	msgdata,hsmd_setup_channel,is_outbound,bool,
64	msgdata,hsmd_setup_channel,channel_value,amount_sat,
65	msgdata,hsmd_setup_channel,push_value,amount_msat,
66	msgdata,hsmd_setup_channel,funding_txid,bitcoin_txid,
67	msgdata,hsmd_setup_channel,funding_txout,u16,
68	msgdata,hsmd_setup_channel,local_to_self_delay,u16,
69	msgdata,hsmd_setup_channel,local_shutdown_script_len,u16,
70	msgdata,hsmd_setup_channel,local_shutdown_script,u8,local_shutdown_script_len
71	msgdata,hsmd_setup_channel,local_shutdown_wallet_index,?u32,
72	msgdata,hsmd_setup_channel,remote_basepoints,basepoints,
73	msgdata,hsmd_setup_channel,remote_funding_pubkey,pubkey,
74	msgdata,hsmd_setup_channel,remote_to_self_delay,u16,
75	msgdata,hsmd_setup_channel,remote_shutdown_script_len,u16,
76	msgdata,hsmd_setup_channel,remote_shutdown_script,u8,remote_shutdown_script_len
77	msgdata,hsmd_setup_channel,channel_type,channel_type,
78	# No value returned.,
79	msgtype,hsmd_setup_channel_reply,131
80	# check if the signer agrees that a funding candidate outpoint is buried
81	msgtype,hsmd_check_outpoint,32
82	msgdata,hsmd_check_outpoint,funding_txid,bitcoin_txid,
83	msgdata,hsmd_check_outpoint,funding_txout,u16,
84	msgtype,hsmd_check_outpoint_reply,132
85	msgdata,hsmd_check_outpoint_reply,is_buried,bool,
86	# change the funding/splice state to locked
87	msgtype,hsmd_lock_outpoint,37
88	msgdata,hsmd_lock_outpoint,funding_txid,bitcoin_txid,
89	msgdata,hsmd_lock_outpoint,funding_txout,u16,
90	# No value returned.
91	msgtype,hsmd_lock_outpoint_reply,137
92	# Forget channel.
93	msgtype,hsmd_forget_channel,34
94	msgdata,hsmd_forget_channel,id,node_id,
95	msgdata,hsmd_forget_channel,dbid,u64,
96	# No value returned.
97	msgtype,hsmd_forget_channel_reply,134
98	# Return signature for a funding tx.
99	#include <common/utxo.h>
100	# Master asks the HSM to sign a node_announcement
101	msgtype,hsmd_node_announcement_sig_req,6
102	msgdata,hsmd_node_announcement_sig_req,annlen,u16,
103	msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen
104	msgtype,hsmd_node_announcement_sig_reply,106
105	msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
106	# Sign a withdrawal request
107	#include <bitcoin/psbt.h>
108	msgtype,hsmd_sign_withdrawal,7
109	msgdata,hsmd_sign_withdrawal,num_inputs,u16,
110	msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
111	msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,
112	msgtype,hsmd_sign_withdrawal_reply,107
113	msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,
114	# Sign an invoice
115	msgtype,hsmd_sign_invoice,8
116	msgdata,hsmd_sign_invoice,len,u16,
117	msgdata,hsmd_sign_invoice,u5bytes,u8,len
118	msgdata,hsmd_sign_invoice,hrplen,u16,
119	msgdata,hsmd_sign_invoice,hrp,u8,hrplen
120	msgtype,hsmd_sign_invoice_reply,108
121	msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
122	# Preapprove an invoice for payment
123	msgtype,hsmd_preapprove_invoice,38
124	msgdata,hsmd_preapprove_invoice,invstring,wirestring,
125	# Result is true if approved, declined if false
126	msgtype,hsmd_preapprove_invoice_reply,138
127	msgdata,hsmd_preapprove_invoice_reply,approved,bool,
128	# Preapprove a keysend payment
129	msgtype,hsmd_preapprove_keysend,39
130	msgdata,hsmd_preapprove_keysend,destination,node_id,
131	msgdata,hsmd_preapprove_keysend,payment_hash,sha256,
132	msgdata,hsmd_preapprove_keysend,amount_msat,amount_msat,
133	# Result is true if approved, declined if false
134	msgtype,hsmd_preapprove_keysend_reply,139
135	msgdata,hsmd_preapprove_keysend_reply,approved,bool,
136	# Give me ECDH(node-id-secret,point)
137	msgtype,hsmd_ecdh_req,1
138	msgdata,hsmd_ecdh_req,point,pubkey,
139	msgtype,hsmd_ecdh_resp,100
140	msgdata,hsmd_ecdh_resp,ss,secret,
141	msgtype,hsmd_cannouncement_sig_req,2
142	msgdata,hsmd_cannouncement_sig_req,calen,u16,
143	msgdata,hsmd_cannouncement_sig_req,ca,u8,calen
144	msgtype,hsmd_cannouncement_sig_reply,102
145	msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
146	msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
147	msgtype,hsmd_cupdate_sig_req,3
148	msgdata,hsmd_cupdate_sig_req,culen,u16,
149	msgdata,hsmd_cupdate_sig_req,cu,u8,culen
150	msgtype,hsmd_cupdate_sig_reply,103
151	msgdata,hsmd_cupdate_sig_reply,culen,u16,
152	msgdata,hsmd_cupdate_sig_reply,cu,u8,culen
153	# Master asks HSM to sign a commitment transaction.
154	msgtype,hsmd_sign_commitment_tx,5
155	msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
156	msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
157	msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
158	msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
159	msgdata,hsmd_sign_commitment_tx,commit_num,u64,
160	msgtype,hsmd_sign_commitment_tx_reply,105
161	msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
162	# Validate the counterparty's commitment signatures.
163	msgtype,hsmd_validate_commitment_tx,35
164	msgdata,hsmd_validate_commitment_tx,tx,bitcoin_tx,
165	msgdata,hsmd_validate_commitment_tx,num_htlcs,u16,
166	msgdata,hsmd_validate_commitment_tx,htlcs,simple_htlc,num_htlcs
167	msgdata,hsmd_validate_commitment_tx,commit_num,u64,
168	msgdata,hsmd_validate_commitment_tx,feerate,u32,
169	msgdata,hsmd_validate_commitment_tx,sig,bitcoin_signature,
170	msgdata,hsmd_validate_commitment_tx,num_htlc_sigs,u16,
171	msgdata,hsmd_validate_commitment_tx,htlc_sigs,bitcoin_signature,num_htlc_sigs
172	msgtype,hsmd_validate_commitment_tx_reply,135
173	msgdata,hsmd_validate_commitment_tx_reply,old_commitment_secret,?secret,
174	msgdata,hsmd_validate_commitment_tx_reply,next_per_commitment_point,pubkey,
175	# Vaidate the counterparty's revocation secret
176	msgtype,hsmd_validate_revocation,36
177	msgdata,hsmd_validate_revocation,revoke_num,u64,
178	msgdata,hsmd_validate_revocation,per_commitment_secret,secret,
179	# No value returned.
180	msgtype,hsmd_validate_revocation_reply,136
181	# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
182	# of keys is derived differently...
183	msgtype,hsmd_sign_delayed_payment_to_us,12
184	msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
185	msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
186	msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
187	msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len
188	msgtype,hsmd_sign_remote_htlc_to_us,13
189	msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
190	msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
191	msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
192	msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
193	msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,
194	msgtype,hsmd_sign_penalty_to_us,14
195	msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
196	msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
197	msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
198	msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len
199	# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
200	msgtype,hsmd_sign_local_htlc_tx,16
201	msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
202	msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
203	msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
204	msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
205	msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,
206	# Openingd/channeld asks HSM to sign the other sides' commitment tx.
207	#include <common/htlc_wire.h>
208	msgtype,hsmd_sign_remote_commitment_tx,19
209	msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
210	msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
211	msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
212	msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
213	msgdata,hsmd_sign_remote_commitment_tx,commit_num,u64,
214	msgdata,hsmd_sign_remote_commitment_tx,num_htlcs,u16,
215	msgdata,hsmd_sign_remote_commitment_tx,htlcs,simple_htlc,num_htlcs
216	msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,
217	# channeld asks HSM to sign remote HTLC tx.
218	msgtype,hsmd_sign_remote_htlc_tx,20
219	msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
220	msgdata,hsmd_sign_remote_htlc_tx,len,u16,
221	msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
222	msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
223	msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,
224	# closingd asks HSM to sign mutual close tx.
225	msgtype,hsmd_sign_mutual_close_tx,21
226	msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
227	msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,
228	# channeld asks HSM to sign splice tx.
229	msgtype,hsmd_sign_splice_tx,29
230	msgdata,hsmd_sign_splice_tx,tx,bitcoin_tx,
231	msgdata,hsmd_sign_splice_tx,remote_funding_key,pubkey,
232	msgdata,hsmd_sign_splice_tx,input_index,u32,
233	# Reply for all the above requests.
234	msgtype,hsmd_sign_tx_reply,112
235	msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,
236	# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
237	msgtype,hsmd_get_per_commitment_point,18
238	msgdata,hsmd_get_per_commitment_point,n,u64,
239	msgtype,hsmd_get_per_commitment_point_reply,118
240	msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
241	msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,
242	# master -> hsmd: do you have a memleak?
243	msgtype,hsmd_dev_memleak,33
244	msgtype,hsmd_dev_memleak_reply,133
245	msgdata,hsmd_dev_memleak_reply,leak,bool,
246	# channeld asks to check if claimed future commitment_secret is correct.
247	msgtype,hsmd_check_future_secret,22
248	msgdata,hsmd_check_future_secret,n,u64,
249	msgdata,hsmd_check_future_secret,commitment_secret,secret,
250	msgtype,hsmd_check_future_secret_reply,122
251	msgdata,hsmd_check_future_secret_reply,correct,bool,
252	# lightningd asks us to sign a string.
253	msgtype,hsmd_sign_message,23
254	msgdata,hsmd_sign_message,len,u16,
255	msgdata,hsmd_sign_message,msg,u8,len
256	msgtype,hsmd_sign_message_reply,123
257	msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,
258	# lightningd needs to get a scriptPubkey for a utxo with closeinfo
259	msgtype,hsmd_get_output_scriptpubkey,24
260	msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
261	msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
262	msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,
263	msgtype,hsmd_get_output_scriptpubkey_reply,124
264	msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
265	msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len
266	# Sign a bolt12-style merkle hash
267	msgtype,hsmd_sign_bolt12,25
268	msgdata,hsmd_sign_bolt12,messagename,wirestring,
269	msgdata,hsmd_sign_bolt12,fieldname,wirestring,
270	msgdata,hsmd_sign_bolt12,merkleroot,sha256,
271	# This is for invreq payer_id (temporary keys)
272	msgdata,hsmd_sign_bolt12,publictweaklen,u16,
273	msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen
274	msgtype,hsmd_sign_bolt12_reply,125
275	msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,
276	# Sign an option_will_fund offer hash
277	msgtype,hsmd_sign_option_will_fund_offer,26
278	msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
279	msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
280	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
281	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,
282	msgtype,hsmd_sign_option_will_fund_offer_reply,126
283	msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,
284	# Derive pseudorandom secret
285	msgtype,hsmd_derive_secret,27
286	msgdata,hsmd_derive_secret,len,u16,
287	msgdata,hsmd_derive_secret,info,u8,len
288	# Reply with the derived secret
289	msgtype,hsmd_derive_secret_reply,127
290	msgdata,hsmd_derive_secret_reply,secret,secret,
291	# Sanity check this pubkey derivation is correct (unhardened only)
292	msgtype,hsmd_check_pubkey,28
293	msgdata,hsmd_check_pubkey,index,u32,
294	msgdata,hsmd_check_pubkey,pubkey,pubkey,
295	# Reply
296	msgtype,hsmd_check_pubkey_reply,128
297	msgdata,hsmd_check_pubkey_reply,ok,bool,
298	msgtype,hsmd_sign_anchorspend,147
299	msgdata,hsmd_sign_anchorspend,peerid,node_id,
300	msgdata,hsmd_sign_anchorspend,channel_dbid,u64,
301	msgdata,hsmd_sign_anchorspend,num_inputs,u16,
302	msgdata,hsmd_sign_anchorspend,inputs,utxo,num_inputs
303	msgdata,hsmd_sign_anchorspend,psbt,wally_psbt,
304	msgtype,hsmd_sign_anchorspend_reply,148
305	msgdata,hsmd_sign_anchorspend_reply,psbt,wally_psbt,
306	# These are where lightningd asks for signatures on onchaind's behalf.
307	msgtype,hsmd_sign_any_delayed_payment_to_us,142
308	msgdata,hsmd_sign_any_delayed_payment_to_us,commit_num,u64,
309	msgdata,hsmd_sign_any_delayed_payment_to_us,tx,bitcoin_tx,
310	msgdata,hsmd_sign_any_delayed_payment_to_us,wscript_len,u16,
311	msgdata,hsmd_sign_any_delayed_payment_to_us,wscript,u8,wscript_len
312	msgdata,hsmd_sign_any_delayed_payment_to_us,input,u32,
313	msgdata,hsmd_sign_any_delayed_payment_to_us,peerid,node_id,
314	msgdata,hsmd_sign_any_delayed_payment_to_us,channel_dbid,u64,
315	msgtype,hsmd_sign_any_remote_htlc_to_us,143
316	msgdata,hsmd_sign_any_remote_htlc_to_us,remote_per_commitment_point,pubkey,
317	msgdata,hsmd_sign_any_remote_htlc_to_us,tx,bitcoin_tx,
318	msgdata,hsmd_sign_any_remote_htlc_to_us,wscript_len,u16,
319	msgdata,hsmd_sign_any_remote_htlc_to_us,wscript,u8,wscript_len
320	msgdata,hsmd_sign_any_remote_htlc_to_us,option_anchor_outputs,bool,
321	msgdata,hsmd_sign_any_remote_htlc_to_us,input,u32,
322	msgdata,hsmd_sign_any_remote_htlc_to_us,peerid,node_id,
323	msgdata,hsmd_sign_any_remote_htlc_to_us,channel_dbid,u64,
324	msgtype,hsmd_sign_any_penalty_to_us,144
325	msgdata,hsmd_sign_any_penalty_to_us,revocation_secret,secret,
326	msgdata,hsmd_sign_any_penalty_to_us,tx,bitcoin_tx,
327	msgdata,hsmd_sign_any_penalty_to_us,wscript_len,u16,
328	msgdata,hsmd_sign_any_penalty_to_us,wscript,u8,wscript_len
329	msgdata,hsmd_sign_any_penalty_to_us,input,u32,
330	msgdata,hsmd_sign_any_penalty_to_us,peerid,node_id,
331	msgdata,hsmd_sign_any_penalty_to_us,channel_dbid,u64,
332	msgtype,hsmd_sign_any_local_htlc_tx,146
333	msgdata,hsmd_sign_any_local_htlc_tx,commit_num,u64,
334	msgdata,hsmd_sign_any_local_htlc_tx,tx,bitcoin_tx,
335	msgdata,hsmd_sign_any_local_htlc_tx,wscript_len,u16,
336	msgdata,hsmd_sign_any_local_htlc_tx,wscript,u8,wscript_len
337	msgdata,hsmd_sign_any_local_htlc_tx,option_anchor_outputs,bool,
338	msgdata,hsmd_sign_any_local_htlc_tx,input,u32,
339	msgdata,hsmd_sign_any_local_htlc_tx,peerid,node_id,
340	msgdata,hsmd_sign_any_local_htlc_tx,channel_dbid,u64,
341	msgtype,hsmd_sign_htlc_tx_mingle,149
342	msgdata,hsmd_sign_htlc_tx_mingle,peerid,node_id,
343	msgdata,hsmd_sign_htlc_tx_mingle,channel_dbid,u64,
344	msgdata,hsmd_sign_htlc_tx_mingle,num_inputs,u16,
345	msgdata,hsmd_sign_htlc_tx_mingle,inputs,utxo,num_inputs
346	msgdata,hsmd_sign_htlc_tx_mingle,psbt,wally_psbt,
347	msgtype,hsmd_sign_htlc_tx_mingle_reply,150
348	msgdata,hsmd_sign_htlc_tx_mingle_reply,psbt,wally_psbt,