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