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