Struct ChannelState

pub struct ChannelState {

    pub funding: Funding,
    pub stage: Lifecycle,
    pub chain_hash: Slice32,
    pub active_channel_id: ActiveChannelId,
    pub local_amount_msat: u64,
    pub remote_amount_msat: u64,
    pub commitment_number: u64,
    pub commitment_sigs: Vec<Signature>,
    pub policy: Policy,
    pub common_params: CommonParams,
    pub local_params: PeerParams,
    pub remote_params: PeerParams,
    pub local_keys: LocalKeyset,
    pub remote_keys: RemoteKeyset,
    pub remote_per_commitment_point: PublicKey,
    pub local_per_commitment_point: PublicKey,
    pub direction: Direction,
    pub offered_htlcs: BTreeMap<u64, HtlcSecret>,
    pub received_htlcs: BTreeMap<u64, HtlcSecret>,
    pub resolved_htlcs: BTreeMap<u64, HtlcKnown>,
    pub last_recieved_htlc_id: u64,
    pub last_offered_htlc_id: u64,
}

Fields

funding: Funding

stage: Lifecycle

Current channel lifecycle stage

chain_hash: Slice32

The chain_hash value denotes the exact blockchain that the opened channel will reside within. This is usually the genesis hash of the respective blockchain. The existence of the chain_hash allows nodes to open channels across many distinct blockchains as well as have channels within multiple blockchains opened to the same peer (if it supports the target chains).

active_channel_id: ActiveChannelId

Channel id used by the channel; first temporary and later final.

The temporary_channel_id is used to identify this channel on a per-peer basis until the funding transaction is established, at which point it is replaced by the channel_id, which is derived from the funding transaction.

local_amount_msat: u64

Amount in millisatoshis

remote_amount_msat: u64

Amount in millisatoshis

commitment_number: u64

commitment_sigs: Vec<Signature>

policy: Policy

The policy for accepting remote node params

common_params: CommonParams

Common parameters applying for both nodes

local_params: PeerParams

Channel parameters required to be met by the remote node when operating towards the local one

remote_params: PeerParams

Channel parameters to be used towards the remote node

local_keys: LocalKeyset

Set of locally-derived keys for creating channel transactions

remote_keys: RemoteKeyset

Set of remote-derived keys for creating channel transactions

remote_per_commitment_point: PublicKey

local_per_commitment_point: PublicKey

direction: Direction

Keeps information about node directionality

offered_htlcs: BTreeMap<u64, HtlcSecret>

received_htlcs: BTreeMap<u64, HtlcSecret>

resolved_htlcs: BTreeMap<u64, HtlcKnown>

last_recieved_htlc_id: u64

last_offered_htlc_id: u64

Trait Implementations

impl Clone for ChannelState

fn clone(&self) -> ChannelState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ChannelState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ChannelState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ChannelState

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

Formats the value using the given formatter.

impl DumbDefault for ChannelState

fn dumb_default() -> Self

Returns an object initialized with dumb data

impl Serialize for ChannelState

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl State for ChannelState

fn to_funding(&self) -> Funding

fn set_funding(&mut self, funding: &Funding)

impl StrictDecode for ChannelState

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 ChannelState

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 ChannelState

Available on crate feature serde only.

fn to_yaml_string(&self) -> String

Performs conversion of the self into a YAML-encoded string