Struct LocalKeyset

pub struct LocalKeyset {
    pub funding_pubkey: LocalPubkey,
    pub revocation_basepoint: LocalPubkey,
    pub payment_basepoint: LocalPubkey,
    pub delayed_payment_basepoint: LocalPubkey,
    pub htlc_basepoint: LocalPubkey,
    pub first_per_commitment_point: LocalPubkey,
    pub shutdown_scriptpubkey: Option<PubkeyScript>,
    pub static_remotekey: bool,
}

Set of keys used by the core of the channel. It does not include HTLC basepoint which is managed separately by super::Htlc extension.

Fields

funding_pubkey: LocalPubkey

Public key used in the funding outpoint multisig

revocation_basepoint: LocalPubkey

Base point for deriving keys used for penalty spending paths

payment_basepoint: LocalPubkey

Base point for deriving keys in to_remote

delayed_payment_basepoint: LocalPubkey

Base point for deriving keys in to_local time-locked spending paths

htlc_basepoint: LocalPubkey

Base point for deriving HTLC-related keys

first_per_commitment_point: LocalPubkey

Base point for deriving keys used for penalty spending paths

shutdown_scriptpubkey: Option<PubkeyScript>

Allows the sending node to commit to where funds will go on mutual close, which the remote node should enforce even if a node is compromised later.

static_remotekey: bool

If option_static_remotekey or option_anchors is negotiated, the remotepubkey is simply the remote node’s payment_basepoint, otherwise it is calculated as above using the remote node’s payment_basepoint.

Implementations

impl LocalKeyset

pub fn with<C: Signing>( secp: &Secp256k1<C>, channel_source: KeySource, channel_xpriv: ExtendedPrivKey, shutdown_scriptpubkey: Option<PubkeyScript>, ) -> Self

Derives keyset from a channel extended key using LNPBP-46 standard

Trait Implementations

impl Clone for LocalKeyset

fn clone(&self) -> LocalKeyset

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalKeyset

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LocalKeyset

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for LocalKeyset

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

Formats the value using the given formatter.

impl DumbDefault for LocalKeyset

fn dumb_default() -> Self

Returns an object initialized with dumb data

impl PartialEq for LocalKeyset

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

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

const 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 Serialize for LocalKeyset

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StrictDecode for LocalKeyset

fn strict_decode<D: Read>(d: D) -> Result<Self, Error>

Decode with the given std::io::Read instance; must either construct an instance or return implementation-specific error type.

fn strict_deserialize(data: impl AsRef<[u8]>) -> Result<Self, Error>

Tries to deserialize byte array into the current type using StrictDecode::strict_decode. If there are some data remains in the buffer once deserialization is completed, fails with Error::DataNotEntirelyConsumed. Use io::Cursor over the buffer and StrictDecode::strict_decode to avoid such failures.

fn strict_file_load(path: impl AsRef<Path>) -> Result<Self, Error>

Reads data from file at path and reconstructs object from it. Fails with Error::DataNotEntirelyConsumed if file contains remaining data after the object reconstruction.

impl StrictEncode for LocalKeyset

fn strict_encode<E: Write>(&self, e: E) -> Result<usize, Error>

Encode with the given std::io::Write instance; must return result with either amount of bytes encoded – or implementation-specific error type.

fn strict_serialize(&self) -> Result<Vec<u8>, Error>

Serializes data as a byte array using StrictEncode::strict_encode function

fn strict_file_save(&self, path: impl AsRef<Path>) -> Result<usize, Error>

Saves data to a file at a given path. If the file does not exists, attempts to create the file. If the file already exists, it gets truncated.

impl ToYamlString for LocalKeyset

Available on crate feature serde only.

fn to_yaml_string(&self) -> String

Performs conversion of the self into a YAML-encoded string

impl Eq for LocalKeyset

impl StructuralPartialEq for LocalKeyset