peer

Documentation

Overview

this module handle the peer to peer network

server-side:

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

client-side

* subscriber listens to several broadcasters * connector to retrieve missing data from other listeners

Index

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

Functions

func BlockHeight

func BlockHeight() uint64

return global block height

func ClientCount

func ClientCount() uint64

return connection counts

func FetchConnectors

func FetchConnectors() []*zmqutil.Connected

func FetchSubscribers

func FetchSubscribers() []*zmqutil.Connected

func Finalise

func Finalise() error

finialise - stop all background tasks

func Initialise

func Initialise(configuration *Configuration, version string) error

initialise peer backgrouds processes

func PublicKey

func PublicKey() []byte

return public key

Types

type Announce

type Announce struct {
	Broadcast []string `libucl:"broadcast" json:"broadcast"`
	Listen    []string `libucl:"listen" json:"listen"`
}

for announcements

type Configuration

type Configuration struct {
	DynamicConnections bool         `libucl:"dynamic_connections" json:"dynamic_connections"`
	Broadcast          []string     `libucl:"broadcast" json:"broadcast"`
	Listen             []string     `libucl:"listen" json:"listen"`
	Announce           Announce     `libucl:"announce" json:"announce"`
	PrivateKey         string       `libucl:"private_key" json:"private_key"`
	PublicKey          string       `libucl:"public_key" json:"public_key"`
	Subscribe          []Connection `libucl:"subscribe" json:"subscribe,omitempty"`
	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