rgb-cln/hsmd/hsm_wire.csv

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