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