core-lightning/hsmd/hsmd_wire.csv
Vincenzo Palazzo af41cd5192 hsmd: remove deprecated init v2
Signed-off-by: Vincenzo Palazzo <vincenzopalazzodev@gmail.com>
2024-02-27 14:04:44 +01:00

17 KiB

1# Clients should not give a bad request but not the HSM's decision to crash.
2msgtype,hsmstatus_client_bad_request,1000
3msgdata,hsmstatus_client_bad_request,id,node_id,
4msgdata,hsmstatus_client_bad_request,description,wirestring,
5msgdata,hsmstatus_client_bad_request,len,u16,
6msgdata,hsmstatus_client_bad_request,msg,u8,len
7#include <bitcoin/chainparams.h>
8# Start the HSM.
9msgtype,hsmd_init,11
10msgdata,hsmd_init,bip32_key_version,bip32_key_version,
11msgdata,hsmd_init,chainparams,chainparams,
12msgdata,hsmd_init,hsm_encryption_key,?secret,
13msgdata,hsmd_init,dev_force_privkey,?privkey,
14msgdata,hsmd_init,dev_force_bip32_seed,?secret,
15msgdata,hsmd_init,dev_force_channel_secrets,?secrets,
16msgdata,hsmd_init,dev_force_channel_secrets_shaseed,?sha256,
17msgdata,hsmd_init,hsm_wire_min_version,u32,
18msgdata,hsmd_init,hsm_wire_max_version,u32,
19#include <common/bip32.h>
20# Sorry: I should have put version in v2 :(
21msgtype,hsmd_init_reply_v4,114
22# This gets upgraded when the wire protocol changes in incompatible
23# ways:
24msgdata,hsmd_init_reply_v4,hsm_version,u32,
25# Capabilities, by convention are message numbers, indicating
26# that the HSM supports you sending this message.
27msgdata,hsmd_init_reply_v4,num_hsm_capabilities,u16,
28msgdata,hsmd_init_reply_v4,hsm_capabilities,u32,num_hsm_capabilities
29msgdata,hsmd_init_reply_v4,node_id,node_id,
30msgdata,hsmd_init_reply_v4,bip32,ext_key,
31msgdata,hsmd_init_reply_v4,bolt12,pubkey,
32# Declare a new channel.
33msgtype,hsmd_new_channel,30
34msgdata,hsmd_new_channel,id,node_id,
35msgdata,hsmd_new_channel,dbid,u64,
36# No value returned.
37msgtype,hsmd_new_channel_reply,130
38# Get a new HSM FD, with the specified permissions
39msgtype,hsmd_client_hsmfd,9
40# Which identity to use for requests
41msgdata,hsmd_client_hsmfd,id,node_id,
42# Database id for this client, if any.
43msgdata,hsmd_client_hsmfd,dbid,u64,
44msgdata,hsmd_client_hsmfd,permissions,u64,
45# No content, just an fd.
46msgtype,hsmd_client_hsmfd_reply,109
47#include <common/derive_basepoints.h>
48# Get the basepoints and funding key for this specific channel.
49msgtype,hsmd_get_channel_basepoints,10
50msgdata,hsmd_get_channel_basepoints,peerid,node_id,
51msgdata,hsmd_get_channel_basepoints,dbid,u64,
52msgtype,hsmd_get_channel_basepoints_reply,110
53msgdata,hsmd_get_channel_basepoints_reply,basepoints,basepoints,
54msgdata,hsmd_get_channel_basepoints_reply,funding_pubkey,pubkey,
55#include <common/channel_type.h>
56# Provide channel parameters.
57msgtype,hsmd_setup_channel,31
58msgdata,hsmd_setup_channel,is_outbound,bool,
59msgdata,hsmd_setup_channel,channel_value,amount_sat,
60msgdata,hsmd_setup_channel,push_value,amount_msat,
61msgdata,hsmd_setup_channel,funding_txid,bitcoin_txid,
62msgdata,hsmd_setup_channel,funding_txout,u16,
63msgdata,hsmd_setup_channel,local_to_self_delay,u16,
64msgdata,hsmd_setup_channel,local_shutdown_script_len,u16,
65msgdata,hsmd_setup_channel,local_shutdown_script,u8,local_shutdown_script_len
66msgdata,hsmd_setup_channel,local_shutdown_wallet_index,?u32,
67msgdata,hsmd_setup_channel,remote_basepoints,basepoints,
68msgdata,hsmd_setup_channel,remote_funding_pubkey,pubkey,
69msgdata,hsmd_setup_channel,remote_to_self_delay,u16,
70msgdata,hsmd_setup_channel,remote_shutdown_script_len,u16,
71msgdata,hsmd_setup_channel,remote_shutdown_script,u8,remote_shutdown_script_len
72msgdata,hsmd_setup_channel,channel_type,channel_type,
73# No value returned.,
74msgtype,hsmd_setup_channel_reply,131
75# check if the signer agrees that a funding candidate outpoint is buried
76msgtype,hsmd_check_outpoint,32
77msgdata,hsmd_check_outpoint,funding_txid,bitcoin_txid,
78msgdata,hsmd_check_outpoint,funding_txout,u16,
79msgtype,hsmd_check_outpoint_reply,132
80msgdata,hsmd_check_outpoint_reply,is_buried,bool,
81# change the funding/splice state to locked
82msgtype,hsmd_lock_outpoint,37
83msgdata,hsmd_lock_outpoint,funding_txid,bitcoin_txid,
84msgdata,hsmd_lock_outpoint,funding_txout,u16,
85# No value returned.
86msgtype,hsmd_lock_outpoint_reply,137
87# Forget channel.
88msgtype,hsmd_forget_channel,34
89msgdata,hsmd_forget_channel,id,node_id,
90msgdata,hsmd_forget_channel,dbid,u64,
91# No value returned.
92msgtype,hsmd_forget_channel_reply,134
93# Return signature for a funding tx.
94#include <common/utxo.h>
95# Master asks the HSM to sign a node_announcement
96msgtype,hsmd_node_announcement_sig_req,6
97msgdata,hsmd_node_announcement_sig_req,annlen,u16,
98msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen
99msgtype,hsmd_node_announcement_sig_reply,106
100msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
101# Sign a withdrawal request
102#include <bitcoin/psbt.h>
103msgtype,hsmd_sign_withdrawal,7
104msgdata,hsmd_sign_withdrawal,num_inputs,u16,
105msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
106msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,
107msgtype,hsmd_sign_withdrawal_reply,107
108msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,
109# Sign an invoice
110msgtype,hsmd_sign_invoice,8
111msgdata,hsmd_sign_invoice,len,u16,
112msgdata,hsmd_sign_invoice,u5bytes,u8,len
113msgdata,hsmd_sign_invoice,hrplen,u16,
114msgdata,hsmd_sign_invoice,hrp,u8,hrplen
115msgtype,hsmd_sign_invoice_reply,108
116msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
117# Preapprove an invoice for payment
118msgtype,hsmd_preapprove_invoice,38
119msgdata,hsmd_preapprove_invoice,invstring,wirestring,
120# Result is true if approved, declined if false
121msgtype,hsmd_preapprove_invoice_reply,138
122msgdata,hsmd_preapprove_invoice_reply,approved,bool,
123# Preapprove a keysend payment
124msgtype,hsmd_preapprove_keysend,39
125msgdata,hsmd_preapprove_keysend,destination,node_id,
126msgdata,hsmd_preapprove_keysend,payment_hash,sha256,
127msgdata,hsmd_preapprove_keysend,amount_msat,amount_msat,
128# Result is true if approved, declined if false
129msgtype,hsmd_preapprove_keysend_reply,139
130msgdata,hsmd_preapprove_keysend_reply,approved,bool,
131# Give me ECDH(node-id-secret,point)
132msgtype,hsmd_ecdh_req,1
133msgdata,hsmd_ecdh_req,point,pubkey,
134msgtype,hsmd_ecdh_resp,100
135msgdata,hsmd_ecdh_resp,ss,secret,
136msgtype,hsmd_cannouncement_sig_req,2
137msgdata,hsmd_cannouncement_sig_req,calen,u16,
138msgdata,hsmd_cannouncement_sig_req,ca,u8,calen
139msgtype,hsmd_cannouncement_sig_reply,102
140msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
141msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
142msgtype,hsmd_sign_any_cannouncement_req,4
143msgdata,hsmd_sign_any_cannouncement_req,calen,u16,
144msgdata,hsmd_sign_any_cannouncement_req,ca,u8,calen
145msgdata,hsmd_sign_any_cannouncement_req,peerid,node_id,
146msgdata,hsmd_sign_any_cannouncement_req,channel_dbid,u64,
147msgtype,hsmd_sign_any_cannouncement_reply,104
148msgdata,hsmd_sign_any_cannouncement_reply,node_signature,secp256k1_ecdsa_signature,
149msgdata,hsmd_sign_any_cannouncement_reply,bitcoin_signature,secp256k1_ecdsa_signature,
150msgtype,hsmd_cupdate_sig_req,3
151msgdata,hsmd_cupdate_sig_req,culen,u16,
152msgdata,hsmd_cupdate_sig_req,cu,u8,culen
153msgtype,hsmd_cupdate_sig_reply,103
154msgdata,hsmd_cupdate_sig_reply,culen,u16,
155msgdata,hsmd_cupdate_sig_reply,cu,u8,culen
156# Master asks HSM to sign a commitment transaction.
157msgtype,hsmd_sign_commitment_tx,5
158msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
159msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
160msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
161msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
162msgdata,hsmd_sign_commitment_tx,commit_num,u64,
163msgtype,hsmd_sign_commitment_tx_reply,105
164msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,
165# Validate the counterparty's commitment signatures.
166msgtype,hsmd_validate_commitment_tx,35
167msgdata,hsmd_validate_commitment_tx,tx,bitcoin_tx,
168msgdata,hsmd_validate_commitment_tx,num_htlcs,u16,
169msgdata,hsmd_validate_commitment_tx,htlcs,simple_htlc,num_htlcs
170msgdata,hsmd_validate_commitment_tx,commit_num,u64,
171msgdata,hsmd_validate_commitment_tx,feerate,u32,
172msgdata,hsmd_validate_commitment_tx,sig,bitcoin_signature,
173msgdata,hsmd_validate_commitment_tx,num_htlc_sigs,u16,
174msgdata,hsmd_validate_commitment_tx,htlc_sigs,bitcoin_signature,num_htlc_sigs
175msgtype,hsmd_validate_commitment_tx_reply,135
176msgdata,hsmd_validate_commitment_tx_reply,old_commitment_secret,?secret,
177msgdata,hsmd_validate_commitment_tx_reply,next_per_commitment_point,pubkey,
178# Revoke our local commitment, returns the revocation secret and next point
179msgtype,hsmd_revoke_commitment_tx,40
180msgdata,hsmd_revoke_commitment_tx,commit_num,u64,
181msgtype,hsmd_revoke_commitment_tx_reply,140
182msgdata,hsmd_revoke_commitment_tx_reply,old_commitment_secret,secret,
183msgdata,hsmd_revoke_commitment_tx_reply,next_per_commitment_point,pubkey,
184# Vaidate the counterparty's revocation secret
185msgtype,hsmd_validate_revocation,36
186msgdata,hsmd_validate_revocation,revoke_num,u64,
187msgdata,hsmd_validate_revocation,per_commitment_secret,secret,
188# No value returned.
189msgtype,hsmd_validate_revocation_reply,136
190# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
191# of keys is derived differently...
192msgtype,hsmd_sign_delayed_payment_to_us,12
193msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
194msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
195msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
196msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len
197msgtype,hsmd_sign_remote_htlc_to_us,13
198msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
199msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
200msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
201msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
202msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,
203msgtype,hsmd_sign_penalty_to_us,14
204msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
205msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
206msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
207msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len
208# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
209msgtype,hsmd_sign_local_htlc_tx,16
210msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
211msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
212msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
213msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
214msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,
215# Openingd/channeld asks HSM to sign the other sides' commitment tx.
216#include <common/htlc_wire.h>
217msgtype,hsmd_sign_remote_commitment_tx,19
218msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
219msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
220msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
221msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
222msgdata,hsmd_sign_remote_commitment_tx,commit_num,u64,
223msgdata,hsmd_sign_remote_commitment_tx,num_htlcs,u16,
224msgdata,hsmd_sign_remote_commitment_tx,htlcs,simple_htlc,num_htlcs
225msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,
226# channeld asks HSM to sign remote HTLC tx.
227msgtype,hsmd_sign_remote_htlc_tx,20
228msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
229msgdata,hsmd_sign_remote_htlc_tx,len,u16,
230msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
231msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
232msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,
233# closingd asks HSM to sign mutual close tx.
234msgtype,hsmd_sign_mutual_close_tx,21
235msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
236msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,
237# channeld asks HSM to sign splice tx.
238msgtype,hsmd_sign_splice_tx,29
239msgdata,hsmd_sign_splice_tx,tx,bitcoin_tx,
240msgdata,hsmd_sign_splice_tx,remote_funding_key,pubkey,
241msgdata,hsmd_sign_splice_tx,input_index,u32,
242# Reply for all the above requests.
243msgtype,hsmd_sign_tx_reply,112
244msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,
245# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
246msgtype,hsmd_get_per_commitment_point,18
247msgdata,hsmd_get_per_commitment_point,n,u64,
248msgtype,hsmd_get_per_commitment_point_reply,118
249msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
250msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,
251# master -> hsmd: do you have a memleak?
252msgtype,hsmd_dev_memleak,33
253msgtype,hsmd_dev_memleak_reply,133
254msgdata,hsmd_dev_memleak_reply,leak,bool,
255# channeld asks to check if claimed future commitment_secret is correct.
256msgtype,hsmd_check_future_secret,22
257msgdata,hsmd_check_future_secret,n,u64,
258msgdata,hsmd_check_future_secret,commitment_secret,secret,
259msgtype,hsmd_check_future_secret_reply,122
260msgdata,hsmd_check_future_secret_reply,correct,bool,
261# lightningd asks us to sign a string.
262msgtype,hsmd_sign_message,23
263msgdata,hsmd_sign_message,len,u16,
264msgdata,hsmd_sign_message,msg,u8,len
265msgtype,hsmd_sign_message_reply,123
266msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,
267# lightningd needs to get a scriptPubkey for a utxo with closeinfo
268msgtype,hsmd_get_output_scriptpubkey,24
269msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
270msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
271msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,
272msgtype,hsmd_get_output_scriptpubkey_reply,124
273msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
274msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len
275# Sign a bolt12-style merkle hash
276msgtype,hsmd_sign_bolt12,25
277msgdata,hsmd_sign_bolt12,messagename,wirestring,
278msgdata,hsmd_sign_bolt12,fieldname,wirestring,
279msgdata,hsmd_sign_bolt12,merkleroot,sha256,
280# This is for invreq payer_id (temporary keys)
281msgdata,hsmd_sign_bolt12,publictweaklen,u16,
282msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen
283msgtype,hsmd_sign_bolt12_reply,125
284msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,
285# Sign an option_will_fund offer hash
286msgtype,hsmd_sign_option_will_fund_offer,26
287msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
288msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
289msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
290msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,
291msgtype,hsmd_sign_option_will_fund_offer_reply,126
292msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,
293# Derive pseudorandom secret
294msgtype,hsmd_derive_secret,27
295msgdata,hsmd_derive_secret,len,u16,
296msgdata,hsmd_derive_secret,info,u8,len
297# Reply with the derived secret
298msgtype,hsmd_derive_secret_reply,127
299msgdata,hsmd_derive_secret_reply,secret,secret,
300# Sanity check this pubkey derivation is correct (unhardened only)
301msgtype,hsmd_check_pubkey,28
302msgdata,hsmd_check_pubkey,index,u32,
303msgdata,hsmd_check_pubkey,pubkey,pubkey,
304# Reply
305msgtype,hsmd_check_pubkey_reply,128
306msgdata,hsmd_check_pubkey_reply,ok,bool,
307msgtype,hsmd_sign_anchorspend,147
308msgdata,hsmd_sign_anchorspend,peerid,node_id,
309msgdata,hsmd_sign_anchorspend,channel_dbid,u64,
310msgdata,hsmd_sign_anchorspend,num_inputs,u16,
311msgdata,hsmd_sign_anchorspend,inputs,utxo,num_inputs
312msgdata,hsmd_sign_anchorspend,psbt,wally_psbt,
313msgtype,hsmd_sign_anchorspend_reply,148
314msgdata,hsmd_sign_anchorspend_reply,psbt,wally_psbt,
315# These are where lightningd asks for signatures on onchaind's behalf.
316msgtype,hsmd_sign_any_delayed_payment_to_us,142
317msgdata,hsmd_sign_any_delayed_payment_to_us,commit_num,u64,
318msgdata,hsmd_sign_any_delayed_payment_to_us,tx,bitcoin_tx,
319msgdata,hsmd_sign_any_delayed_payment_to_us,wscript_len,u16,
320msgdata,hsmd_sign_any_delayed_payment_to_us,wscript,u8,wscript_len
321msgdata,hsmd_sign_any_delayed_payment_to_us,input,u32,
322msgdata,hsmd_sign_any_delayed_payment_to_us,peerid,node_id,
323msgdata,hsmd_sign_any_delayed_payment_to_us,channel_dbid,u64,
324msgtype,hsmd_sign_any_remote_htlc_to_us,143
325msgdata,hsmd_sign_any_remote_htlc_to_us,remote_per_commitment_point,pubkey,
326msgdata,hsmd_sign_any_remote_htlc_to_us,tx,bitcoin_tx,
327msgdata,hsmd_sign_any_remote_htlc_to_us,wscript_len,u16,
328msgdata,hsmd_sign_any_remote_htlc_to_us,wscript,u8,wscript_len
329msgdata,hsmd_sign_any_remote_htlc_to_us,option_anchor_outputs,bool,
330msgdata,hsmd_sign_any_remote_htlc_to_us,input,u32,
331msgdata,hsmd_sign_any_remote_htlc_to_us,peerid,node_id,
332msgdata,hsmd_sign_any_remote_htlc_to_us,channel_dbid,u64,
333msgtype,hsmd_sign_any_penalty_to_us,144
334msgdata,hsmd_sign_any_penalty_to_us,revocation_secret,secret,
335msgdata,hsmd_sign_any_penalty_to_us,tx,bitcoin_tx,
336msgdata,hsmd_sign_any_penalty_to_us,wscript_len,u16,
337msgdata,hsmd_sign_any_penalty_to_us,wscript,u8,wscript_len
338msgdata,hsmd_sign_any_penalty_to_us,input,u32,
339msgdata,hsmd_sign_any_penalty_to_us,peerid,node_id,
340msgdata,hsmd_sign_any_penalty_to_us,channel_dbid,u64,
341msgtype,hsmd_sign_any_local_htlc_tx,146
342msgdata,hsmd_sign_any_local_htlc_tx,commit_num,u64,
343msgdata,hsmd_sign_any_local_htlc_tx,tx,bitcoin_tx,
344msgdata,hsmd_sign_any_local_htlc_tx,wscript_len,u16,
345msgdata,hsmd_sign_any_local_htlc_tx,wscript,u8,wscript_len
346msgdata,hsmd_sign_any_local_htlc_tx,option_anchor_outputs,bool,
347msgdata,hsmd_sign_any_local_htlc_tx,input,u32,
348msgdata,hsmd_sign_any_local_htlc_tx,peerid,node_id,
349msgdata,hsmd_sign_any_local_htlc_tx,channel_dbid,u64,
350msgtype,hsmd_sign_htlc_tx_mingle,149
351msgdata,hsmd_sign_htlc_tx_mingle,peerid,node_id,
352msgdata,hsmd_sign_htlc_tx_mingle,channel_dbid,u64,
353msgdata,hsmd_sign_htlc_tx_mingle,num_inputs,u16,
354msgdata,hsmd_sign_htlc_tx_mingle,inputs,utxo,num_inputs
355msgdata,hsmd_sign_htlc_tx_mingle,psbt,wally_psbt,
356msgtype,hsmd_sign_htlc_tx_mingle_reply,150
357msgdata,hsmd_sign_htlc_tx_mingle_reply,psbt,wally_psbt,