filecoinretrieval

Documentation

Index

• type Event
• type FilecoinExchange
  • func NewFilecoinExchange(node PaymentAPI, h host.Host, dataTransfer datatransfer.Manager) *FilecoinExchange
  • func (fe *FilecoinExchange) Close()
  • func (fe *FilecoinExchange) Code() multicodec.Code
  • func (fe *FilecoinExchange) RequestData(ctx context.Context, root ipld.Link, selector ipld.Node, ...) <-chan exchange.EventData
• type PaymentAPI
• type State
• type VoucherCreateResult

Types

type Event

type Event datatransfer.Event

type FilecoinExchange

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

func NewFilecoinExchange

func NewFilecoinExchange(node PaymentAPI, h host.Host, dataTransfer datatransfer.Manager) *FilecoinExchange

func (*FilecoinExchange) Close

func (fe *FilecoinExchange) Close()

cancel subscription to data transfer.

func (*FilecoinExchange) Code

func (fe *FilecoinExchange) Code() multicodec.Code

func (*FilecoinExchange) RequestData

func (fe *FilecoinExchange) RequestData(ctx context.Context, root ipld.Link, selector ipld.Node, routingProvider interface{}, routingPayload interface{}) <-chan exchange.EventData

type PaymentAPI

type PaymentAPI interface {
	GetPaychWithMinFunds(ctx context.Context, dest address.Address) (address.Address, error)
	AllocateLane(ctx context.Context, payCh address.Address) (uint64, error)
	CreateVoucher(ctx context.Context, payCh address.Address, vouch paych.SignedVoucher) (*VoucherCreateResult, error)
}

type State

type State datatransfer.ChannelState

type VoucherCreateResult

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 big.Int
}