rgb-cln/hsmd/hsm_wire.csv

7.1 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,hsm_init,11
10msgdata,hsm_init,bip32_key_version,bip32_key_version,
11msgdata,hsm_init,chainparams,chainparams,
12msgdata,hsm_init,hsm_encryption_key,?secret,
13msgdata,hsm_init,dev_force_privkey,?privkey,
14msgdata,hsm_init,dev_force_bip32_seed,?secret,
15msgdata,hsm_init,dev_force_channel_secrets,?secrets,
16msgdata,hsm_init,dev_force_channel_secrets_shaseed,?sha256,
17#include <common/bip32.h>
18msgtype,hsm_init_reply,111
19msgdata,hsm_init_reply,node_id,node_id,
20msgdata,hsm_init_reply,bip32,ext_key,
21# Get a new HSM FD, with the specified capabilities
22msgtype,hsm_client_hsmfd,9
23# Which identity to use for requests
24msgdata,hsm_client_hsmfd,id,node_id,
25# Database id for this client, if any.
26msgdata,hsm_client_hsmfd,dbid,u64,
27msgdata,hsm_client_hsmfd,capabilities,u64,
28# No content, just an fd.
29msgtype,hsm_client_hsmfd_reply,109
30#include <common/derive_basepoints.h>
31# Get the basepoints and funding key for this specific channel.
32msgtype,hsm_get_channel_basepoints,10
33msgdata,hsm_get_channel_basepoints,peerid,node_id,
34msgdata,hsm_get_channel_basepoints,dbid,u64,
35msgtype,hsm_get_channel_basepoints_reply,110
36msgdata,hsm_get_channel_basepoints_reply,basepoints,basepoints,
37msgdata,hsm_get_channel_basepoints_reply,funding_pubkey,pubkey,
38# Return signature for a funding tx.
39#include <common/utxo.h>
40# Master asks the HSM to sign a node_announcement
41msgtype,hsm_node_announcement_sig_req,6
42msgdata,hsm_node_announcement_sig_req,annlen,u16,
43msgdata,hsm_node_announcement_sig_req,announcement,u8,annlen
44msgtype,hsm_node_announcement_sig_reply,106
45msgdata,hsm_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,
46# Sign a withdrawal request
47msgtype,hsm_sign_withdrawal,7
48msgdata,hsm_sign_withdrawal,satoshi_out,amount_sat,
49msgdata,hsm_sign_withdrawal,change_out,amount_sat,
50msgdata,hsm_sign_withdrawal,change_keyindex,u32,
51msgdata,hsm_sign_withdrawal,num_outputs,u16,
52msgdata,hsm_sign_withdrawal,outputs,bitcoin_tx_output,num_outputs
53msgdata,hsm_sign_withdrawal,num_inputs,u16,
54msgdata,hsm_sign_withdrawal,inputs,utxo,num_inputs
55msgdata,hsm_sign_withdrawal,nlocktime,u32,
56msgtype,hsm_sign_withdrawal_reply,107
57msgdata,hsm_sign_withdrawal_reply,tx,bitcoin_tx,
58# Sign an invoice
59msgtype,hsm_sign_invoice,8
60msgdata,hsm_sign_invoice,len,u16,
61msgdata,hsm_sign_invoice,u5bytes,u8,len
62msgdata,hsm_sign_invoice,hrplen,u16,
63msgdata,hsm_sign_invoice,hrp,u8,hrplen
64msgtype,hsm_sign_invoice_reply,108
65msgdata,hsm_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,
66# Give me ECDH(node-id-secret,point)
67msgtype,hsm_ecdh_req,1
68msgdata,hsm_ecdh_req,point,pubkey,
69msgtype,hsm_ecdh_resp,100
70msgdata,hsm_ecdh_resp,ss,secret,
71msgtype,hsm_cannouncement_sig_req,2
72msgdata,hsm_cannouncement_sig_req,calen,u16,
73msgdata,hsm_cannouncement_sig_req,ca,u8,calen
74msgtype,hsm_cannouncement_sig_reply,102
75msgdata,hsm_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
76msgdata,hsm_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,
77msgtype,hsm_cupdate_sig_req,3
78msgdata,hsm_cupdate_sig_req,culen,u16,
79msgdata,hsm_cupdate_sig_req,cu,u8,culen
80msgtype,hsm_cupdate_sig_reply,103
81msgdata,hsm_cupdate_sig_reply,culen,u16,
82msgdata,hsm_cupdate_sig_reply,cu,u8,culen
83# Master asks HSM to sign a commitment transaction.
84msgtype,hsm_sign_commitment_tx,5
85msgdata,hsm_sign_commitment_tx,peer_id,node_id,
86msgdata,hsm_sign_commitment_tx,channel_dbid,u64,
87msgdata,hsm_sign_commitment_tx,tx,bitcoin_tx,
88msgdata,hsm_sign_commitment_tx,remote_funding_key,pubkey,
89msgtype,hsm_sign_commitment_tx_reply,105
90msgdata,hsm_sign_commitment_tx_reply,sig,bitcoin_signature,
91# Onchaind asks HSM to sign a spend to-us. Four variants, since each set
92# of keys is derived differently...
93# FIXME: Have master tell hsmd the keyindex, so it can validate output!
94msgtype,hsm_sign_delayed_payment_to_us,12
95msgdata,hsm_sign_delayed_payment_to_us,commit_num,u64,
96msgdata,hsm_sign_delayed_payment_to_us,tx,bitcoin_tx,
97msgdata,hsm_sign_delayed_payment_to_us,wscript_len,u16,
98msgdata,hsm_sign_delayed_payment_to_us,wscript,u8,wscript_len
99msgtype,hsm_sign_remote_htlc_to_us,13
100msgdata,hsm_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
101msgdata,hsm_sign_remote_htlc_to_us,tx,bitcoin_tx,
102msgdata,hsm_sign_remote_htlc_to_us,wscript_len,u16,
103msgdata,hsm_sign_remote_htlc_to_us,wscript,u8,wscript_len
104msgtype,hsm_sign_penalty_to_us,14
105msgdata,hsm_sign_penalty_to_us,revocation_secret,secret,
106msgdata,hsm_sign_penalty_to_us,tx,bitcoin_tx,
107msgdata,hsm_sign_penalty_to_us,wscript_len,u16,
108msgdata,hsm_sign_penalty_to_us,wscript,u8,wscript_len
109# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
110msgtype,hsm_sign_local_htlc_tx,16
111msgdata,hsm_sign_local_htlc_tx,commit_num,u64,
112msgdata,hsm_sign_local_htlc_tx,tx,bitcoin_tx,
113msgdata,hsm_sign_local_htlc_tx,wscript_len,u16,
114msgdata,hsm_sign_local_htlc_tx,wscript,u8,wscript_len
115# Openingd/channeld asks HSM to sign the other sides' commitment tx.
116msgtype,hsm_sign_remote_commitment_tx,19
117msgdata,hsm_sign_remote_commitment_tx,tx,bitcoin_tx,
118msgdata,hsm_sign_remote_commitment_tx,remote_funding_key,pubkey,
119msgdata,hsm_sign_remote_commitment_tx,remote_per_commit,pubkey,
120msgdata,hsm_sign_remote_commitment_tx,option_static_remotekey,bool,
121# channeld asks HSM to sign remote HTLC tx.
122msgtype,hsm_sign_remote_htlc_tx,20
123msgdata,hsm_sign_remote_htlc_tx,tx,bitcoin_tx,
124msgdata,hsm_sign_remote_htlc_tx,len,u16,
125msgdata,hsm_sign_remote_htlc_tx,wscript,u8,len
126msgdata,hsm_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
127# closingd asks HSM to sign mutual close tx.
128msgtype,hsm_sign_mutual_close_tx,21
129msgdata,hsm_sign_mutual_close_tx,tx,bitcoin_tx,
130msgdata,hsm_sign_mutual_close_tx,remote_funding_key,pubkey,
131# Reply for all the above requests.
132msgtype,hsm_sign_tx_reply,112
133msgdata,hsm_sign_tx_reply,sig,bitcoin_signature,
134# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
135msgtype,hsm_get_per_commitment_point,18
136msgdata,hsm_get_per_commitment_point,n,u64,
137msgtype,hsm_get_per_commitment_point_reply,118
138msgdata,hsm_get_per_commitment_point_reply,per_commitment_point,pubkey,
139msgdata,hsm_get_per_commitment_point_reply,old_commitment_secret,?secret,
140# master -> hsmd: do you have a memleak?
141msgtype,hsm_dev_memleak,33
142msgtype,hsm_dev_memleak_reply,133
143msgdata,hsm_dev_memleak_reply,leak,bool,
144# channeld asks to check if claimed future commitment_secret is correct.
145msgtype,hsm_check_future_secret,22
146msgdata,hsm_check_future_secret,n,u64,
147msgdata,hsm_check_future_secret,commitment_secret,secret,
148msgtype,hsm_check_future_secret_reply,122
149msgdata,hsm_check_future_secret_reply,correct,bool,
150# lightningd asks us to sign a string.
151msgtype,hsm_sign_message,23
152msgdata,hsm_sign_message,len,u16,
153msgdata,hsm_sign_message,msg,u8,len
154msgtype,hsm_sign_message_reply,123
155msgdata,hsm_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,