Documentation
¶
Index ¶
- type PaychAPI
- func (a *PaychAPI) PaychAllocateLane(ctx context.Context, ch address.Address) (uint64, error)
- func (a *PaychAPI) PaychAvailableFunds(ctx context.Context, ch address.Address) (*api.ChannelAvailableFunds, error)
- func (a *PaychAPI) PaychAvailableFundsByFromTo(ctx context.Context, from, to address.Address) (*api.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) (*api.ChannelInfo, error)
- func (a *PaychAPI) PaychGet(ctx context.Context, from, to address.Address, amt types.BigInt, ...) (*api.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 []api.VoucherSpec) (*api.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) (*api.PaychStatus, error)
- func (a *PaychAPI) PaychVoucherAdd(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher, ...) (types.BigInt, error)
- func (a *PaychAPI) PaychVoucherCheckSpendable(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher, ...) (bool, error)
- func (a *PaychAPI) PaychVoucherCheckValid(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher) error
- func (a *PaychAPI) PaychVoucherCreate(ctx context.Context, pch address.Address, amt types.BigInt, lane uint64) (*api.VoucherCreateResult, error)
- func (a *PaychAPI) PaychVoucherList(ctx context.Context, pch address.Address) ([]*paychtypes.SignedVoucher, error)
- func (a *PaychAPI) PaychVoucherSubmit(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher, ...) (cid.Cid, error)
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type PaychAPI ¶
func (*PaychAPI) PaychAllocateLane ¶
func (*PaychAPI) PaychAvailableFunds ¶
func (*PaychAPI) PaychAvailableFundsByFromTo ¶
func (*PaychAPI) PaychCollect ¶
func (*PaychAPI) PaychGet ¶
func (a *PaychAPI) PaychGet(ctx context.Context, from, to address.Address, amt types.BigInt, opts api.PaychGetOpts) (*api.ChannelInfo, error)
func (*PaychAPI) PaychGetWaitReady ¶
func (*PaychAPI) PaychNewPayment ¶
func (a *PaychAPI) PaychNewPayment(ctx context.Context, from, to address.Address, vouchers []api.VoucherSpec) (*api.PaymentInfo, error)
func (*PaychAPI) PaychSettle ¶
func (*PaychAPI) PaychStatus ¶
func (*PaychAPI) PaychVoucherAdd ¶
func (*PaychAPI) PaychVoucherCheckSpendable ¶
func (a *PaychAPI) PaychVoucherCheckSpendable(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher, secret []byte, proof []byte) (bool, error)
func (*PaychAPI) PaychVoucherCheckValid ¶
func (a *PaychAPI) PaychVoucherCheckValid(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher) error
func (*PaychAPI) PaychVoucherCreate ¶
func (a *PaychAPI) PaychVoucherCreate(ctx context.Context, pch address.Address, amt types.BigInt, lane uint64) (*api.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) ([]*paychtypes.SignedVoucher, error)
func (*PaychAPI) PaychVoucherSubmit ¶
func (a *PaychAPI) PaychVoucherSubmit(ctx context.Context, ch address.Address, sv *paychtypes.SignedVoucher, secret []byte, proof []byte) (cid.Cid, error)
Source Files
Click to show internal directories.
Click to hide internal directories.