commons

Documentation

Index

• Constants
• func AddOptions(opts []libp2p.Option) []libp2p.Option
• func BuildMultiAddress(ipAddr, protocol string, port uint, id peer.ID) (ma.Multiaddr, error)
• func CheckAddress(addr string) error
• func DecodeNetworkMsg(data []byte) (*spectypes.SSVMessage, error)
• func DecodeSignedSSVMessage(encoded []byte) ([]byte, spectypes.OperatorID, []byte, error)
• func ECDSAPrivFromInterface(privkey crypto.PrivKey) (*ecdsa.PrivateKey, error)
• func ECDSAPrivToInterface(privkey *ecdsa.PrivateKey) (crypto.PrivKey, error)
• func ECDSAPubFromInterface(pubKey crypto.PubKey) *ecdsa.PublicKey
• func ECDSAPubToInterface(pubkey *ecdsa.PublicKey) (crypto.PubKey, error)
• func EncodeNetworkMsg(msg *spectypes.SSVMessage) ([]byte, error)
• func EncodeSignedSSVMessage(message []byte, operatorID spectypes.OperatorID, signature []byte) []byte
• func GenNetworkKey() (*ecdsa.PrivateKey, error)
• func GetTopicBaseName(topicName string) string
• func GetTopicFullName(baseName string) string
• func IPAddr() (net.IP, error)
• func ProtocolID(prot p2pprotocol.SyncProtocol) (protocol.ID, int)
• func RSAPrivToInterface(privkey *rsa.PrivateKey) (crypto.PrivKey, error)
• func SubnetTopicID(subnet int) string
• func Subnets() int
• func Topics() []string
• func ValidatorSubnet(validatorPKHex string) int
• func ValidatorTopicID(pkByts []byte) []string
• type MsgIDFunc
  • func MsgID() MsgIDFunc

Constants

const (
	// DefaultIP is hte default ip address to use
	DefaultIP = "127.0.0.1"
	// DefaultTCP is the default tcp port used in SSV
	DefaultTCP = 12001
	// DefaultUDP is the default udp port used in SSV
	DefaultUDP = 13001
)

const (

	// UnknownSubnet is used when a validator public key is invalid
	UnknownSubnet = "unknown"
)

Functions

func AddOptions

func AddOptions(opts []libp2p.Option) []libp2p.Option

AddOptions implementation

func BuildMultiAddress

func BuildMultiAddress(ipAddr, protocol string, port uint, id peer.ID) (ma.Multiaddr, error)

BuildMultiAddress creates a multiaddr from the given params

func CheckAddress

func CheckAddress(addr string) error

CheckAddress checks that some address is accessible and returns error accordingly

func DecodeNetworkMsg

func DecodeNetworkMsg(data []byte) (*spectypes.SSVMessage, error)

DecodeNetworkMsg decodes network message

func DecodeSignedSSVMessage

func DecodeSignedSSVMessage(encoded []byte) ([]byte, spectypes.OperatorID, []byte, error)

DecodeSignedSSVMessage deserializes signed message bytes messsage, op id and a signature

func ECDSAPrivFromInterface

func ECDSAPrivFromInterface(privkey crypto.PrivKey) (*ecdsa.PrivateKey, error)

ECDSAPrivFromInterface converts crypto.PrivKey back to ecdsa.PrivateKey

func ECDSAPrivToInterface

func ECDSAPrivToInterface(privkey *ecdsa.PrivateKey) (crypto.PrivKey, error)

ECDSAPrivToInterface converts ecdsa.PrivateKey to crypto.PrivKey

func ECDSAPubFromInterface

func ECDSAPubFromInterface(pubKey crypto.PubKey) *ecdsa.PublicKey

ECDSAPubFromInterface converts crypto.PubKey to ecdsa.PublicKey

func ECDSAPubToInterface

func ECDSAPubToInterface(pubkey *ecdsa.PublicKey) (crypto.PubKey, error)

ECDSAPubToInterface converts ecdsa.PublicKey to crypto.PubKey

func EncodeNetworkMsg

func EncodeNetworkMsg(msg *spectypes.SSVMessage) ([]byte, error)

EncodeNetworkMsg encodes network message

func EncodeSignedSSVMessage

func EncodeSignedSSVMessage(message []byte, operatorID spectypes.OperatorID, signature []byte) []byte

EncodeSignedSSVMessage serializes the message, op id and signature into bytes

func GenNetworkKey

func GenNetworkKey() (*ecdsa.PrivateKey, error)

GenNetworkKey generates a new network key

func GetTopicBaseName

func GetTopicBaseName(topicName string) string

GetTopicBaseName return the base topic name of the topic, w/o ssv prefix

func GetTopicFullName

func GetTopicFullName(baseName string) string

GetTopicFullName returns the topic full name, including prefix

func IPAddr

func IPAddr() (net.IP, error)

IPAddr returns the external IP address

func ProtocolID

func ProtocolID(prot p2pprotocol.SyncProtocol) (protocol.ID, int)

ProtocolID returns the protocol id of the given protocol, and the amount of peers for distribution

func RSAPrivToInterface

func RSAPrivToInterface(privkey *rsa.PrivateKey) (crypto.PrivKey, error)

RSAPrivToInterface converts ecdsa.PrivateKey to crypto.PrivKey

func SubnetTopicID

func SubnetTopicID(subnet int) string

SubnetTopicID returns the topic to use for the given subnet

func Subnets

func Subnets() int

Subnets returns the subnets count for this fork

func Topics

func Topics() []string

Topics returns the available topics for this fork.

func ValidatorSubnet

func ValidatorSubnet(validatorPKHex string) int

ValidatorSubnet returns the subnet for the given validator

func ValidatorTopicID

func ValidatorTopicID(pkByts []byte) []string

ValidatorTopicID returns the topic to use for the given validator

Types

type MsgIDFunc

type MsgIDFunc func(msg []byte) string

MsgIDFunc is the function that maps a message to a msg_id

func MsgID

func MsgID() MsgIDFunc

MsgID returns msg_id for the given message