paych

Documentation

Index

• type ChannelAvailableFunds
• type ChannelInfo
• type IPaychan
• type PaychStatus
• type PaychSubmodule
  • func NewPaychSubmodule(ctx context.Context, params *paychmgr.ManagerParams) *PaychSubmodule
  • func (ps *PaychSubmodule) API() IPaychan
  • func (ps *PaychSubmodule) Start() error
  • func (ps *PaychSubmodule) Stop()
• type PaymentInfo
• type VoucherCreateResult
• type VoucherSpec

Types

type ChannelAvailableFunds

type ChannelAvailableFunds = paychmgr.ChannelAvailableFunds

type ChannelInfo

type ChannelInfo struct {
	Channel      address.Address
	WaitSentinel cid.Cid
}

type IPaychan

type IPaychan interface {
	PaychGet(ctx context.Context, from, to address.Address, amt big.Int) (*ChannelInfo, error)
	PaychAvailableFunds(ctx context.Context, ch address.Address) (*paychmgr.ChannelAvailableFunds, error)
	PaychAvailableFundsByFromTo(ctx context.Context, from, to address.Address) (*paychmgr.ChannelAvailableFunds, error)
	PaychGetWaitReady(ctx context.Context, sentinel cid.Cid) (address.Address, error)
	PaychAllocateLane(ctx context.Context, ch address.Address) (uint64, error)
	PaychNewPayment(ctx context.Context, from, to address.Address, vouchers []VoucherSpec) (*PaymentInfo, error)
	PaychList(ctx context.Context) ([]address.Address, error)
	PaychStatus(ctx context.Context, pch address.Address) (*types.PaychStatus, error)
	PaychSettle(ctx context.Context, addr address.Address) (cid.Cid, error)
	PaychCollect(ctx context.Context, addr address.Address) (cid.Cid, error)
	PaychVoucherCheckValid(ctx context.Context, ch address.Address, sv *paych.SignedVoucher) error
	PaychVoucherCheckSpendable(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, secret []byte, proof []byte) (bool, error)
	PaychVoucherAdd(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, proof []byte, minDelta big.Int) (big.Int, error)
	PaychVoucherCreate(ctx context.Context, pch address.Address, amt big.Int, lane uint64) (*paychmgr.VoucherCreateResult, error)
	PaychVoucherList(ctx context.Context, pch address.Address) ([]*paych.SignedVoucher, error)
	PaychVoucherSubmit(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, secret []byte, proof []byte) (cid.Cid, error)
}

type PaychStatus

type PaychStatus = types.PaychStatus //nolint

type PaychSubmodule

type PaychSubmodule struct {
	// contains filtered or unexported fields
}

func NewPaychSubmodule

func NewPaychSubmodule(ctx context.Context, params *paychmgr.ManagerParams) *PaychSubmodule

func (*PaychSubmodule) API

func (ps *PaychSubmodule) API() IPaychan

func (*PaychSubmodule) Start

func (ps *PaychSubmodule) Start() error

func (*PaychSubmodule) Stop

func (ps *PaychSubmodule) Stop()

type PaymentInfo

type PaymentInfo struct {
	Channel      address.Address
	WaitSentinel cid.Cid
	Vouchers     []*paych.SignedVoucher
}

type VoucherCreateResult

type VoucherCreateResult = paychmgr.VoucherCreateResult

type VoucherSpec

type VoucherSpec struct {
	Amount      big.Int
	TimeLockMin abi.ChainEpoch
	TimeLockMax abi.ChainEpoch
	MinSettle   abi.ChainEpoch

	Extra *paych.ModVerifyParams
}