Struct lightning::ln::chan_utils::CounterpartyCommitmentSecrets

pub struct CounterpartyCommitmentSecrets { /* private fields */ }

Implements the per-commitment secret storage scheme from BOLT 3.

Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes or so.

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 copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<CounterpartyCommitmentSecrets> for CounterpartyCommitmentSecrets

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Readable for CounterpartyCommitmentSecrets

fn read<R: Read>(reader: &mut R) -> Result<Self, DecodeError>

Reads a Self in from the given Read.

impl Writeable for CounterpartyCommitmentSecrets

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

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 Eq for CounterpartyCommitmentSecrets