Struct breez_sdk_core::lightning::sign::InMemorySigner

pub struct InMemorySigner {
    pub funding_key: SecretKey,
    pub revocation_base_key: SecretKey,
    pub payment_key: SecretKey,
    pub delayed_payment_base_key: SecretKey,
    pub htlc_base_key: SecretKey,
    pub commitment_seed: [u8; 32],
    /* private fields */
}

A simple implementation of WriteableEcdsaChannelSigner that just keeps the private keys in memory.

This implementation performs no policy checks and is insufficient by itself as a secure external signer.

Fields

funding_key: SecretKey

Holder secret key in the 2-of-2 multisig script of a channel. This key also backs the holder’s anchor output in a commitment transaction, if one is present.

revocation_base_key: SecretKey

Holder secret key for blinded revocation pubkey.

payment_key: SecretKey

Holder secret key used for our balance in counterparty-broadcasted commitment transactions.

delayed_payment_base_key: SecretKey

Holder secret key used in an HTLC transaction.

htlc_base_key: SecretKey

Holder HTLC secret key used in commitment transaction HTLC outputs.

commitment_seed: [u8; 32]

Commitment seed.

Implementations

impl InMemorySigner

pub fn new<C>( secp_ctx: &Secp256k1<C>, funding_key: SecretKey, revocation_base_key: SecretKey, payment_key: SecretKey, delayed_payment_base_key: SecretKey, htlc_base_key: SecretKey, commitment_seed: [u8; 32], channel_value_satoshis: u64, channel_keys_id: [u8; 32], rand_bytes_unique_start: [u8; 32], ) -> InMemorySigner

where C: Signing,

Creates a new InMemorySigner.

pub fn counterparty_pubkeys(&self) -> Option<&ChannelPublicKeys>

Returns the counterparty’s pubkeys.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn counterparty_selected_contest_delay(&self) -> Option<u16>

Returns the contest_delay value specified by our counterparty and applied on holder-broadcastable transactions, i.e., the amount of time that we have to wait to recover our funds if we broadcast a transaction.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn holder_selected_contest_delay(&self) -> Option<u16>

Returns the contest_delay value specified by us and applied on transactions broadcastable by our counterparty, i.e., the amount of time that they have to wait to recover their funds if they broadcast a transaction.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn is_outbound(&self) -> Option<bool>

Returns whether the holder is the initiator.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn funding_outpoint(&self) -> Option<&OutPoint>

Funding outpoint

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn get_channel_parameters(&self) -> Option<&ChannelTransactionParameters>

Returns a ChannelTransactionParameters for this channel, to be used when verifying or building transactions.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn channel_type_features(&self) -> Option<&Features<ChannelTypeContext>>

Returns the channel type features of the channel parameters. Should be helpful for determining a channel’s category, i. e. legacy/anchors/taproot/etc.

Will return None if ChannelSigner::provide_channel_parameters has not been called. In general, this is safe to unwrap only in ChannelSigner implementation.

pub fn sign_counterparty_payment_input<C>( &self, spend_tx: &Transaction, input_idx: usize, descriptor: &StaticPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>, ) -> Result<Vec<Vec<u8>>, ()>

where C: Signing,

Sign the single input of spend_tx at index input_idx, which spends the output described by descriptor, returning the witness stack for the input.

Returns an error if the input at input_idx does not exist, has a non-empty script_sig, is not spending the outpoint described by descriptor.outpoint, or if an output descriptor script_pubkey does not match the one we can spend.

pub fn sign_dynamic_p2wsh_input<C>( &self, spend_tx: &Transaction, input_idx: usize, descriptor: &DelayedPaymentOutputDescriptor, secp_ctx: &Secp256k1<C>, ) -> Result<Vec<Vec<u8>>, ()>

where C: Signing,

Sign the single input of spend_tx at index input_idx which spends the output described by descriptor, returning the witness stack for the input.

Returns an error if the input at input_idx does not exist, has a non-empty script_sig, is not spending the outpoint described by descriptor.outpoint, does not have a sequence set to descriptor.to_self_delay, or if an output descriptor script_pubkey does not match the one we can spend.

Trait Implementations

impl ChannelSigner for InMemorySigner

fn get_per_commitment_point( &self, idx: u64, secp_ctx: &Secp256k1<All>, ) -> PublicKey

Gets the per-commitment point for a specific commitment number

fn release_commitment_secret(&self, idx: u64) -> [u8; 32]

Gets the commitment secret for a specific commitment number as part of the revocation process

fn validate_holder_commitment( &self, _holder_tx: &HolderCommitmentTransaction, _preimages: Vec<PaymentPreimage>, ) -> Result<(), ()>

Validate the counterparty’s signatures on the holder commitment transaction and HTLCs.

fn pubkeys(&self) -> &ChannelPublicKeys

Returns the holder’s channel public keys and basepoints.

fn channel_keys_id(&self) -> [u8; 32]

Returns an arbitrary identifier describing the set of keys which are provided back to you in some SpendableOutputDescriptor types. This should be sufficient to identify this EcdsaChannelSigner object uniquely and lookup or re-derive its keys.

fn provide_channel_parameters( &mut self, channel_parameters: &ChannelTransactionParameters, )

Set the counterparty static channel data, including basepoints, counterparty_selected/holder_selected_contest_delay and funding outpoint.

impl Clone for InMemorySigner

fn clone(&self) -> InMemorySigner

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InMemorySigner

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl EcdsaChannelSigner for InMemorySigner

fn sign_counterparty_commitment( &self, commitment_tx: &CommitmentTransaction, _preimages: Vec<PaymentPreimage>, secp_ctx: &Secp256k1<All>, ) -> Result<(Signature, Vec<Signature>), ()>

Create a signature for a counterparty’s commitment transaction and associated HTLC transactions.

fn validate_counterparty_revocation( &self, _idx: u64, _secret: &SecretKey, ) -> Result<(), ()>

Validate the counterparty’s revocation.

fn sign_holder_commitment( &self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Creates a signature for a holder’s commitment transaction.

fn unsafe_sign_holder_commitment( &self, commitment_tx: &HolderCommitmentTransaction, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Same as [sign_holder_commitment], but exists only for tests to get access to holder commitment transactions which will be broadcasted later, after the channel has moved on to a newer state. Thus, needs its own method as [sign_holder_commitment] may enforce that we only ever get called once.

fn sign_justice_revoked_output( &self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Create a signature for the given input in a transaction spending an HTLC transaction output or a commitment transaction to_local output when our counterparty broadcasts an old state.

fn sign_justice_revoked_htlc( &self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Create a signature for the given input in a transaction spending a commitment transaction HTLC output when our counterparty broadcasts an old state.

fn sign_holder_htlc_transaction( &self, htlc_tx: &Transaction, input: usize, htlc_descriptor: &HTLCDescriptor, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Computes the signature for a commitment transaction’s HTLC output used as an input within htlc_tx, which spends the commitment transaction at index input. The signature returned must be be computed using EcdsaSighashType::All.

fn sign_counterparty_htlc_transaction( &self, htlc_tx: &Transaction, input: usize, amount: u64, per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Create a signature for a claiming transaction for a HTLC output on a counterparty’s commitment transaction, either offered or received.

fn sign_closing_transaction( &self, closing_tx: &ClosingTransaction, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Create a signature for a (proposed) closing transaction.

fn sign_holder_anchor_input( &self, anchor_tx: &Transaction, input: usize, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Computes the signature for a commitment transaction’s anchor output used as an input within anchor_tx, which spends the commitment transaction, at index input.

fn sign_channel_announcement_with_funding_key( &self, msg: &UnsignedChannelAnnouncement, secp_ctx: &Secp256k1<All>, ) -> Result<Signature, ()>

Signs a channel announcement message with our funding key proving it comes from one of the channel participants.

impl EntropySource for InMemorySigner

fn get_secure_random_bytes(&self) -> [u8; 32]

Gets a unique, cryptographically-secure, random 32-byte value. This method must return a different value each time it is called.

impl PartialEq for InMemorySigner

fn eq(&self, other: &InMemorySigner) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<ES> ReadableArgs<ES> for InMemorySigner

where ES: Deref, <ES as Deref>::Target: EntropySource,

fn read<R>( reader: &mut R, entropy_source: ES, ) -> Result<InMemorySigner, DecodeError>

where R: Read,

Reads a Self in from the given Read.

impl Writeable for InMemorySigner

fn write<W>(&self, writer: &mut W) -> Result<(), Error>

where W: Writer,

Writes self out to the given Writer.

fn encode(&self) -> Vec<u8>

Writes self out to a Vec<u8>.

fn serialized_length(&self) -> usize

Gets the length of this object after it has been serialized. This can be overridden to optimize cases where we prepend an object with its length.

impl WriteableEcdsaChannelSigner for InMemorySigner