Struct 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_signatures: Option<CommitmentSignatures>,
    pub next_holder_commit_info: Option<(CommitmentInfo2, CommitmentSignatures)>,
    pub current_counterparty_commit_info: Option<CommitmentInfo2>,
    pub previous_counterparty_commit_info: Option<CommitmentInfo2>,
    pub channel_closed: bool,
    pub initial_holder_value: u64,
    pub counterparty_secrets: Option<CounterpartyCommitmentSecrets>,
}

Enforcement state for a channel

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_signatures: Option<CommitmentSignatures>

Counterparty signatures on holder’s commitment

next_holder_commit_info: Option<(CommitmentInfo2, CommitmentSignatures)>

Next holder commitment

current_counterparty_commit_info: Option<CommitmentInfo2>

previous_counterparty_commit_info: Option<CommitmentInfo2>

channel_closed: bool

initial_holder_value: u64

counterparty_secrets: Option<CounterpartyCommitmentSecrets>

Counterparty revocation secrets. This is an Option for backwards compatibility with old databases.

Implementations

impl EnforcementState

pub fn new(initial_holder_value: u64) -> EnforcementState

Create state for a new channel.

initial_holder_value is in satoshi and represents the lowest value that we expect the initial commitment to send to us.

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, counterparty_signatures: CommitmentSignatures, )

Set next holder commitment number Policy enforcement must be performed by the caller

pub fn set_next_counterparty_commit_num( &mut self, num: u64, current_point: PublicKey, current_commitment_info: CommitmentInfo2, )

Set next counterparty commitment number

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

Previous counterparty commitment point, or None if unknown

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

Previous counterparty commitment info

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

Set next counterparty revoked commitment number

pub fn payments_summary( &self, new_holder_tx: Option<&CommitmentInfo2>, new_counterparty_tx: Option<&CommitmentInfo2>, ) -> Map<PaymentHash, u64>

Summarize in-flight outgoing payments, possibly with new holder offered or counterparty received commitment tx. The amounts are in satoshi. HTLCs belonging to a payment are summed for each of the holder and counterparty txs. The greater value is taken as the actual in-flight value.

pub fn incoming_payments_summary( &self, new_holder_tx: Option<&CommitmentInfo2>, new_counterparty_tx: Option<&CommitmentInfo2>, ) -> Map<PaymentHash, u64>

Summarize in-flight incoming payments, possibly with new holder offered or counterparty received commitment tx. The amounts are in satoshi. HTLCs belonging to a payment are summed for each of the holder and counterparty txs. The smaller value is taken as the actual in-flight value.

pub fn claimable_balances<T: PreimageMap>( &self, preimage_map: &T, new_holder_tx: Option<&CommitmentInfo2>, new_counterparty_tx: Option<&CommitmentInfo2>, channel_setup: &ChannelSetup, ) -> BalanceDelta

The claimable balance before and after a new commitment tx

See CommitmentInfo2::claimable_balance

pub fn balance<T: PreimageMap + Debug>( &self, preimage_map: &T, channel_setup: &ChannelSetup, is_ready: bool, ) -> ChannelBalance

Return channel balances

Trait Implementations

impl Clone for EnforcementState

fn clone(&self) -> EnforcementState

Returns a duplicate 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.

impl<'de> Deserialize<'de> for EnforcementState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EnforcementState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.