pricing

Documentation

Index

• Variables
• type Interface
• type PaymentThresholdObserver
• type PriceTableObserver
• type Service
  • func New(streamer p2p.Streamer, logger logging.Logger, paymentThreshold *big.Int, ...) *Service
  • func (s *Service) AnnouncePaymentThreshold(ctx context.Context, peer swarm.Address, paymentThreshold *big.Int) error
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) SetPaymentThresholdObserver(observer PaymentThresholdObserver)

Variables

var (
	// ErrThresholdTooLow says that the proposed payment threshold is too low for even a single reserve.
	ErrThresholdTooLow = errors.New("threshold too low")
)

Types

type Interface

type Interface interface {
	AnnouncePaymentThreshold(ctx context.Context, peer swarm.Address, paymentThreshold *big.Int) error
}

Interface is the main interface of the pricing protocol

type PaymentThresholdObserver

type PaymentThresholdObserver interface {
	NotifyPaymentThreshold(peer swarm.Address, paymentThreshold *big.Int) error
}

PaymentThresholdObserver is used for being notified of payment threshold updates

type PriceTableObserver

type PriceTableObserver interface {
	NotifyPriceTable(peer swarm.Address, priceTable []uint64) error
}

PriceTableObserver is used for being notified of price table updates

type Service

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

func New

func New(streamer p2p.Streamer, logger logging.Logger, paymentThreshold *big.Int, minThreshold *big.Int) *Service

func (*Service) AnnouncePaymentThreshold

func (s *Service) AnnouncePaymentThreshold(ctx context.Context, peer swarm.Address, paymentThreshold *big.Int) error

AnnouncePaymentThreshold announces the payment threshold to per

func (*Service) Protocol

func (s *Service) Protocol() p2p.ProtocolSpec

func (*Service) SetPaymentThresholdObserver

func (s *Service) SetPaymentThresholdObserver(observer PaymentThresholdObserver)

SetPaymentThresholdObserver sets the PaymentThresholdObserver to be used when receiving a new payment threshold