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