Struct CounterpartyCommitmentSecrets

pub struct CounterpartyCommitmentSecrets { /* private fields */ }

Copied from LDK because we need to serialize it

Implementations

impl CounterpartyCommitmentSecrets

pub fn new() -> Self

Creates a new empty CounterpartyCommitmentSecrets structure.

pub fn get_min_seen_secret(&self) -> u64

Returns the minimum index of all stored secrets. Note that indexes start at 1 << 48 and get decremented by one for each new secret.

pub fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), ()>

Inserts the secret at idx. Returns Ok(()) if the secret was generated in accordance with BOLT 3 and is consistent with previous secrets.

pub fn get_secret(&self, idx: u64) -> Option<[u8; 32]>

Returns the secret at idx. Returns None if idx is < CounterpartyCommitmentSecrets::get_min_seen_secret.

Trait Implementations

impl Clone for CounterpartyCommitmentSecrets

fn clone(&self) -> CounterpartyCommitmentSecrets

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CounterpartyCommitmentSecrets

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CounterpartyCommitmentSecrets

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CounterpartyCommitmentSecrets

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

where __S: Serializer,

Serialize this value into the given Serde serializer.