paych

Documentation

Index

• type PaychAPI
  • func NewPaychAPI(p *paychmgr.Manager) *PaychAPI
  • func (a *PaychAPI) PaychAllocateLane(ctx context.Context, ch address.Address) (uint64, error)
  • func (a *PaychAPI) PaychAvailableFunds(ctx context.Context, ch address.Address) (*types.ChannelAvailableFunds, error)
  • func (a *PaychAPI) PaychAvailableFundsByFromTo(ctx context.Context, from, to address.Address) (*types.ChannelAvailableFunds, error)
  • func (a *PaychAPI) PaychCollect(ctx context.Context, addr address.Address) (cid.Cid, error)
  • func (a *PaychAPI) PaychFund(ctx context.Context, from, to address.Address, amt types.BigInt) (*types.ChannelInfo, error)
  • func (a *PaychAPI) PaychGet(ctx context.Context, from, to address.Address, amt types.BigInt, ...) (*types.ChannelInfo, error)
  • func (a *PaychAPI) PaychGetWaitReady(ctx context.Context, sentinel cid.Cid) (address.Address, error)
  • func (a *PaychAPI) PaychList(ctx context.Context) ([]address.Address, error)
  • func (a *PaychAPI) PaychNewPayment(ctx context.Context, from, to address.Address, vouchers []types.VoucherSpec) (*types.PaymentInfo, error)
  • func (a *PaychAPI) PaychSettle(ctx context.Context, addr address.Address) (cid.Cid, error)
  • func (a *PaychAPI) PaychStatus(ctx context.Context, pch address.Address) (*types.Status, error)
  • func (a *PaychAPI) PaychVoucherAdd(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, proof []byte, ...) (big.Int, error)
  • func (a *PaychAPI) PaychVoucherCheckSpendable(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, ...) (bool, error)
  • func (a *PaychAPI) PaychVoucherCheckValid(ctx context.Context, ch address.Address, sv *paych.SignedVoucher) error
  • func (a *PaychAPI) PaychVoucherCreate(ctx context.Context, pch address.Address, amt big.Int, lane uint64) (*types.VoucherCreateResult, error)
  • func (a *PaychAPI) PaychVoucherList(ctx context.Context, pch address.Address) ([]*paych.SignedVoucher, error)
  • func (a *PaychAPI) PaychVoucherSubmit(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, ...) (cid.Cid, error)
• type PaychSubmodule
  • func NewPaychSubmodule(ctx context.Context, ds datastore.Batching, params *paychmgr.ManagerParams) (*PaychSubmodule, error)
  • func (ps *PaychSubmodule) API() v1api.IPaychan
  • func (ps *PaychSubmodule) Start(ctx context.Context) error
  • func (ps *PaychSubmodule) Stop()
  • func (ps *PaychSubmodule) V0API() v0api.IPaychan

Types

type PaychAPI

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

func NewPaychAPI

func NewPaychAPI(p *paychmgr.Manager) *PaychAPI

func (*PaychAPI) PaychAllocateLane

func (a *PaychAPI) PaychAllocateLane(ctx context.Context, ch address.Address) (uint64, error)

func (*PaychAPI) PaychAvailableFunds

func (a *PaychAPI) PaychAvailableFunds(ctx context.Context, ch address.Address) (*types.ChannelAvailableFunds, error)

func (*PaychAPI) PaychAvailableFundsByFromTo

func (a *PaychAPI) PaychAvailableFundsByFromTo(ctx context.Context, from, to address.Address) (*types.ChannelAvailableFunds, error)

func (*PaychAPI) PaychCollect

func (a *PaychAPI) PaychCollect(ctx context.Context, addr address.Address) (cid.Cid, error)

func (*PaychAPI) PaychFund

func (a *PaychAPI) PaychFund(ctx context.Context, from, to address.Address, amt types.BigInt) (*types.ChannelInfo, error)

func (*PaychAPI) PaychGet

func (a *PaychAPI) PaychGet(ctx context.Context, from, to address.Address, amt types.BigInt, opts types.PaychGetOpts) (*types.ChannelInfo, error)

func (*PaychAPI) PaychGetWaitReady

func (a *PaychAPI) PaychGetWaitReady(ctx context.Context, sentinel cid.Cid) (address.Address, error)

func (*PaychAPI) PaychList

func (a *PaychAPI) PaychList(ctx context.Context) ([]address.Address, error)

func (*PaychAPI) PaychNewPayment

func (a *PaychAPI) PaychNewPayment(ctx context.Context, from, to address.Address, vouchers []types.VoucherSpec) (*types.PaymentInfo, error)

func (*PaychAPI) PaychSettle

func (a *PaychAPI) PaychSettle(ctx context.Context, addr address.Address) (cid.Cid, error)

func (*PaychAPI) PaychStatus

func (a *PaychAPI) PaychStatus(ctx context.Context, pch address.Address) (*types.Status, error)

func (*PaychAPI) PaychVoucherAdd

func (a *PaychAPI) PaychVoucherAdd(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, proof []byte, minDelta big.Int) (big.Int, error)

func (*PaychAPI) PaychVoucherCheckSpendable

func (a *PaychAPI) PaychVoucherCheckSpendable(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, secret []byte, proof []byte) (bool, error)

func (*PaychAPI) PaychVoucherCheckValid

func (a *PaychAPI) PaychVoucherCheckValid(ctx context.Context, ch address.Address, sv *paych.SignedVoucher) error

func (*PaychAPI) PaychVoucherCreate

func (a *PaychAPI) PaychVoucherCreate(ctx context.Context, pch address.Address, amt big.Int, lane uint64) (*types.VoucherCreateResult, error)

PaychVoucherCreate creates a new signed voucher on the given payment channel with the given lane and amount. The value passed in is exactly the value that will be used to create the voucher, so if previous vouchers exist, the actual additional value of this voucher will only be the difference between the two. If there are insufficient funds in the channel to create the voucher, returns a nil voucher and the shortfall.

func (*PaychAPI) PaychVoucherList

func (a *PaychAPI) PaychVoucherList(ctx context.Context, pch address.Address) ([]*paych.SignedVoucher, error)

func (*PaychAPI) PaychVoucherSubmit

func (a *PaychAPI) PaychVoucherSubmit(ctx context.Context, ch address.Address, sv *paych.SignedVoucher, secret []byte, proof []byte) (cid.Cid, error)

type PaychSubmodule

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

PaychSubmodule support paych related functions, including paych construction, extraction, query and other functions

func NewPaychSubmodule

func NewPaychSubmodule(ctx context.Context, ds datastore.Batching, params *paychmgr.ManagerParams) (*PaychSubmodule, error)

PaychSubmodule enhances the `Node` with paych capabilities.

func (*PaychSubmodule) API

func (ps *PaychSubmodule) API() v1api.IPaychan

API create a new paych implement

func (*PaychSubmodule) Start

func (ps *PaychSubmodule) Start(ctx context.Context) error

func (*PaychSubmodule) Stop

func (ps *PaychSubmodule) Stop()

func (*PaychSubmodule) V0API

func (ps *PaychSubmodule) V0API() v0api.IPaychan