Struct lightning_signer::signer::my_keys_manager::MyKeysManager

pub struct MyKeysManager { /* fields omitted */ }

An implementation of KeysInterface

Implementations

impl MyKeysManager

pub fn new(
    key_derivation_style: KeyDerivationStyle,
    seed: &[u8],
    network: Network,
    starting_time_secs: u64,
    starting_time_nanos: u32
) -> MyKeysManager

Construct

pub fn get_account_extended_key(&self) -> &ExtendedPrivKey

Get the layer-1 xpub

pub fn per_commitment_point<X: Signing>(
    secp_ctx: &Secp256k1<X>,
    commitment_secret: &[u8; 32]
) -> PublicKey

Convert a commitment secret to a commitment point

pub fn spend_spendable_outputs(
    &self,
    descriptors: &[&SpendableOutputDescriptor],
    outputs: Vec<TxOut>,
    change_destination_script: Script,
    feerate_sat_per_1000_weight: u32,
    secp_ctx: &Secp256k1<All>
) -> Result<Transaction, ()>

Creates a Transaction which spends the given descriptors to the given outputs, plus an output to the given change destination (if sufficient change value remains). The transaction will have a feerate, at least, of the given value.

Returns Err(()) if the output value is greater than the input value minus required fee or if a descriptor was duplicated.

We do not enforce that outputs meet the dust limit or that any output scripts are standard.

May panic if the SpendableOutputDescriptors were not generated by Channels which used this KeysManager or one of the InMemorySigner created by this KeysManager.

Trait Implementations

impl KeysInterface for MyKeysManager

type Signer = InMemorySigner

A type which implements Sign which will be returned by get_channel_signer.

fn get_node_secret(&self) -> SecretKey

Get node secret key (aka node_id or network_key).

fn get_destination_script(&self) -> Script

Get a script pubkey which we send funds to when claiming on-chain contestable outputs.

fn get_shutdown_scriptpubkey(&self) -> ShutdownScript

Get a script pubkey which we will send funds to when closing a channel.

fn get_channel_signer(
    &self,
    _inbound: bool,
    _channel_value_sat: u64
) -> InMemorySigner

Get a new set of Sign for per-channel secrets. These MUST be unique even if you restarted with some stale data!

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

Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting onion packets and for temporary channel IDs. There is no requirement that these be persisted anywhere, though they must be unique across restarts.

fn read_chan_signer(&self, _reader: &[u8]) -> Result<Self::Signer, DecodeError>

Reads a Signer for this KeysInterface from the given input stream. This is only called during deserialization of other objects which contain Sign-implementing objects (ie ChannelMonitors and ChannelManagers). The bytes are exactly those which <Self::Signer as Writeable>::write() writes, and contain no versioning scheme. You may wish to include your own version prefix and ensure you’ve read all of the provided bytes to ensure no corruption occurred.

fn sign_invoice(
    &self,
    _invoice_preimage: Vec<u8>
) -> Result<RecoverableSignature, ()>

Sign an invoice’s preimage (note that this is the preimage of the invoice, not the HTLC’s preimage). By parameterizing by the preimage instead of the hash, we allow implementors of this trait to parse the invoice and make sure they’re signing what they expect, rather than blindly signing the hash.

fn get_inbound_payment_key_material(&self) -> KeyMaterial

Get secret key material as bytes for use in encrypting and decrypting inbound payment data.