Struct forest_actor::paych::State

pub struct State {
    pub from: Address,
    pub to: Address,
    pub to_send: TokenAmount,
    pub settling_at: ChainEpoch,
    pub min_settle_height: ChainEpoch,
    pub lane_states: Cid,
}

A given payment channel actor is established by from to enable off-chain microtransactions to to address to be reconciled and tallied on chain.

Fields

from: Address

Channel owner, who has funded the actor.

to: Address

Recipient of payouts from channel.

to_send: TokenAmount

Amount successfully redeemed through the payment channel, paid out on Collect.

settling_at: ChainEpoch

Height at which the channel can be collected.

min_settle_height: ChainEpoch

Height before which the channel ToSend cannot be collected.

lane_states: Cid

Collections of lane states for the channel, maintained in ID order.

Implementations

impl State

pub fn new(from: Address, to: Address, empty_arr_cid: Cid) -> Self

Trait Implementations

impl Cbor for State

pub fn marshal_cbor(&self) -> Result<Vec<u8, Global>, Error>

Marshalls cbor encodable object into cbor bytes

pub fn unmarshal_cbor(bz: &[u8]) -> Result<Self, Error>

Unmarshals cbor encoded bytes to object

pub fn cid(&self) -> Result<Cid, Error>

Returns the content identifier of the raw block of data Default is Blake2b256 hash

impl Debug for State

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for State

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for State

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

Serialize this value into the given Serde serializer.