peer

Documentation

Overview

Package peer - this module handles the peer to peer network

server-side:

* upstream sending of block, transactions * listener for RPC requests e.g. retrieve old block

client-side

* connector to retrieve missing data from other listeners

Index

• func BlockHeight() uint64
• func FetchConnectors() []*zmqutil.Connected
• func Finalise() error
• func GetCounts() (uint64, uint64)
• func Initialise(configuration *Configuration, version string, fastsync bool) error
• func PublicKey() []byte
• type Configuration
• type Connection

Functions

func BlockHeight

func BlockHeight() uint64

BlockHeight - return global block height

func FetchConnectors

func FetchConnectors() []*zmqutil.Connected

FetchConnectors - obtain a list of all connector clients

func Finalise

func Finalise() error

Finalise - stop all background tasks

func GetCounts

func GetCounts() (uint64, uint64)

GetCounts - return connection counts:

incoming - total peers connectng to all listeners
outgoing - total outgoing connections

func Initialise

func Initialise(configuration *Configuration, version string, fastsync bool) error

Initialise - setup peer background processes

func PublicKey

func PublicKey() []byte

PublicKey - return public key

Types

type Configuration

type Configuration struct {
	DynamicConnections bool         `gluamapper:"dynamic_connections" json:"dynamic_connections"`
	PreferIPv6         bool         `gluamapper:"prefer_ipv6" json:"prefer_ipv6"`
	Listen             []string     `gluamapper:"listen" json:"listen"`
	Announce           []string     `gluamapper:"announce" json:"announce"`
	PrivateKey         string       `gluamapper:"private_key" json:"private_key"`
	PublicKey          string       `gluamapper:"public_key" json:"public_key"`
	Connect            []Connection `gluamapper:"connect" json:"connect,omitempty"`
}

Configuration - a block of configuration data this is read from the configuration file

type Connection

type Connection struct {
	PublicKey string `gluamapper:"public_key" json:"public_key"`
	Address   string `gluamapper:"address" json:"address"`
}

Connection - hardwired connections this is read from the configuration file