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