records

Documentation

Index

• Constants
• func CreateLocalNode(privKey *ecdsa.PrivateKey, storagePath string, ipAddr net.IP, ...) (*enode.LocalNode, error)
• func DiffSubnets(a, b []byte) map[int]byte
• func GetForkVersionEntry(record *enr.Record) (forksprotocol.ForkVersion, error)
• func GetSubnetsEntry(record *enr.Record) ([]byte, error)
• func SetForkVersionEntry(node *enode.LocalNode, forkv string) error
• func SetSubnetsEntry(node *enode.LocalNode, subnets []byte) error
• func SharedSubnets(a, b []byte, maxLen int) []int
• func UpdateSubnets(node *enode.LocalNode, count int, added []int, removed []int) ([]byte, error)
• type ForkVersionEntry
  • func (fv *ForkVersionEntry) DecodeRLP(s *rlp.Stream) error
  • func (fv ForkVersionEntry) ENRKey() string
  • func (fv ForkVersionEntry) EncodeRLP(w io.Writer) error
• type NodeInfo
  • func NewNodeInfo(forkVersion forksprotocol.ForkVersion, networkID string) *NodeInfo
  • func (ni *NodeInfo) Codec() []byte
  • func (ni *NodeInfo) Consume(data []byte) error
  • func (ni *NodeInfo) Domain() string
  • func (ni *NodeInfo) MarshalRecord() ([]byte, error)
  • func (ni *NodeInfo) Seal(privateKey crypto.PrivKey) ([]byte, error)
  • func (ni *NodeInfo) UnmarshalRecord(data []byte) error
• type NodeMetadata
  • func (nm *NodeMetadata) Decode(data []byte) error
  • func (nm *NodeMetadata) Encode() ([]byte, error)
• type Subnets
  • func (s Subnets) Clone() Subnets
  • func (s Subnets) FromString(subnetsStr string) (Subnets, error)
  • func (s Subnets) String() string

Constants

const (
	// ZeroSubnets is the representation of no subnets
	ZeroSubnets = "00000000000000000000000000000000"
	// AllSubnets is the representation of all subnets
	AllSubnets = "ffffffffffffffffffffffffffffffff"
)

Functions

func CreateLocalNode

func CreateLocalNode(privKey *ecdsa.PrivateKey, storagePath string, ipAddr net.IP, udpPort, tcpPort int) (*enode.LocalNode, error)

CreateLocalNode create a new enode.LocalNode instance

func DiffSubnets

func DiffSubnets(a, b []byte) map[int]byte

DiffSubnets returns a diff of the two given subnets. returns a map with all the different entries and their post change value

func GetForkVersionEntry

func GetForkVersionEntry(record *enr.Record) (forksprotocol.ForkVersion, error)

GetForkVersionEntry extracts the value of operator-id entry ('oid')

func GetSubnetsEntry

func GetSubnetsEntry(record *enr.Record) ([]byte, error)

GetSubnetsEntry extracts the value of subnets entry from some record

func SetForkVersionEntry

func SetForkVersionEntry(node *enode.LocalNode, forkv string) error

SetForkVersionEntry adds operator-id entry ('oid') to the node

func SetSubnetsEntry

func SetSubnetsEntry(node *enode.LocalNode, subnets []byte) error

SetSubnetsEntry adds subnets entry to our enode.LocalNode

func SharedSubnets

func SharedSubnets(a, b []byte, maxLen int) []int

SharedSubnets returns the shared subnets

func UpdateSubnets

func UpdateSubnets(node *enode.LocalNode, count int, added []int, removed []int) ([]byte, error)

UpdateSubnets updates subnets entry according to the given changes. count is the amount of subnets, in case that the entry doesn't exist as we want to initialize it

Types

type ForkVersionEntry

type ForkVersionEntry string

ForkVersionEntry holds the fork version of the node

func (*ForkVersionEntry) DecodeRLP

func (fv *ForkVersionEntry) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, required because fork version is a string

func (ForkVersionEntry) ENRKey

func (fv ForkVersionEntry) ENRKey() string

ENRKey implements enr.Entry, returns the entry key

func (ForkVersionEntry) EncodeRLP

func (fv ForkVersionEntry) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder, required because fork version is a string

type NodeInfo

type NodeInfo struct {
	// ForkVersion is the fork version used by the node
	ForkVersion forksprotocol.ForkVersion
	// NetworkID is the id of the node's network
	NetworkID string
	// Metadata holds node's general information
	Metadata *NodeMetadata
}

NodeInfo holds node's information such as network information. it implements record.Record so we can safely sign, exchange and verify the data. for more information see record.Envelope

func NewNodeInfo

func NewNodeInfo(forkVersion forksprotocol.ForkVersion, networkID string) *NodeInfo

NewNodeInfo creates a new node info

func (*NodeInfo) Codec

func (ni *NodeInfo) Codec() []byte

Codec is a binary identifier for this type of record.record

func (*NodeInfo) Consume

func (ni *NodeInfo) Consume(data []byte) error

Consume takes a raw envelope and extracts the parsed record

func (*NodeInfo) Domain

func (ni *NodeInfo) Domain() string

Domain is the "signature domain" used when signing and verifying an record.Record

func (*NodeInfo) MarshalRecord

func (ni *NodeInfo) MarshalRecord() ([]byte, error)

MarshalRecord converts a Record instance to a []byte, so that it can be used as an Envelope payload

func (*NodeInfo) Seal

func (ni *NodeInfo) Seal(privateKey crypto.PrivKey) ([]byte, error)

Seal seals and encodes the record to be sent to other peers

func (*NodeInfo) UnmarshalRecord

func (ni *NodeInfo) UnmarshalRecord(data []byte) error

UnmarshalRecord unmarshals a []byte payload into an instance of a particular Record type

type NodeMetadata

type NodeMetadata struct {
	// NodeVersion is the ssv-node version, it is a required field
	NodeVersion string
	// OperatorID holds a hash of the operator public key, based on operator key
	OperatorID string
	// ExecutionNode is the "name/version" of the eth1 node
	ExecutionNode string
	// ConsensusNode is the "name/version" of the beacon node
	ConsensusNode string
	// Subnets represents the subnets that our node is subscribed to
	Subnets string
}

NodeMetadata holds node's general information

func (*NodeMetadata) Decode

func (nm *NodeMetadata) Decode(data []byte) error

Decode decodes a raw payload into metadata TODO: switch to SSZ

func (*NodeMetadata) Encode

func (nm *NodeMetadata) Encode() ([]byte, error)

Encode encodes the metadata into bytes TODO: switch to SSZ

type Subnets

type Subnets []byte

Subnets holds all the subscribed subnets of a specific node

func (Subnets) Clone

func (s Subnets) Clone() Subnets

Clone clones the independent byte slice

func (Subnets) FromString

func (s Subnets) FromString(subnetsStr string) (Subnets, error)

FromString parses a given subnet string

func (Subnets) String

func (s Subnets) String() string