Struct lightning_signer::policy::validator::EnforcementState

pub struct EnforcementState {
    pub next_holder_commit_num: u64,
    pub next_counterparty_commit_num: u64,
    pub next_counterparty_revoke_num: u64,
    pub current_counterparty_point: Option<PublicKey>,
    pub previous_counterparty_point: Option<PublicKey>,
    pub current_holder_commit_info: Option<CommitmentInfo2>,
    pub current_counterparty_commit_info: Option<CommitmentInfo2>,
    pub previous_counterparty_commit_info: Option<CommitmentInfo2>,
    pub mutual_close_signed: bool,
}

Enforcement state for a signer

This keeps track of commitments on both sides and whether the channel was closed.

Fields

next_holder_commit_num: u64

next_counterparty_commit_num: u64

next_counterparty_revoke_num: u64

current_counterparty_point: Option<PublicKey>

previous_counterparty_point: Option<PublicKey>

current_holder_commit_info: Option<CommitmentInfo2>

current_counterparty_commit_info: Option<CommitmentInfo2>

previous_counterparty_commit_info: Option<CommitmentInfo2>

mutual_close_signed: bool

Implementations

impl EnforcementState

pub fn new() -> EnforcementState

Create state for a new channel

pub fn minimum_to_holder_value(&self, epsilon_sat: u64) -> Option<u64>

Returns the minimum amount to_holder from both commitments or None if the amounts are not within epsilon_sat.

pub fn minimum_to_counterparty_value(&self, epsilon_sat: u64) -> Option<u64>

Returns the minimum amount to_counterparty from both commitments or None if the amounts are not within epsilon_sat.

pub fn set_next_holder_commit_num(
    &mut self,
    num: u64,
    current_commitment_info: CommitmentInfo2
) -> Result<(), ValidationError>

Set next holder commitment number

pub fn get_current_holder_commitment_info(
    &self,
    commitment_number: u64
) -> Result<CommitmentInfo2, ValidationError>

Get the current commitment info

pub fn set_next_counterparty_commit_num(
    &mut self,
    num: u64,
    current_point: PublicKey,
    current_commitment_info: CommitmentInfo2
) -> Result<(), ValidationError>

Set next counterparty commitment number

pub fn get_previous_counterparty_point(
    &self,
    num: u64
) -> Result<PublicKey, ValidationError>

Previous counterparty commitment point

pub fn get_previous_counterparty_commit_info(
    &self,
    num: u64
) -> Result<CommitmentInfo2, ValidationError>

Previous counterparty commitment info

pub fn set_next_counterparty_revoke_num(
    &mut self,
    num: u64
) -> Result<(), ValidationError>

Set next counterparty revoked commitment number

pub fn set_next_holder_commit_num_for_testing(&mut self, num: u64)

pub fn set_next_counterparty_commit_num_for_testing(
    &mut self,
    num: u64,
    current_point: PublicKey
)

pub fn set_next_counterparty_revoke_num_for_testing(&mut self, num: u64)

Trait Implementations

impl Clone for EnforcementState

fn clone(&self) -> EnforcementState

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnforcementState

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

Formats the value using the given formatter.