paych

Documentation

Index

• Constants
• Variables
• type ChannelInfo
  • func (t *ChannelInfo) MarshalCBOR(w io.Writer) error
  • func (t *ChannelInfo) UnmarshalCBOR(r io.Reader) error
• type Manager
  • func NewManager(sm *stmgr.StateManager, pchstore *Store, api ManagerApi) *Manager
  • func (pm *Manager) AddVoucher(ctx context.Context, ch address.Address, sv *types.SignedVoucher, proof []byte, ...) (types.BigInt, error)
  • func (pm *Manager) AllocateLane(ch address.Address) (uint64, error)
  • func (pm *Manager) CheckVoucherSpendable(ctx context.Context, ch address.Address, sv *types.SignedVoucher, ...) (bool, error)
  • func (pm *Manager) CheckVoucherValid(ctx context.Context, ch address.Address, sv *types.SignedVoucher) error
  • func (pm *Manager) GetChannelInfo(addr address.Address) (*ChannelInfo, error)
  • func (pm *Manager) GetPaych(ctx context.Context, from, to address.Address, ensureFree types.BigInt) (address.Address, cid.Cid, error)
  • func (pm *Manager) ListChannels() ([]address.Address, error)
  • func (pm *Manager) ListVouchers(ctx context.Context, ch address.Address) ([]*VoucherInfo, error)
  • func (pm *Manager) NextNonceForLane(ctx context.Context, ch address.Address, lane uint64) (uint64, error)
  • func (pm *Manager) OutboundChanTo(from, to address.Address) (address.Address, error)
  • func (pm *Manager) TrackInboundChannel(ctx context.Context, ch address.Address) error
  • func (pm *Manager) TrackOutboundChannel(ctx context.Context, ch address.Address) error
• type ManagerApi
• type Store
  • func NewStore(ds dtypes.MetadataDS) *Store
  • func (ps *Store) AllocateLane(ch address.Address) (uint64, error)
  • func (ps *Store) ListChannels() ([]address.Address, error)
  • func (ps *Store) TrackChannel(ch *ChannelInfo) error
  • func (ps *Store) VouchersForPaych(ch address.Address) ([]*VoucherInfo, error)
• type VoucherInfo
  • func (t *VoucherInfo) MarshalCBOR(w io.Writer) error
  • func (t *VoucherInfo) UnmarshalCBOR(r io.Reader) error

Constants

const (
	DirInbound  = 1
	DirOutbound = 2
)

Variables

var ErrChannelNotTracked = errors.New("channel not tracked")

Types

type ChannelInfo

type ChannelInfo struct {
	Channel address.Address
	Control address.Address
	Target  address.Address

	Direction uint64
	Vouchers  []*VoucherInfo
	NextLane  uint64
}

func (*ChannelInfo) MarshalCBOR

func (t *ChannelInfo) MarshalCBOR(w io.Writer) error

func (*ChannelInfo) UnmarshalCBOR

func (t *ChannelInfo) UnmarshalCBOR(r io.Reader) error

type Manager

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

func NewManager

func NewManager(sm *stmgr.StateManager, pchstore *Store, api ManagerApi) *Manager

func (*Manager) AddVoucher

func (pm *Manager) AddVoucher(ctx context.Context, ch address.Address, sv *types.SignedVoucher, proof []byte, minDelta types.BigInt) (types.BigInt, error)

func (*Manager) AllocateLane

func (pm *Manager) AllocateLane(ch address.Address) (uint64, error)

func (*Manager) CheckVoucherSpendable

func (pm *Manager) CheckVoucherSpendable(ctx context.Context, ch address.Address, sv *types.SignedVoucher, secret []byte, proof []byte) (bool, error)

checks if the given voucher is currently spendable

func (*Manager) CheckVoucherValid

func (pm *Manager) CheckVoucherValid(ctx context.Context, ch address.Address, sv *types.SignedVoucher) error

checks if the given voucher is valid (is or could become spendable at some point)

func (*Manager) GetChannelInfo

func (pm *Manager) GetChannelInfo(addr address.Address) (*ChannelInfo, error)

func (*Manager) GetPaych

func (pm *Manager) GetPaych(ctx context.Context, from, to address.Address, ensureFree types.BigInt) (address.Address, cid.Cid, error)

func (*Manager) ListChannels

func (pm *Manager) ListChannels() ([]address.Address, error)

func (*Manager) ListVouchers

func (pm *Manager) ListVouchers(ctx context.Context, ch address.Address) ([]*VoucherInfo, error)

func (*Manager) NextNonceForLane

func (pm *Manager) NextNonceForLane(ctx context.Context, ch address.Address, lane uint64) (uint64, error)

func (*Manager) OutboundChanTo

func (pm *Manager) OutboundChanTo(from, to address.Address) (address.Address, error)

func (*Manager) TrackInboundChannel

func (pm *Manager) TrackInboundChannel(ctx context.Context, ch address.Address) error

func (*Manager) TrackOutboundChannel

func (pm *Manager) TrackOutboundChannel(ctx context.Context, ch address.Address) error

type ManagerApi

type ManagerApi struct {
	fx.In

	full.MpoolAPI
	full.WalletAPI
	full.StateAPI
}

type Store

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

func NewStore

func NewStore(ds dtypes.MetadataDS) *Store

func (*Store) AllocateLane

func (ps *Store) AllocateLane(ch address.Address) (uint64, error)

func (*Store) ListChannels

func (ps *Store) ListChannels() ([]address.Address, error)

func (*Store) TrackChannel

func (ps *Store) TrackChannel(ch *ChannelInfo) error

func (*Store) VouchersForPaych

func (ps *Store) VouchersForPaych(ch address.Address) ([]*VoucherInfo, error)

type VoucherInfo

type VoucherInfo struct {
	Voucher *types.SignedVoucher
	Proof   []byte
}

func (*VoucherInfo) MarshalCBOR

func (t *VoucherInfo) MarshalCBOR(w io.Writer) error

func (*VoucherInfo) UnmarshalCBOR

func (t *VoucherInfo) UnmarshalCBOR(r io.Reader) error