common

Documentation

Index

• Constants
• Variables
• type DKGHash
• type Hash32B
• type Node
  • func NewNode(n string, addr string) *Node
  • func NewTCPNode(addr string) *Node
  • func (n *Node) Network() string
  • func (n *Node) String() string
• type PKHash

Constants

const (
	// ProtocolVersion defines Protocol version, starting from 1
	ProtocolVersion = 0x01
	// HashSize defines the size of hash
	HashSize = 32
	// PKHashSize defines the size of public-key hash
	PKHashSize = 20
	// DKGHashSize defines the size of a DKG hash
	DKGHashSize = 20
)

Variables

var (
	// ErrNotImplemented indicates the method is not implemented yet
	ErrNotImplemented = errors.New("not implemented")
)

var MachineEndian = binary.LittleEndian

MachineEndian is the endianess of the machine

var (
	// ZeroHash32B is 32-bytes of all zero
	ZeroHash32B = Hash32B{}
)

Types

type DKGHash

type DKGHash [DKGHashSize]byte

DKGHash is 20-byte hash

type Hash32B

type Hash32B [HashSize]byte

Hash32B is 32-byte hash

type Node

type Node struct {
	NetworkType string
	Addr        string
}

Node is the root struct to embed the newtork identifier

func NewNode

func NewNode(n string, addr string) *Node

NewNode creates an instance of Peer

func NewTCPNode

func NewTCPNode(addr string) *Node

NewTCPNode creates an instance of Peer with tcp transportation

func (*Node) Network

func (n *Node) Network() string

Network returns the transportation layer type (tcp by default)

func (*Node) String

func (n *Node) String() string

String returns the network address (127.0.0.1:0 by default)

type PKHash

type PKHash [PKHashSize]byte

PKHash is 20-byte hash