announce

Documentation

Overview

Package announce - network announcements

The DNS TXT record format is a set of space separated key=value pairs

Key      Value
=======  =========
bitmark  v3
a        Public IP addresses as IPv4;[IPv6]
c        Peer-To-Peer port number (decimal)
r        RPC port number (decimal)
f        SHA3 fingerprint of the certificate used by RPC connection for TLS verification (hex)
p        Public key of the P2P connection for ZeroMQ encryption (hex)

Index

• Constants
• func AddPeer(publicKey []byte, listeners []byte, timestamp uint64) bool
• func AddRPC(fingerprint []byte, rpcs []byte, timestamp uint64) bool
• func Finalise() error
• func GetNext(publicKey []byte) ([]byte, []byte, time.Time, error)
• func GetRandom(publicKey []byte) ([]byte, []byte, time.Time, error)
• func Initialise(nodesDomain, peerFile string) error
• func SendRegistration(client zmqutil.Client, fn string) error
• func SetPeer(publicKey []byte, listeners []byte) error
• func SetRPC(fingerprint fingerprintType, rpcs []byte) error
• type PeerItem
  • func NewPeerItem(peer *peerEntry) *PeerItem
  • func (item PeerItem) MarshalText() ([]byte, error)
  • func (item *PeerItem) UnmarshalText(data []byte) error
• type PeerList
• type RPCEntry
  • func FetchRPCs(start uint64, count int) ([]RPCEntry, uint64, error)

Constants

const (
	TypeRPC  = iota
	TypePeer = iota
)

type of listener

Functions

func AddPeer

func AddPeer(publicKey []byte, listeners []byte, timestamp uint64) bool

AddPeer - add a peer announcement to the in-memory tree returns:

true  if this was a new/updated entry
false if the update was within the limits (to prevent continuous relaying)

func AddRPC

func AddRPC(fingerprint []byte, rpcs []byte, timestamp uint64) bool

AddRPC - add an remote RPC listener returns:

true  if this was a new/updated entry
false if the update was within the limits (to prevent continuous relaying)

func Finalise

func Finalise() error

Finalise - stop all background tasks

func GetNext

func GetNext(publicKey []byte) ([]byte, []byte, time.Time, error)

GetNext - fetch the data for the next node in the ring for a given public key

func GetRandom

func GetRandom(publicKey []byte) ([]byte, []byte, time.Time, error)

GetRandom - fetch the data for a random node in the ring not matching a given public key

func Initialise

func Initialise(nodesDomain, peerFile string) error

Initialise - set up the announcement system pass a fully qualified domain for root node list or empty string for no root nodes

func SendRegistration

func SendRegistration(client zmqutil.Client, fn string) error

SendRegistration - send a peer registration request to a client channel

func SetPeer

func SetPeer(publicKey []byte, listeners []byte) error

SetPeer - called by the peering initialisation to set up this node's announcement data

func SetRPC

func SetRPC(fingerprint fingerprintType, rpcs []byte) error

SetRPC - set this node's rpc announcement data

Types

type PeerItem

type PeerItem struct {
	PublicKey []byte
	Listeners []byte
	Timestamp uint64
}

PeerItem is the basic structure for backup and restore peers

func NewPeerItem

func NewPeerItem(peer *peerEntry) *PeerItem

NewPeerItem is to create a PeerItem from peerEntry

func (PeerItem) MarshalText

func (item PeerItem) MarshalText() ([]byte, error)

MarshalText is the json marshal function for PeerItem

func (*PeerItem) UnmarshalText

func (item *PeerItem) UnmarshalText(data []byte) error

UnmarshalText is the json unmarshal function for PeerItem

type PeerList

type PeerList []PeerItem

PeerList is a list of PeerItem

type RPCEntry

type RPCEntry struct {
	Fingerprint fingerprintType    `json:"fingerprint"`
	Connections []*util.Connection `json:"connections"`
}

RPCEntry type of returned data

func FetchRPCs

func FetchRPCs(start uint64, count int) ([]RPCEntry, uint64, error)

FetchRPCs - fetch some records