accounting

Documentation

Overview

Package accounting provides functionalities needed to do per-peer accounting.

Index

• Variables
• type Accounting
  • func NewAccounting(PaymentThreshold, PaymentTolerance, EarlyPayment *big.Int, ...) (*Accounting, error)
  • func (a *Accounting) Balance(peer swarm.Address) (balance *big.Int, err error)
  • func (a *Accounting) Balances() (map[string]*big.Int, error)
  • func (a *Accounting) CompensatedBalance(peer swarm.Address) (compensated *big.Int, err error)
  • func (a *Accounting) CompensatedBalances() (map[string]*big.Int, error)
  • func (a *Accounting) Credit(peer swarm.Address, price uint64) error
  • func (a *Accounting) Metrics() []prometheus.Collector
  • func (a *Accounting) NotifyPaymentReceived(peer swarm.Address, amount *big.Int) error
  • func (a *Accounting) NotifyPaymentSent(peer swarm.Address, amount *big.Int, receivedError error)
  • func (a *Accounting) NotifyPaymentThreshold(peer swarm.Address, paymentThreshold *big.Int) error
  • func (a *Accounting) NotifyRefreshmentReceived(peer swarm.Address, amount *big.Int) error
  • func (a *Accounting) PeerDebt(peer swarm.Address) (*big.Int, error)
  • func (a *Accounting) PrepareDebit(peer swarm.Address, price uint64) Action
  • func (a *Accounting) Release(peer swarm.Address, price uint64)
  • func (a *Accounting) Reserve(ctx context.Context, peer swarm.Address, price uint64) error
  • func (a *Accounting) SetPayFunc(f PayFunc)
  • func (a *Accounting) SetRefreshFunc(f RefreshFunc)
  • func (a *Accounting) SurplusBalance(peer swarm.Address) (balance *big.Int, err error)
• type Action
• type Interface
• type PayFunc
• type RefreshFunc

Variables

var (
	// ErrOverdraft denotes the expected debt in Reserve would exceed the payment thresholds.
	ErrOverdraft = errors.New("attempted overdraft")
	// ErrDisconnectThresholdExceeded denotes a peer has exceeded the disconnect threshold.
	ErrDisconnectThresholdExceeded = errors.New("disconnect threshold exceeded")
	// ErrPeerNoBalance is the error returned if no balance in store exists for a peer
	ErrPeerNoBalance = errors.New("no balance for peer")
	// ErrInvalidValue denotes an invalid value read from store
	ErrInvalidValue = errors.New("invalid value")
)

Types

type Accounting

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

Accounting is the main implementation of the accounting interface.

func NewAccounting

func NewAccounting(
	PaymentThreshold,
	PaymentTolerance,
	EarlyPayment *big.Int,
	Logger logging.Logger,
	Store storage.StateStorer,
	Pricing pricing.Interface,
	refreshRate *big.Int,
) (*Accounting, error)

NewAccounting creates a new Accounting instance with the provided options.

func (*Accounting) Balance

func (a *Accounting) Balance(peer swarm.Address) (balance *big.Int, err error)

Balance returns the current balance for the given peer.

func (*Accounting) Balances

func (a *Accounting) Balances() (map[string]*big.Int, error)

Balances gets balances for all peers from store.

func (*Accounting) CompensatedBalance

func (a *Accounting) CompensatedBalance(peer swarm.Address) (compensated *big.Int, err error)

CompensatedBalance returns balance decreased by surplus balance

func (*Accounting) CompensatedBalances

func (a *Accounting) CompensatedBalances() (map[string]*big.Int, error)

Balances gets balances for all peers from store.

func (*Accounting) Credit

func (a *Accounting) Credit(peer swarm.Address, price uint64) error

Credit increases the amount of credit we have with the given peer (and decreases existing debt).

func (*Accounting) Metrics

func (a *Accounting) Metrics() []prometheus.Collector

Metrics returns the prometheus Collector for the accounting service.

func (*Accounting) NotifyPaymentReceived

func (a *Accounting) NotifyPaymentReceived(peer swarm.Address, amount *big.Int) error

NotifyPayment is called by Settlement when we receive a payment.

func (*Accounting) NotifyPaymentSent

func (a *Accounting) NotifyPaymentSent(peer swarm.Address, amount *big.Int, receivedError error)

NotifyPaymentSent is triggered by async monetary settlement to update our balance and remove it's price from the shadow reserve

func (*Accounting) NotifyPaymentThreshold

func (a *Accounting) NotifyPaymentThreshold(peer swarm.Address, paymentThreshold *big.Int) error

NotifyPaymentThreshold should be called to notify accounting of changes in the payment threshold

func (*Accounting) NotifyRefreshmentReceived

func (a *Accounting) NotifyRefreshmentReceived(peer swarm.Address, amount *big.Int) error

NotifyRefreshmentReceived is called by pseudosettle when we receive a time based settlement.

func (*Accounting) PeerDebt

func (a *Accounting) PeerDebt(peer swarm.Address) (*big.Int, error)

PeerDebt returns the positive part of the sum of the outstanding balance and the shadow reserve

func (*Accounting) PrepareDebit

func (a *Accounting) PrepareDebit(peer swarm.Address, price uint64) Action

PrepareDebit prepares a debit operation by increasing the shadowReservedBalance

func (*Accounting) Release

func (a *Accounting) Release(peer swarm.Address, price uint64)

Release releases reserved funds.

func (*Accounting) Reserve

func (a *Accounting) Reserve(ctx context.Context, peer swarm.Address, price uint64) error

Reserve reserves a portion of the balance for peer and attempts settlements if necessary.

func (*Accounting) SetPayFunc

func (a *Accounting) SetPayFunc(f PayFunc)

func (*Accounting) SetRefreshFunc

func (a *Accounting) SetRefreshFunc(f RefreshFunc)

func (*Accounting) SurplusBalance

func (a *Accounting) SurplusBalance(peer swarm.Address) (balance *big.Int, err error)

SurplusBalance returns the current balance for the given peer.

type Action

type Action interface {
	// Cleanup cleans up an action. Must be called wether it was applied or not.
	Cleanup()
	// Apply applies an action
	Apply() error
}

Action represents an accounting action that can be applied

type Interface

type Interface interface {
	// Reserve reserves a portion of the balance for peer and attempts settlements if necessary.
	// Returns an error if the operation risks exceeding the disconnect threshold or an attempted settlement failed.
	//
	// This has to be called (always in combination with Release) before a
	// Credit action to prevent overspending in case of concurrent requests.
	Reserve(ctx context.Context, peer swarm.Address, price uint64) error
	// Release releases the reserved funds.
	Release(peer swarm.Address, price uint64)
	// Credit increases the balance the peer has with us (we "pay" the peer).
	Credit(peer swarm.Address, price uint64) error
	// PrepareDebit returns an accounting Action for the later debit to be executed on and to implement shadowing a possibly credited part of reserve on the other side.
	PrepareDebit(peer swarm.Address, price uint64) Action
	// Balance returns the current balance for the given peer.
	Balance(peer swarm.Address) (*big.Int, error)
	// SurplusBalance returns the current surplus balance for the given peer.
	SurplusBalance(peer swarm.Address) (*big.Int, error)
	// Balances returns balances for all known peers.
	Balances() (map[string]*big.Int, error)
	// CompensatedBalance returns the current balance deducted by current surplus balance for the given peer.
	CompensatedBalance(peer swarm.Address) (*big.Int, error)
	// CompensatedBalances returns the compensated balances for all known peers.
	CompensatedBalances() (map[string]*big.Int, error)
}

Interface is the Accounting interface.

type PayFunc

type PayFunc func(context.Context, swarm.Address, *big.Int)

PayFunc is the function used for async monetary settlement

type RefreshFunc

type RefreshFunc func(context.Context, swarm.Address, *big.Int, *big.Int) (*big.Int, int64, error)

RefreshFunc is the function used for sync time-based settlement