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	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 capabilities
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,capabilities,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_ready_channel,31
63	msgdata,hsmd_ready_channel,is_outbound,bool,
64	msgdata,hsmd_ready_channel,channel_value,amount_sat,
65	msgdata,hsmd_ready_channel,push_value,amount_msat,
66	msgdata,hsmd_ready_channel,funding_txid,bitcoin_txid,
67	msgdata,hsmd_ready_channel,funding_txout,u16,
68	msgdata,hsmd_ready_channel,local_to_self_delay,u16,
69	msgdata,hsmd_ready_channel,local_shutdown_script_len,u16,
70	msgdata,hsmd_ready_channel,local_shutdown_script,u8,local_shutdown_script_len
71	msgdata,hsmd_ready_channel,local_shutdown_wallet_index,?u32,
72	msgdata,hsmd_ready_channel,remote_basepoints,basepoints,
73	msgdata,hsmd_ready_channel,remote_funding_pubkey,pubkey,
74	msgdata,hsmd_ready_channel,remote_to_self_delay,u16,
75	msgdata,hsmd_ready_channel,remote_shutdown_script_len,u16,
76	msgdata,hsmd_ready_channel,remote_shutdown_script,u8,remote_shutdown_script_len
77	msgdata,hsmd_ready_channel,channel_type,channel_type,
78	# No value returned.
79	msgtype,hsmd_ready_channel_reply,131
80	# Return signature for a funding tx.
81	#include <common/utxo.h>
82	# Master asks the HSM to sign a node_announcement
83	msgtype,hsmd_node_announcement_sig_req,6
84	msgdata,hsmd_node_announcement_sig_req,annlen,u16,
85	msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen
86	msgtype,hsmd_node_announcement_sig_reply,106
87	msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
88	# Sign a withdrawal request
89	#include <bitcoin/psbt.h>
90	msgtype,hsmd_sign_withdrawal,7
91	msgdata,hsmd_sign_withdrawal,num_inputs,u16,
92	msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
93	msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,
94	msgtype,hsmd_sign_withdrawal_reply,107
95	msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,
96	# Sign an invoice
97	msgtype,hsmd_sign_invoice,8
98	msgdata,hsmd_sign_invoice,len,u16,
99	msgdata,hsmd_sign_invoice,u5bytes,u8,len
100	msgdata,hsmd_sign_invoice,hrplen,u16,
101	msgdata,hsmd_sign_invoice,hrp,u8,hrplen
102	msgtype,hsmd_sign_invoice_reply,108
103	msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
104	# Preapprove an invoice for payment
105	msgtype,hsmd_preapprove_invoice,38
106	msgdata,hsmd_preapprove_invoice,invstring,wirestring,
107	# Result is true if approved, declined if false
108	msgtype,hsmd_preapprove_invoice_reply,138
109	msgdata,hsmd_preapprove_invoice_reply,approved,bool,
110	# Preapprove a keysend payment
111	msgtype,hsmd_preapprove_keysend,39
112	msgdata,hsmd_preapprove_keysend,destination,node_id,
113	msgdata,hsmd_preapprove_keysend,payment_hash,sha256,
114	msgdata,hsmd_preapprove_keysend,amount_msat,amount_msat,
115	# Result is true if approved, declined if false
116	msgtype,hsmd_preapprove_keysend_reply,139
117	msgdata,hsmd_preapprove_keysend_reply,approved,bool,
118	# Give me ECDH(node-id-secret,point)
119	msgtype,hsmd_ecdh_req,1
120	msgdata,hsmd_ecdh_req,point,pubkey,
121	msgtype,hsmd_ecdh_resp,100
122	msgdata,hsmd_ecdh_resp,ss,secret,
123	msgtype,hsmd_cannouncement_sig_req,2
124	msgdata,hsmd_cannouncement_sig_req,calen,u16,
125	msgdata,hsmd_cannouncement_sig_req,ca,u8,calen
126	msgtype,hsmd_cannouncement_sig_reply,102
127	msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
128	msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
129	msgtype,hsmd_cupdate_sig_req,3
130	msgdata,hsmd_cupdate_sig_req,culen,u16,
131	msgdata,hsmd_cupdate_sig_req,cu,u8,culen
132	msgtype,hsmd_cupdate_sig_reply,103
133	msgdata,hsmd_cupdate_sig_reply,culen,u16,
134	msgdata,hsmd_cupdate_sig_reply,cu,u8,culen
135	# Master asks HSM to sign a commitment transaction.
136	msgtype,hsmd_sign_commitment_tx,5
137	msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
138	msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
139	msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
140	msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
141	msgdata,hsmd_sign_commitment_tx,commit_num,u64,
142	msgtype,hsmd_sign_commitment_tx_reply,105
143	msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
144	# Validate the counterparty's commitment signatures.
145	msgtype,hsmd_validate_commitment_tx,35
146	msgdata,hsmd_validate_commitment_tx,tx,bitcoin_tx,
147	msgdata,hsmd_validate_commitment_tx,num_htlcs,u16,
148	msgdata,hsmd_validate_commitment_tx,htlcs,simple_htlc,num_htlcs
149	msgdata,hsmd_validate_commitment_tx,commit_num,u64,
150	msgdata,hsmd_validate_commitment_tx,feerate,u32,
151	msgdata,hsmd_validate_commitment_tx,sig,bitcoin_signature,
152	msgdata,hsmd_validate_commitment_tx,num_htlc_sigs,u16,
153	msgdata,hsmd_validate_commitment_tx,htlc_sigs,bitcoin_signature,num_htlc_sigs
154	msgtype,hsmd_validate_commitment_tx_reply,135
155	msgdata,hsmd_validate_commitment_tx_reply,old_commitment_secret,?secret,
156	msgdata,hsmd_validate_commitment_tx_reply,next_per_commitment_point,pubkey,
157	# Vaidate the counterparty's revocation secret
158	msgtype,hsmd_validate_revocation,36
159	msgdata,hsmd_validate_revocation,revoke_num,u64,
160	msgdata,hsmd_validate_revocation,per_commitment_secret,secret,
161	# No value returned.
162	msgtype,hsmd_validate_revocation_reply,136
163	# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
164	# of keys is derived differently...
165	# FIXME: Have master tell hsmd the keyindex, so it can validate output!
166	msgtype,hsmd_sign_delayed_payment_to_us,12
167	msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
168	msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
169	msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
170	msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len
171	msgtype,hsmd_sign_remote_htlc_to_us,13
172	msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
173	msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
174	msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
175	msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
176	msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,
177	msgtype,hsmd_sign_penalty_to_us,14
178	msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
179	msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
180	msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
181	msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len
182	# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
183	msgtype,hsmd_sign_local_htlc_tx,16
184	msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
185	msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
186	msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
187	msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
188	msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,
189	# Openingd/channeld asks HSM to sign the other sides' commitment tx.
190	#include <common/htlc_wire.h>
191	msgtype,hsmd_sign_remote_commitment_tx,19
192	msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
193	msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
194	msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
195	msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
196	msgdata,hsmd_sign_remote_commitment_tx,commit_num,u64,
197	msgdata,hsmd_sign_remote_commitment_tx,num_htlcs,u16,
198	msgdata,hsmd_sign_remote_commitment_tx,htlcs,simple_htlc,num_htlcs
199	msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,
200	# channeld asks HSM to sign remote HTLC tx.
201	msgtype,hsmd_sign_remote_htlc_tx,20
202	msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
203	msgdata,hsmd_sign_remote_htlc_tx,len,u16,
204	msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
205	msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
206	msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,
207	# closingd asks HSM to sign mutual close tx.
208	msgtype,hsmd_sign_mutual_close_tx,21
209	msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
210	msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,
211	# Reply for all the above requests.
212	msgtype,hsmd_sign_tx_reply,112
213	msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,
214	# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
215	msgtype,hsmd_get_per_commitment_point,18
216	msgdata,hsmd_get_per_commitment_point,n,u64,
217	msgtype,hsmd_get_per_commitment_point_reply,118
218	msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
219	msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,
220	# master -> hsmd: do you have a memleak?
221	msgtype,hsmd_dev_memleak,33
222	msgtype,hsmd_dev_memleak_reply,133
223	msgdata,hsmd_dev_memleak_reply,leak,bool,
224	# channeld asks to check if claimed future commitment_secret is correct.
225	msgtype,hsmd_check_future_secret,22
226	msgdata,hsmd_check_future_secret,n,u64,
227	msgdata,hsmd_check_future_secret,commitment_secret,secret,
228	msgtype,hsmd_check_future_secret_reply,122
229	msgdata,hsmd_check_future_secret_reply,correct,bool,
230	# lightningd asks us to sign a string.
231	msgtype,hsmd_sign_message,23
232	msgdata,hsmd_sign_message,len,u16,
233	msgdata,hsmd_sign_message,msg,u8,len
234	msgtype,hsmd_sign_message_reply,123
235	msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,
236	# lightningd needs to get a scriptPubkey for a utxo with closeinfo
237	msgtype,hsmd_get_output_scriptpubkey,24
238	msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
239	msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
240	msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,
241	msgtype,hsmd_get_output_scriptpubkey_reply,124
242	msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
243	msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len
244	# Sign a bolt12-style merkle hash
245	msgtype,hsmd_sign_bolt12,25
246	msgdata,hsmd_sign_bolt12,messagename,wirestring,
247	msgdata,hsmd_sign_bolt12,fieldname,wirestring,
248	msgdata,hsmd_sign_bolt12,merkleroot,sha256,
249	# This is for invreq payer_id (temporary keys)
250	msgdata,hsmd_sign_bolt12,publictweaklen,u16,
251	msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen
252	msgtype,hsmd_sign_bolt12_reply,125
253	msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,
254	# Sign an option_will_fund offer hash
255	msgtype,hsmd_sign_option_will_fund_offer,26
256	msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
257	msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
258	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
259	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,
260	msgtype,hsmd_sign_option_will_fund_offer_reply,126
261	msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,
262	# Derive pseudorandom secret
263	msgtype,hsmd_derive_secret,27
264	msgdata,hsmd_derive_secret,len,u16,
265	msgdata,hsmd_derive_secret,info,u8,len
266	# Reply with the derived secret
267	msgtype,hsmd_derive_secret_reply,127
268	msgdata,hsmd_derive_secret_reply,secret,secret,
269	# Sanity check this pubkey derivation is correct (unhardened only)
270	msgtype,hsmd_check_pubkey,28
271	msgdata,hsmd_check_pubkey,index,u32,
272	msgdata,hsmd_check_pubkey,pubkey,pubkey,
273	# Reply
274	msgtype,hsmd_check_pubkey_reply,128
275	msgdata,hsmd_check_pubkey_reply,ok,bool,