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