paych

Documentation

Index

• Variables
• func GetActorCodeID(av actors.Version) (cid.Cid, error)
• type LaneState
• type MessageBuilder
  • func Message(version actors.Version, from address.Address) MessageBuilder
• type ModVerifyParams
• type SignedVoucher
  • func DecodeSignedVoucher(s string) (*SignedVoucher, error)
• type State
  • func Load(store adt.Store, act *types.Actor) (State, error)
  • func MakeState(store adt.Store, av actors.Version) (State, error)

Variables

var Methods = builtin6.MethodsPaych

Functions

func GetActorCodeID

func GetActorCodeID(av actors.Version) (cid.Cid, error)

Types

type LaneState

type LaneState interface {
	Redeemed() (big.Int, error)
	Nonce() (uint64, error)
}

LaneState is an abstract copy of the state of a single lane

type MessageBuilder

type MessageBuilder interface {
	Create(to address.Address, initialAmount abi.TokenAmount) (*types.Message, error)
	Update(paych address.Address, voucher *SignedVoucher, secret []byte) (*types.Message, error)
	Settle(paych address.Address) (*types.Message, error)
	Collect(paych address.Address) (*types.Message, error)
}

func Message

func Message(version actors.Version, from address.Address) MessageBuilder

type ModVerifyParams

type ModVerifyParams = paych0.ModVerifyParams

type SignedVoucher

type SignedVoucher = paych0.SignedVoucher

func DecodeSignedVoucher

func DecodeSignedVoucher(s string) (*SignedVoucher, error)

DecodeSignedVoucher decodes base64 encoded signed voucher.

type State

type State interface {
	cbor.Marshaler
	// Channel owner, who has funded the actor
	From() (address.Address, error)
	// Recipient of payouts from channel
	To() (address.Address, error)

	// Height at which the channel can be `Collected`
	SettlingAt() (abi.ChainEpoch, error)

	// Amount successfully redeemed through the payment channel, paid out on `Collect()`
	ToSend() (abi.TokenAmount, error)

	// Get total number of lanes
	LaneCount() (uint64, error)

	// Iterate lane states
	ForEachLaneState(cb func(idx uint64, dl LaneState) error) error

	GetState() interface{}
}

State is an abstract version of payment channel state that works across versions

func Load

func Load(store adt.Store, act *types.Actor) (State, error)

Load returns an abstract copy of payment channel state, irregardless of actor version

func MakeState

func MakeState(store adt.Store, av actors.Version) (State, error)