settlement

Documentation

Index

• Variables
• type Interface
• type NotifyPaymentFunc

Variables

var (
	ErrPeerNoSettlements = errors.New("no settlements for peer")
)

Types

type Interface

type Interface interface {
	// Pay initiates a payment to the given peer
	// It should return without error it is likely that the payment worked
	Pay(ctx context.Context, peer swarm.Address, amount uint64) error
	// TotalSent returns the total amount sent to a peer
	TotalSent(peer swarm.Address) (totalSent uint64, err error)
	// TotalReceived returns the total amount received from a peer
	TotalReceived(peer swarm.Address) (totalSent uint64, err error)
	// SettlementsSent returns sent settlements for each individual known peer
	SettlementsSent() (map[string]uint64, error)
	// SettlementsReceived returns received settlements for each individual known peer
	SettlementsReceived() (map[string]uint64, error)
	// SetNotifyPaymentFunc sets the NotifyPaymentFunc to notify
	SetNotifyPaymentFunc(notifyPaymentFunc NotifyPaymentFunc)
}

Interface is the interface used by Accounting to trigger settlement

type NotifyPaymentFunc

type NotifyPaymentFunc func(peer swarm.Address, amount uint64) error

NotifyPaymentFunc is called when a payment from peer was successfully received