pseudosettle

Documentation

Overview

Package pseudosettle implements a pretend settlement protocol where nodes send pretend payment messages consisting only of the payment amount. Its purpose is to be able to have the full payment / disconnect treshold machinery in place without having to send cheques or real values.

Index

• Variables
• type Service
  • func New(streamer p2p.Streamer, logger logging.Logger, store storage.StateStorer) *Service
  • func (s *Service) Metrics() []prometheus.Collector
  • func (s *Service) Pay(ctx context.Context, peer swarm.Address, amount uint64) error
  • func (s *Service) Protocol() p2p.ProtocolSpec
  • func (s *Service) SetNotifyPaymentFunc(notifyPaymentFunc settlement.NotifyPaymentFunc)
  • func (s *Service) SettlementsReceived() (map[string]uint64, error)
  • func (s *Service) SettlementsSent() (map[string]uint64, error)
  • func (s *Service) TotalReceived(peer swarm.Address) (totalReceived uint64, err error)
  • func (s *Service) TotalSent(peer swarm.Address) (totalSent uint64, err error)

Variables

var (
	SettlementReceivedPrefix = "pseudosettle_total_received_"
	SettlementSentPrefix     = "pseudosettle_total_sent_"
)

Types

type Service

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

func New

func New(streamer p2p.Streamer, logger logging.Logger, store storage.StateStorer) *Service

func (*Service) Metrics

func (s *Service) Metrics() []prometheus.Collector

func (*Service) Pay

func (s *Service) Pay(ctx context.Context, peer swarm.Address, amount uint64) error

Pay initiates a payment to the given peer

func (*Service) Protocol

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

func (*Service) SetNotifyPaymentFunc

func (s *Service) SetNotifyPaymentFunc(notifyPaymentFunc settlement.NotifyPaymentFunc)

SetNotifyPaymentFunc sets the NotifyPaymentFunc to notify

func (*Service) SettlementsReceived

func (s *Service) SettlementsReceived() (map[string]uint64, error)

func (*Service) SettlementsSent

func (s *Service) SettlementsSent() (map[string]uint64, error)

AllSettlements returns all stored settlement values for a given type of prefix (sent or received)

func (*Service) TotalReceived

func (s *Service) TotalReceived(peer swarm.Address) (totalReceived uint64, err error)

TotalReceived returns the total amount received from a peer

func (*Service) TotalSent

func (s *Service) TotalSent(peer swarm.Address) (totalSent uint64, err error)

TotalSent returns the total amount sent to a peer