core-lightning/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	# Return signature for a funding tx.
47	#include <common/utxo.h>
48	# Master asks the HSM to sign a node_announcement
49	msgtype,hsmd_node_announcement_sig_req,6
50	msgdata,hsmd_node_announcement_sig_req,annlen,u16,
51	msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen
52	msgtype,hsmd_node_announcement_sig_reply,106
53	msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
54	# Sign a withdrawal request
55	#include <bitcoin/psbt.h>
56	msgtype,hsmd_sign_withdrawal,7
57	msgdata,hsmd_sign_withdrawal,num_inputs,u16,
58	msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
59	msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,
60	msgtype,hsmd_sign_withdrawal_reply,107
61	msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,
62	# Sign an invoice
63	msgtype,hsmd_sign_invoice,8
64	msgdata,hsmd_sign_invoice,len,u16,
65	msgdata,hsmd_sign_invoice,u5bytes,u8,len
66	msgdata,hsmd_sign_invoice,hrplen,u16,
67	msgdata,hsmd_sign_invoice,hrp,u8,hrplen
68	msgtype,hsmd_sign_invoice_reply,108
69	msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
70	# Give me ECDH(node-id-secret,point)
71	msgtype,hsmd_ecdh_req,1
72	msgdata,hsmd_ecdh_req,point,pubkey,
73	msgtype,hsmd_ecdh_resp,100
74	msgdata,hsmd_ecdh_resp,ss,secret,
75	msgtype,hsmd_cannouncement_sig_req,2
76	msgdata,hsmd_cannouncement_sig_req,calen,u16,
77	msgdata,hsmd_cannouncement_sig_req,ca,u8,calen
78	msgtype,hsmd_cannouncement_sig_reply,102
79	msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
80	msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
81	msgtype,hsmd_cupdate_sig_req,3
82	msgdata,hsmd_cupdate_sig_req,culen,u16,
83	msgdata,hsmd_cupdate_sig_req,cu,u8,culen
84	msgtype,hsmd_cupdate_sig_reply,103
85	msgdata,hsmd_cupdate_sig_reply,culen,u16,
86	msgdata,hsmd_cupdate_sig_reply,cu,u8,culen
87	# Master asks HSM to sign a commitment transaction.
88	msgtype,hsmd_sign_commitment_tx,5
89	msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
90	msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
91	msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
92	msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
93	msgtype,hsmd_sign_commitment_tx_reply,105
94	msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
95	# Vaidate the counterparty's revocation secret
96	msgtype,hsmd_validate_revocation,36
97	msgdata,hsmd_validate_revocation,revoke_num,u64,
98	msgdata,hsmd_validate_revocation,per_commitment_secret,secret,
99	# No value returned.
100	msgtype,hsmd_validate_revocation_reply,136
101	# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
102	# of keys is derived differently...
103	# FIXME: Have master tell hsmd the keyindex, so it can validate output!
104	msgtype,hsmd_sign_delayed_payment_to_us,12
105	msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
106	msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
107	msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
108	msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len
109	msgtype,hsmd_sign_remote_htlc_to_us,13
110	msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
111	msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
112	msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
113	msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
114	msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,
115	msgtype,hsmd_sign_penalty_to_us,14
116	msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
117	msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
118	msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
119	msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len
120	# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
121	msgtype,hsmd_sign_local_htlc_tx,16
122	msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
123	msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
124	msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
125	msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
126	msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,
127	# Openingd/channeld asks HSM to sign the other sides' commitment tx.
128	msgtype,hsmd_sign_remote_commitment_tx,19
129	msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
130	msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
131	msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
132	msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
133	# channeld asks HSM to sign remote HTLC tx.
134	msgtype,hsmd_sign_remote_htlc_tx,20
135	msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
136	msgdata,hsmd_sign_remote_htlc_tx,len,u16,
137	msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
138	msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
139	msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,
140	# closingd asks HSM to sign mutual close tx.
141	msgtype,hsmd_sign_mutual_close_tx,21
142	msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
143	msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,
144	# Reply for all the above requests.
145	msgtype,hsmd_sign_tx_reply,112
146	msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,
147	# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
148	msgtype,hsmd_get_per_commitment_point,18
149	msgdata,hsmd_get_per_commitment_point,n,u64,
150	msgtype,hsmd_get_per_commitment_point_reply,118
151	msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
152	msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,
153	# master -> hsmd: do you have a memleak?
154	msgtype,hsmd_dev_memleak,33
155	msgtype,hsmd_dev_memleak_reply,133
156	msgdata,hsmd_dev_memleak_reply,leak,bool,
157	# channeld asks to check if claimed future commitment_secret is correct.
158	msgtype,hsmd_check_future_secret,22
159	msgdata,hsmd_check_future_secret,n,u64,
160	msgdata,hsmd_check_future_secret,commitment_secret,secret,
161	msgtype,hsmd_check_future_secret_reply,122
162	msgdata,hsmd_check_future_secret_reply,correct,bool,
163	# lightningd asks us to sign a string.
164	msgtype,hsmd_sign_message,23
165	msgdata,hsmd_sign_message,len,u16,
166	msgdata,hsmd_sign_message,msg,u8,len
167	msgtype,hsmd_sign_message_reply,123
168	msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,
169	# lightningd needs to get a scriptPubkey for a utxo with closeinfo
170	msgtype,hsmd_get_output_scriptpubkey,24
171	msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
172	msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
173	msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,
174	msgtype,hsmd_get_output_scriptpubkey_reply,124
175	msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
176	msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len
177	# Sign a bolt12-style merkle hash
178	msgtype,hsmd_sign_bolt12,25
179	msgdata,hsmd_sign_bolt12,messagename,wirestring,
180	msgdata,hsmd_sign_bolt12,fieldname,wirestring,
181	msgdata,hsmd_sign_bolt12,merkleroot,sha256,
182	# This is for invreq payer_id (temporary keys)
183	msgdata,hsmd_sign_bolt12,publictweaklen,u16,
184	msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen
185	msgtype,hsmd_sign_bolt12_reply,125
186	msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,
187	# Sign an option_will_fund offer hash
188	msgtype,hsmd_sign_option_will_fund_offer,26
189	msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
190	msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
191	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
192	msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,
193	msgtype,hsmd_sign_option_will_fund_offer_reply,126
194	msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,