payments

type AvailableFunds struct {
	// Channel is the address of the channel
	Channel *address.Address
	// From is the from address of the channel (channel creator)
	From address.Address
	// To is the to address of the channel
	To address.Address
	// ConfirmedAmt is the amount of funds that have been confirmed on-chain
	// for the channel
	ConfirmedAmt filecoin.BigInt
	// PendingAmt is the amount of funds that are pending confirmation on-chain
	PendingAmt filecoin.BigInt
	// PendingWaitSentinel can be used with PaychGetWaitReady to wait for
	// confirmation of pending funds
	PendingWaitSentinel *cid.Cid
	// QueuedAmt is the amount that is queued up behind a pending request
	QueuedAmt filecoin.BigInt
	// VoucherRedeemedAmt is the amount that is redeemed by vouchers on-chain
	// and in the local datastore
	VoucherRedeemedAmt filecoin.BigInt
}

type ChannelInfo struct {
	// ChannelID is a uuid set at channel creation
	ChannelID string
	// Channel address - may be nil if the channel hasn't been created yet
	Channel *address.Address
	// Control is the address of the local node
	Control address.Address
	// Target is the address of the remote node (on the other end of the channel)
	Target address.Address
	// Direction indicates if the channel is inbound (Control is the "to" address)
	// or outbound (Control is the "from" address)
	Direction uint64
	// Vouchers is a list of all vouchers sent on the channel
	Vouchers []*VoucherInfo
	// NextLane is the number of the next lane that should be used when the
	// client requests a new lane (eg to create a voucher for a new deal)
	NextLane uint64
	// Amount added to the channel.
	// Note: This amount is only used by GetPaych to keep track of how much
	// has locally been added to the channel. It should reflect the channel's
	// Balance on chain as long as all operations occur on the same datastore.
	Amount fil.BigInt
	// PendingAmount is the amount that we're awaiting confirmation of
	PendingAmount fil.BigInt
	// CreateMsg is the CID of a pending create message (while waiting for confirmation)
	CreateMsg *cid.Cid
	// AddFundsMsg is the CID of a pending add funds message (while waiting for confirmation)
	AddFundsMsg *cid.Cid
	// Settling indicates whether the channel has entered into the settling state
	Settling bool
	// SettlingAt is the height at which the channel can be 'collected'
	SettlingAt abi.ChainEpoch
}

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

type ChannelState interface {
	cbortypes.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
}

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

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

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

type Manager interface {
	GetChannel(ctx context.Context, from, to address.Address, amt filecoin.BigInt) (*ChannelResponse, error)
	TrackChannel(ctx context.Context, chAddr address.Address) (*ChannelInfo, error)
	WaitForChannel(context.Context, cid.Cid) (address.Address, error)
	ListChannels() ([]address.Address, error)
	ListVouchers(context.Context, address.Address) ([]*VoucherInfo, error)
	GetChannelInfo(address.Address) (*ChannelInfo, error)
	CreateVoucher(context.Context, address.Address, filecoin.BigInt, uint64) (*VoucherCreateResult, error)
	AllocateLane(context.Context, address.Address) (uint64, error)
	AddVoucherInbound(context.Context, address.Address, *paych.SignedVoucher, []byte, filecoin.BigInt) (filecoin.BigInt, error)
	ChannelAvailableFunds(address.Address) (*AvailableFunds, error)
	SubmitAllVouchers(context.Context, address.Address) error
	SubmitVoucherForLane(context.Context, address.Address, uint64) error
	Settle(context.Context, address.Address) (abi.ChainEpoch, error)
	Collect(context.Context, address.Address) error
	StartAutoCollect(context.Context) error
}

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

type MsgInfo struct {
	// ChannelID links the message to a channel
	ChannelID string
	// MsgCid is the CID of the message
	MsgCid cid.Cid
	// Received indicates whether a response has been received
	Received bool
	// Err is the error received in the response
	Err string
}

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

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

type VoucherCreateResult struct {
	// Voucher that was created, or nil if there was an error or if there
	// were insufficient funds in the channel
	Voucher *paych.SignedVoucher
	// Shortfall is the additional amount that would be needed in the channel
	// in order to be able to create the voucher
	Shortfall filecoin.BigInt
}

type VoucherInfo struct {
	Voucher   *paych.SignedVoucher
	Proof     []byte
	Submitted bool
}