hsmd_wire.csv

# Clients should not give a bad request but not the HSM's decision to crash.
msgtype,hsmstatus_client_bad_request,1000
msgdata,hsmstatus_client_bad_request,id,node_id,
msgdata,hsmstatus_client_bad_request,description,wirestring,
msgdata,hsmstatus_client_bad_request,len,u16,
msgdata,hsmstatus_client_bad_request,msg,u8,len

#include <bitcoin/chainparams.h>
# Start the HSM.
msgtype,hsmd_init,11
msgdata,hsmd_init,bip32_key_version,bip32_key_version,
msgdata,hsmd_init,chainparams,chainparams,
msgdata,hsmd_init,hsm_encryption_key,?secret,
msgdata,hsmd_init,dev_force_privkey,?privkey,
msgdata,hsmd_init,dev_force_bip32_seed,?secret,
msgdata,hsmd_init,dev_force_channel_secrets,?secrets,
msgdata,hsmd_init,dev_force_channel_secrets_shaseed,?sha256,
msgdata,hsmd_init,hsm_wire_min_version,u32,
msgdata,hsmd_init,hsm_wire_max_version,u32,

#include <common/bip32.h>
# DEPRECATED after 23.05, remove in two versions!
msgtype,hsmd_init_reply_v2,113
msgdata,hsmd_init_reply_v2,node_id,node_id,
msgdata,hsmd_init_reply_v2,bip32,ext_key,
msgdata,hsmd_init_reply_v2,bolt12,pubkey,

# Sorry: I should have put version in v2 :(
msgtype,hsmd_init_reply_v4,114
# This gets upgraded when the wire protocol changes in incompatible
# ways:
msgdata,hsmd_init_reply_v4,hsm_version,u32,
# Capabilities, by convention are message numbers, indicating
# that the HSM supports you sending this message.
msgdata,hsmd_init_reply_v4,num_hsm_capabilities,u16,
msgdata,hsmd_init_reply_v4,hsm_capabilities,u32,num_hsm_capabilities
msgdata,hsmd_init_reply_v4,node_id,node_id,
msgdata,hsmd_init_reply_v4,bip32,ext_key,
msgdata,hsmd_init_reply_v4,bolt12,pubkey,

# Declare a new channel.
msgtype,hsmd_new_channel,30
msgdata,hsmd_new_channel,id,node_id,
msgdata,hsmd_new_channel,dbid,u64,

# No value returned.
msgtype,hsmd_new_channel_reply,130

# Get a new HSM FD, with the specified capabilities
msgtype,hsmd_client_hsmfd,9
# Which identity to use for requests
msgdata,hsmd_client_hsmfd,id,node_id,
# Database id for this client, if any.
msgdata,hsmd_client_hsmfd,dbid,u64,
msgdata,hsmd_client_hsmfd,capabilities,u64,

# No content, just an fd.
msgtype,hsmd_client_hsmfd_reply,109

#include <common/derive_basepoints.h>
# Get the basepoints and funding key for this specific channel.
msgtype,hsmd_get_channel_basepoints,10
msgdata,hsmd_get_channel_basepoints,peerid,node_id,
msgdata,hsmd_get_channel_basepoints,dbid,u64,

msgtype,hsmd_get_channel_basepoints_reply,110
msgdata,hsmd_get_channel_basepoints_reply,basepoints,basepoints,
msgdata,hsmd_get_channel_basepoints_reply,funding_pubkey,pubkey,

#include <common/channel_type.h>
# Provide channel parameters.
msgtype,hsmd_ready_channel,31
msgdata,hsmd_ready_channel,is_outbound,bool,
msgdata,hsmd_ready_channel,channel_value,amount_sat,
msgdata,hsmd_ready_channel,push_value,amount_msat,
msgdata,hsmd_ready_channel,funding_txid,bitcoin_txid,
msgdata,hsmd_ready_channel,funding_txout,u16,
msgdata,hsmd_ready_channel,local_to_self_delay,u16,
msgdata,hsmd_ready_channel,local_shutdown_script_len,u16,
msgdata,hsmd_ready_channel,local_shutdown_script,u8,local_shutdown_script_len
msgdata,hsmd_ready_channel,local_shutdown_wallet_index,?u32,
msgdata,hsmd_ready_channel,remote_basepoints,basepoints,
msgdata,hsmd_ready_channel,remote_funding_pubkey,pubkey,
msgdata,hsmd_ready_channel,remote_to_self_delay,u16,
msgdata,hsmd_ready_channel,remote_shutdown_script_len,u16,
msgdata,hsmd_ready_channel,remote_shutdown_script,u8,remote_shutdown_script_len
msgdata,hsmd_ready_channel,channel_type,channel_type,

# No value returned.
msgtype,hsmd_ready_channel_reply,131

# Return signature for a funding tx.
#include <common/utxo.h>

# Master asks the HSM to sign a node_announcement
msgtype,hsmd_node_announcement_sig_req,6
msgdata,hsmd_node_announcement_sig_req,annlen,u16,
msgdata,hsmd_node_announcement_sig_req,announcement,u8,annlen

msgtype,hsmd_node_announcement_sig_reply,106
msgdata,hsmd_node_announcement_sig_reply,signature,secp256k1_ecdsa_signature,

# Sign a withdrawal request
#include <bitcoin/psbt.h>
msgtype,hsmd_sign_withdrawal,7
msgdata,hsmd_sign_withdrawal,num_inputs,u16,
msgdata,hsmd_sign_withdrawal,inputs,utxo,num_inputs
msgdata,hsmd_sign_withdrawal,psbt,wally_psbt,

msgtype,hsmd_sign_withdrawal_reply,107
msgdata,hsmd_sign_withdrawal_reply,psbt,wally_psbt,

# Sign an invoice
msgtype,hsmd_sign_invoice,8
msgdata,hsmd_sign_invoice,len,u16,
msgdata,hsmd_sign_invoice,u5bytes,u8,len
msgdata,hsmd_sign_invoice,hrplen,u16,
msgdata,hsmd_sign_invoice,hrp,u8,hrplen

msgtype,hsmd_sign_invoice_reply,108
msgdata,hsmd_sign_invoice_reply,sig,secp256k1_ecdsa_recoverable_signature,

# Preapprove an invoice for payment
msgtype,hsmd_preapprove_invoice,38
msgdata,hsmd_preapprove_invoice,invstring,wirestring,

# Result is true if approved, declined if false 
msgtype,hsmd_preapprove_invoice_reply,138
msgdata,hsmd_preapprove_invoice_reply,approved,bool,

# Preapprove a keysend payment
msgtype,hsmd_preapprove_keysend,39
msgdata,hsmd_preapprove_keysend,destination,node_id,
msgdata,hsmd_preapprove_keysend,payment_hash,sha256,
msgdata,hsmd_preapprove_keysend,amount_msat,amount_msat,

# Result is true if approved, declined if false 
msgtype,hsmd_preapprove_keysend_reply,139
msgdata,hsmd_preapprove_keysend_reply,approved,bool,

# Give me ECDH(node-id-secret,point)
msgtype,hsmd_ecdh_req,1
msgdata,hsmd_ecdh_req,point,pubkey,
msgtype,hsmd_ecdh_resp,100
msgdata,hsmd_ecdh_resp,ss,secret,

msgtype,hsmd_cannouncement_sig_req,2
msgdata,hsmd_cannouncement_sig_req,calen,u16,
msgdata,hsmd_cannouncement_sig_req,ca,u8,calen

msgtype,hsmd_cannouncement_sig_reply,102
msgdata,hsmd_cannouncement_sig_reply,node_signature,secp256k1_ecdsa_signature,
msgdata,hsmd_cannouncement_sig_reply,bitcoin_signature,secp256k1_ecdsa_signature,

msgtype,hsmd_cupdate_sig_req,3
msgdata,hsmd_cupdate_sig_req,culen,u16,
msgdata,hsmd_cupdate_sig_req,cu,u8,culen

msgtype,hsmd_cupdate_sig_reply,103
msgdata,hsmd_cupdate_sig_reply,culen,u16,
msgdata,hsmd_cupdate_sig_reply,cu,u8,culen

# Master asks HSM to sign a commitment transaction.
msgtype,hsmd_sign_commitment_tx,5
msgdata,hsmd_sign_commitment_tx,peer_id,node_id,
msgdata,hsmd_sign_commitment_tx,channel_dbid,u64,
msgdata,hsmd_sign_commitment_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_commitment_tx,remote_funding_key,pubkey,
msgdata,hsmd_sign_commitment_tx,commit_num,u64,

msgtype,hsmd_sign_commitment_tx_reply,105
msgdata,hsmd_sign_commitment_tx_reply,sig,bitcoin_signature,

# Validate the counterparty's commitment signatures.
msgtype,hsmd_validate_commitment_tx,35
msgdata,hsmd_validate_commitment_tx,tx,bitcoin_tx,
msgdata,hsmd_validate_commitment_tx,num_htlcs,u16,
msgdata,hsmd_validate_commitment_tx,htlcs,simple_htlc,num_htlcs
msgdata,hsmd_validate_commitment_tx,commit_num,u64,
msgdata,hsmd_validate_commitment_tx,feerate,u32,
msgdata,hsmd_validate_commitment_tx,sig,bitcoin_signature,
msgdata,hsmd_validate_commitment_tx,num_htlc_sigs,u16,
msgdata,hsmd_validate_commitment_tx,htlc_sigs,bitcoin_signature,num_htlc_sigs

msgtype,hsmd_validate_commitment_tx_reply,135
msgdata,hsmd_validate_commitment_tx_reply,old_commitment_secret,?secret,
msgdata,hsmd_validate_commitment_tx_reply,next_per_commitment_point,pubkey,

# Vaidate the counterparty's revocation secret
msgtype,hsmd_validate_revocation,36
msgdata,hsmd_validate_revocation,revoke_num,u64,
msgdata,hsmd_validate_revocation,per_commitment_secret,secret,

# No value returned.
msgtype,hsmd_validate_revocation_reply,136

# Onchaind asks HSM to sign a spend to-us.  Four variants, since each set
# of keys is derived differently...
msgtype,hsmd_sign_delayed_payment_to_us,12
msgdata,hsmd_sign_delayed_payment_to_us,commit_num,u64,
msgdata,hsmd_sign_delayed_payment_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_delayed_payment_to_us,wscript_len,u16,
msgdata,hsmd_sign_delayed_payment_to_us,wscript,u8,wscript_len

msgtype,hsmd_sign_remote_htlc_to_us,13
msgdata,hsmd_sign_remote_htlc_to_us,remote_per_commitment_point,pubkey,
msgdata,hsmd_sign_remote_htlc_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_remote_htlc_to_us,wscript_len,u16,
msgdata,hsmd_sign_remote_htlc_to_us,wscript,u8,wscript_len
msgdata,hsmd_sign_remote_htlc_to_us,option_anchor_outputs,bool,

msgtype,hsmd_sign_penalty_to_us,14
msgdata,hsmd_sign_penalty_to_us,revocation_secret,secret,
msgdata,hsmd_sign_penalty_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_penalty_to_us,wscript_len,u16,
msgdata,hsmd_sign_penalty_to_us,wscript,u8,wscript_len

# Onchaind asks HSM to sign a local HTLC success or HTLC timeout tx.
msgtype,hsmd_sign_local_htlc_tx,16
msgdata,hsmd_sign_local_htlc_tx,commit_num,u64,
msgdata,hsmd_sign_local_htlc_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_local_htlc_tx,wscript_len,u16,
msgdata,hsmd_sign_local_htlc_tx,wscript,u8,wscript_len
msgdata,hsmd_sign_local_htlc_tx,option_anchor_outputs,bool,

# Openingd/channeld asks HSM to sign the other sides' commitment tx.
#include <common/htlc_wire.h>
msgtype,hsmd_sign_remote_commitment_tx,19
msgdata,hsmd_sign_remote_commitment_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_remote_commitment_tx,remote_funding_key,pubkey,
msgdata,hsmd_sign_remote_commitment_tx,remote_per_commit,pubkey,
msgdata,hsmd_sign_remote_commitment_tx,option_static_remotekey,bool,
msgdata,hsmd_sign_remote_commitment_tx,commit_num,u64,
msgdata,hsmd_sign_remote_commitment_tx,num_htlcs,u16,
msgdata,hsmd_sign_remote_commitment_tx,htlcs,simple_htlc,num_htlcs
msgdata,hsmd_sign_remote_commitment_tx,feerate,u32,

# channeld asks HSM to sign remote HTLC tx.
msgtype,hsmd_sign_remote_htlc_tx,20
msgdata,hsmd_sign_remote_htlc_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_remote_htlc_tx,len,u16,
msgdata,hsmd_sign_remote_htlc_tx,wscript,u8,len
msgdata,hsmd_sign_remote_htlc_tx,remote_per_commit_point,pubkey,
msgdata,hsmd_sign_remote_htlc_tx,option_anchor_outputs,bool,

# closingd asks HSM to sign mutual close tx.
msgtype,hsmd_sign_mutual_close_tx,21
msgdata,hsmd_sign_mutual_close_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_mutual_close_tx,remote_funding_key,pubkey,

# channeld asks HSM to sign splice tx.
msgtype,hsmd_sign_splice_tx,29
msgdata,hsmd_sign_splice_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_splice_tx,remote_funding_key,pubkey,
msgdata,hsmd_sign_splice_tx,input_index,u32,

# Reply for all the above requests.
msgtype,hsmd_sign_tx_reply,112
msgdata,hsmd_sign_tx_reply,sig,bitcoin_signature,

# Openingd/channeld/onchaind asks for Nth per_commitment_point, if > 2, gets N-2 secret.
msgtype,hsmd_get_per_commitment_point,18
msgdata,hsmd_get_per_commitment_point,n,u64,

msgtype,hsmd_get_per_commitment_point_reply,118
msgdata,hsmd_get_per_commitment_point_reply,per_commitment_point,pubkey,
msgdata,hsmd_get_per_commitment_point_reply,old_commitment_secret,?secret,

# master -> hsmd: do you have a memleak?
msgtype,hsmd_dev_memleak,33

msgtype,hsmd_dev_memleak_reply,133
msgdata,hsmd_dev_memleak_reply,leak,bool,

# channeld asks to check if claimed future commitment_secret is correct.
msgtype,hsmd_check_future_secret,22
msgdata,hsmd_check_future_secret,n,u64,
msgdata,hsmd_check_future_secret,commitment_secret,secret,

msgtype,hsmd_check_future_secret_reply,122
msgdata,hsmd_check_future_secret_reply,correct,bool,

# lightningd asks us to sign a string.
msgtype,hsmd_sign_message,23
msgdata,hsmd_sign_message,len,u16,
msgdata,hsmd_sign_message,msg,u8,len

msgtype,hsmd_sign_message_reply,123
msgdata,hsmd_sign_message_reply,sig,secp256k1_ecdsa_recoverable_signature,

# lightningd needs to get a scriptPubkey for a utxo with closeinfo
msgtype,hsmd_get_output_scriptpubkey,24
msgdata,hsmd_get_output_scriptpubkey,channel_id,u64,
msgdata,hsmd_get_output_scriptpubkey,peer_id,node_id,
msgdata,hsmd_get_output_scriptpubkey,commitment_point,?pubkey,

msgtype,hsmd_get_output_scriptpubkey_reply,124
msgdata,hsmd_get_output_scriptpubkey_reply,script_len,u16,
msgdata,hsmd_get_output_scriptpubkey_reply,script,u8,script_len

# Sign a bolt12-style merkle hash
msgtype,hsmd_sign_bolt12,25
msgdata,hsmd_sign_bolt12,messagename,wirestring,
msgdata,hsmd_sign_bolt12,fieldname,wirestring,
msgdata,hsmd_sign_bolt12,merkleroot,sha256,
# This is for invreq payer_id (temporary keys)
msgdata,hsmd_sign_bolt12,publictweaklen,u16,
msgdata,hsmd_sign_bolt12,publictweak,u8,publictweaklen

msgtype,hsmd_sign_bolt12_reply,125
msgdata,hsmd_sign_bolt12_reply,sig,bip340sig,

# Sign an option_will_fund offer hash
msgtype,hsmd_sign_option_will_fund_offer,26
msgdata,hsmd_sign_option_will_fund_offer,funding_pubkey,pubkey,
msgdata,hsmd_sign_option_will_fund_offer,blockheight,u32,
msgdata,hsmd_sign_option_will_fund_offer,channel_fee_base_max_msat,u32,
msgdata,hsmd_sign_option_will_fund_offer,channel_fee_proportional_basis_max,u16,

msgtype,hsmd_sign_option_will_fund_offer_reply,126
msgdata,hsmd_sign_option_will_fund_offer_reply,rsig,secp256k1_ecdsa_signature,

# Derive pseudorandom secret
msgtype,hsmd_derive_secret,27
msgdata,hsmd_derive_secret,len,u16,
msgdata,hsmd_derive_secret,info,u8,len

# Reply with the derived secret
msgtype,hsmd_derive_secret_reply,127
msgdata,hsmd_derive_secret_reply,secret,secret,

# Sanity check this pubkey derivation is correct (unhardened only)
msgtype,hsmd_check_pubkey,28
msgdata,hsmd_check_pubkey,index,u32,
msgdata,hsmd_check_pubkey,pubkey,pubkey,

# Reply
msgtype,hsmd_check_pubkey_reply,128
msgdata,hsmd_check_pubkey_reply,ok,bool,

msgtype,hsmd_sign_anchorspend,147
msgdata,hsmd_sign_anchorspend,peerid,node_id,
msgdata,hsmd_sign_anchorspend,channel_dbid,u64,
msgdata,hsmd_sign_anchorspend,num_inputs,u16,
msgdata,hsmd_sign_anchorspend,inputs,utxo,num_inputs
msgdata,hsmd_sign_anchorspend,psbt,wally_psbt,

msgtype,hsmd_sign_anchorspend_reply,148
msgdata,hsmd_sign_anchorspend_reply,psbt,wally_psbt,

# These are where lightningd asks for signatures on onchaind's behalf.
msgtype,hsmd_sign_any_delayed_payment_to_us,142
msgdata,hsmd_sign_any_delayed_payment_to_us,commit_num,u64,
msgdata,hsmd_sign_any_delayed_payment_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_any_delayed_payment_to_us,wscript_len,u16,
msgdata,hsmd_sign_any_delayed_payment_to_us,wscript,u8,wscript_len
msgdata,hsmd_sign_any_delayed_payment_to_us,input,u32,
msgdata,hsmd_sign_any_delayed_payment_to_us,peerid,node_id,
msgdata,hsmd_sign_any_delayed_payment_to_us,channel_dbid,u64,

msgtype,hsmd_sign_any_remote_htlc_to_us,143
msgdata,hsmd_sign_any_remote_htlc_to_us,remote_per_commitment_point,pubkey,
msgdata,hsmd_sign_any_remote_htlc_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_any_remote_htlc_to_us,wscript_len,u16,
msgdata,hsmd_sign_any_remote_htlc_to_us,wscript,u8,wscript_len
msgdata,hsmd_sign_any_remote_htlc_to_us,option_anchor_outputs,bool,
msgdata,hsmd_sign_any_remote_htlc_to_us,input,u32,
msgdata,hsmd_sign_any_remote_htlc_to_us,peerid,node_id,
msgdata,hsmd_sign_any_remote_htlc_to_us,channel_dbid,u64,

msgtype,hsmd_sign_any_penalty_to_us,144
msgdata,hsmd_sign_any_penalty_to_us,revocation_secret,secret,
msgdata,hsmd_sign_any_penalty_to_us,tx,bitcoin_tx,
msgdata,hsmd_sign_any_penalty_to_us,wscript_len,u16,
msgdata,hsmd_sign_any_penalty_to_us,wscript,u8,wscript_len
msgdata,hsmd_sign_any_penalty_to_us,input,u32,
msgdata,hsmd_sign_any_penalty_to_us,peerid,node_id,
msgdata,hsmd_sign_any_penalty_to_us,channel_dbid,u64,

msgtype,hsmd_sign_any_local_htlc_tx,146
msgdata,hsmd_sign_any_local_htlc_tx,commit_num,u64,
msgdata,hsmd_sign_any_local_htlc_tx,tx,bitcoin_tx,
msgdata,hsmd_sign_any_local_htlc_tx,wscript_len,u16,
msgdata,hsmd_sign_any_local_htlc_tx,wscript,u8,wscript_len
msgdata,hsmd_sign_any_local_htlc_tx,option_anchor_outputs,bool,
msgdata,hsmd_sign_any_local_htlc_tx,input,u32,
msgdata,hsmd_sign_any_local_htlc_tx,peerid,node_id,
msgdata,hsmd_sign_any_local_htlc_tx,channel_dbid,u64,

msgtype,hsmd_sign_htlc_tx_mingle,149
msgdata,hsmd_sign_htlc_tx_mingle,peerid,node_id,
msgdata,hsmd_sign_htlc_tx_mingle,channel_dbid,u64,
msgdata,hsmd_sign_htlc_tx_mingle,num_inputs,u16,
msgdata,hsmd_sign_htlc_tx_mingle,inputs,utxo,num_inputs
msgdata,hsmd_sign_htlc_tx_mingle,psbt,wally_psbt,

msgtype,hsmd_sign_htlc_tx_mingle_reply,150
msgdata,hsmd_sign_htlc_tx_mingle_reply,psbt,wally_psbt,