peering

Documentation

Index

• Constants
• func MultiAddrString(i int, port int) string
• func ShortPeerIDString(id peer.ID) string
• func TestMultiAddrString(peerID peer.ID, port int) string
• type Config
  • func MakeConfigFor(n, hostIdx int) *Config
• type Environment
• type Peer
  • func (p *Peer) HasTxStore() bool
• type Peers
  • func New(env Environment, cfg *Config) (*Peers, error)
  • func NewPeersDummy() *Peers
  • func NewPeersFromConfig(env Environment) (*Peers, error)
  • func (ps *Peers) AddPeer(maddr multiaddr.Multiaddr, name string) error
  • func (ps *Peers) GossipTxBytesToPeers(txBytes []byte, metadata *txmetadata.TransactionMetadata, except ...peer.ID) int
  • func (ps *Peers) NumPeers() (alive, configured int)
  • func (ps *Peers) OnReceivePullRequest(fun func(from peer.ID, txids []ledger.TransactionID))
  • func (ps *Peers) OnReceiveTxBytes(...)
  • func (ps *Peers) PeerIsAlive(id peer.ID) bool
  • func (ps *Peers) PeerName(id peer.ID) string
  • func (ps *Peers) PullTransactionsFromRandomPeer(txids ...ledger.TransactionID) bool
  • func (ps *Peers) Run()
  • func (ps *Peers) SelfID() peer.ID
  • func (ps *Peers) SendTxBytesWithMetadataToPeer(id peer.ID, txBytes []byte, metadata *txmetadata.TransactionMetadata) bool
  • func (ps *Peers) Stop()

Constants

const (
	Name     = "peers"
	TraceTag = Name
)

const (
	MaxNumTransactionID = (MaxPayloadSize - 2) / ledger.TransactionIDLength

	PullRequestTransactions = byte(iota)
	PullRequestBranchTips
)

const BeginPort = 4000

const (
	MaxPayloadSize = math.MaxUint16 - 4
)

MaxPayloadSize caps the message size. It includes 4 bytes of the size

Functions

func MultiAddrString

func MultiAddrString(i int, port int) string

func ShortPeerIDString

func ShortPeerIDString(id peer.ID) string

func TestMultiAddrString

func TestMultiAddrString(peerID peer.ID, port int) string

Types

type Config

type Config struct {
	HostIDPrivateKey ed25519.PrivateKey
	HostID           peer.ID
	HostPort         int
	KnownPeers       map[string]multiaddr.Multiaddr // name -> PeerAddr
}

func MakeConfigFor

func MakeConfigFor(n, hostIdx int) *Config

type Environment

type Environment interface {
	global.NodeGlobal
}

type Peer

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

func (*Peer) HasTxStore

func (p *Peer) HasTxStore() bool

type Peers

type Peers struct {
	Environment
	// contains filtered or unexported fields
}

func New

func New(env Environment, cfg *Config) (*Peers, error)

func NewPeersDummy

func NewPeersDummy() *Peers

func NewPeersFromConfig

func NewPeersFromConfig(env Environment) (*Peers, error)

func (*Peers) AddPeer

func (ps *Peers) AddPeer(maddr multiaddr.Multiaddr, name string) error

func (*Peers) GossipTxBytesToPeers

func (ps *Peers) GossipTxBytesToPeers(txBytes []byte, metadata *txmetadata.TransactionMetadata, except ...peer.ID) int

func (*Peers) NumPeers

func (ps *Peers) NumPeers() (alive, configured int)

func (*Peers) OnReceivePullRequest

func (ps *Peers) OnReceivePullRequest(fun func(from peer.ID, txids []ledger.TransactionID))

func (*Peers) OnReceiveTxBytes

func (ps *Peers) OnReceiveTxBytes(fun func(from peer.ID, txBytes []byte, metadata *txmetadata.TransactionMetadata))

func (*Peers) PeerIsAlive

func (ps *Peers) PeerIsAlive(id peer.ID) bool

func (*Peers) PeerName

func (ps *Peers) PeerName(id peer.ID) string

func (*Peers) PullTransactionsFromRandomPeer

func (ps *Peers) PullTransactionsFromRandomPeer(txids ...ledger.TransactionID) bool

PullTransactionsFromRandomPeer sends pull request to the random peer which has txStore

func (*Peers) Run

func (ps *Peers) Run()

func (*Peers) SelfID

func (ps *Peers) SelfID() peer.ID

func (*Peers) SendTxBytesWithMetadataToPeer

func (ps *Peers) SendTxBytesWithMetadataToPeer(id peer.ID, txBytes []byte, metadata *txmetadata.TransactionMetadata) bool

func (*Peers) Stop

func (ps *Peers) Stop()