peer

Documentation

Overview

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) error
• func PublicKey() []byte
• type Configuration
• type Connection
• type PublishConfiguration

Functions

func BlockHeight

func BlockHeight() uint64

return global block height

func FetchConnectors

func FetchConnectors() []*zmqutil.Connected

func Finalise

func Finalise() error

finialise - stop all background tasks

func GetCounts

func GetCounts() (uint64, uint64)

return connection counts:

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

func Initialise

func Initialise(configuration *Configuration, version string) error

initialise peer backgrouds processes

func PublicKey

func PublicKey() []byte

return public key

Types

type Configuration

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

a block of configuration data this is read from a libucl configuration file

type Connection

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

hardwired connections this is read from a libucl configuration file

type PublishConfiguration

type PublishConfiguration struct {
	Broadcast  []string `libucl:"broadcast" json:"broadcast"`
	PrivateKey string   `libucl:"private_key" json:"private_key"`
	PublicKey  string   `libucl:"public_key" json:"public_key"`
}