node

Documentation

Index

• func DiscoveryService(s ...ServiceDiscovery) func(cfg *Config) error
• func ExchangeKeys(s string) func(cfg *Config) error
• func FromBase64(enablemDNS, enableDHT bool, bb string) func(cfg *Config) error
• func FromYaml(enablemDNS, enableDHT bool, path string) func(cfg *Config) error
• func Handlers(h ...Handler) func(cfg *Config) error
• func Insecure(b bool) func(cfg *Config) error
• func LibP2PLogLevel(l log.LogLevel) func(cfg *Config) error
• func ListenAddresses(ss ...string) func(cfg *Config) error
• func Logger(l log.StandardLogger) func(cfg *Config) error
• func MaxMessageSize(i int) func(cfg *Config) error
• func RoomName(s string) func(cfg *Config) error
• func SealKeyInterval(i int) func(cfg *Config) error
• func SealKeyLength(i int) func(cfg *Config) error
• func WithDiscoveryBootstrapPeers(a discovery.AddrList) func(cfg *Config) error
• func WithDiscoveryInterval(t time.Duration) func(cfg *Config) error
• func WithInterfaceAddress(i string) func(cfg *Config) error
• func WithLedgerAnnounceTime(t time.Duration) func(cfg *Config) error
• func WithLedgerInterval(t time.Duration) func(cfg *Config) error
• func WithLibp2pAdditionalOptions(i ...libp2p.Option) func(cfg *Config) error
• func WithLibp2pOptions(i ...libp2p.Option) func(cfg *Config) error
• func WithNetworkService(ns ...NetworkService) func(cfg *Config) error
• func WithStore(s blockchain.Store) func(cfg *Config) error
• func WithStreamHandler(id protocol.ID, h types.StreamHandler) func(cfg *Config) error
• type Config
  • func (cfg *Config) Apply(opts ...Option) error
• type Handler
• type NetworkService
• type Node
  • func New(p ...Option) *Node
  • func (e *Node) AddNetworkService(n NetworkService)
  • func (e *Node) AddStreamHandler(id protocol.Protocol, s types.StreamHandler)
  • func (e *Node) Host() host.Host
  • func (e *Node) Ledger() (*blockchain.Ledger, error)
  • func (e *Node) Start(ctx context.Context) error
• type OTP
• type OTPConfig
• type Option
• type ServiceDiscovery
• type YAMLConnectionConfig
  • func GenerateNewConnectionData() *YAMLConnectionConfig
  • func (y YAMLConnectionConfig) Base64() string
  • func (y YAMLConnectionConfig) YAML() string

Functions

func DiscoveryService

func DiscoveryService(s ...ServiceDiscovery) func(cfg *Config) error

DiscoveryService Adds the service given as argument to the discovery services

func ExchangeKeys

func ExchangeKeys(s string) func(cfg *Config) error

func FromBase64

func FromBase64(enablemDNS, enableDHT bool, bb string) func(cfg *Config) error

func FromYaml

func FromYaml(enablemDNS, enableDHT bool, path string) func(cfg *Config) error

func Handlers

func Handlers(h ...Handler) func(cfg *Config) error

Handlers adds a handler to the list that is called on each received message

func Insecure

func Insecure(b bool) func(cfg *Config) error

func LibP2PLogLevel

func LibP2PLogLevel(l log.LogLevel) func(cfg *Config) error

func ListenAddresses

func ListenAddresses(ss ...string) func(cfg *Config) error

func Logger

func Logger(l log.StandardLogger) func(cfg *Config) error

func MaxMessageSize

func MaxMessageSize(i int) func(cfg *Config) error

func RoomName

func RoomName(s string) func(cfg *Config) error

func SealKeyInterval

func SealKeyInterval(i int) func(cfg *Config) error

func SealKeyLength

func SealKeyLength(i int) func(cfg *Config) error

func WithDiscoveryBootstrapPeers

func WithDiscoveryBootstrapPeers(a discovery.AddrList) func(cfg *Config) error

func WithDiscoveryInterval

func WithDiscoveryInterval(t time.Duration) func(cfg *Config) error

func WithInterfaceAddress

func WithInterfaceAddress(i string) func(cfg *Config) error

func WithLedgerAnnounceTime

func WithLedgerAnnounceTime(t time.Duration) func(cfg *Config) error

func WithLedgerInterval

func WithLedgerInterval(t time.Duration) func(cfg *Config) error

func WithLibp2pAdditionalOptions

func WithLibp2pAdditionalOptions(i ...libp2p.Option) func(cfg *Config) error

func WithLibp2pOptions

func WithLibp2pOptions(i ...libp2p.Option) func(cfg *Config) error

WithLibp2pOptions Overrides defaults options

func WithNetworkService

func WithNetworkService(ns ...NetworkService) func(cfg *Config) error

func WithStore

func WithStore(s blockchain.Store) func(cfg *Config) error

func WithStreamHandler

func WithStreamHandler(id protocol.ID, h types.StreamHandler) func(cfg *Config) error

WithStreamHandler adds a handler to the list that is called on each received message

Types

type Config

type Config struct {
	// ExchangeKey is a Symmetric key used to seal the messages
	ExchangeKey string

	// RoomName is the gossip room where all peers are subscribed to
	RoomName string

	// ListenAddresses is the discovery peer initial bootstrap addresses
	ListenAddresses []discovery.AddrList

	// Insecure disables secure p2p e2e encrypted communication
	Insecure bool

	// Handlers are a list of handlers subscribed to messages received by the vpn interface
	Handlers []Handler

	MaxMessageSize  int
	SealKeyInterval int

	ServiceDiscovery []ServiceDiscovery
	NetworkServices  []NetworkService
	Logger           log.StandardLogger

	SealKeyLength    int
	InterfaceAddress string

	Store blockchain.Store

	// Handle is a handle consumed by HumanInterfaces to handle received messages
	Handle                     func(bool, *hub.Message)
	StreamHandlers             map[p2pprotocol.ID]types.StreamHandler
	AdditionalOptions, Options []libp2p.Option

	DiscoveryInterval, LedgerSyncronizationTime, LedgerAnnounceTime time.Duration
	DiscoveryBootstrapPeers                                         discovery.AddrList
}

Config is the node configuration

func (*Config) Apply

func (cfg *Config) Apply(opts ...Option) error

Apply applies the given options to the config, returning the first error encountered (if any).

type Handler

type Handler func(*hub.Message) error

type NetworkService

type NetworkService func(context.Context, Config, *Node, *blockchain.Ledger) error

NetworkService is a service running over the network. It takes a context, a node and a ledger

type Node

type Node struct {
	HubRoom *hub.Room
	// contains filtered or unexported fields
}

func New

func New(p ...Option) *Node

func (*Node) AddNetworkService

func (e *Node) AddNetworkService(n NetworkService)

AddNetworkService register a network service to the node. Note: must be called before Start().

func (*Node) AddStreamHandler

func (e *Node) AddStreamHandler(id protocol.Protocol, s types.StreamHandler)

AddStreamHandler adds a stream handler for the given protocol. Note: must be called before Start().

func (*Node) Host

func (e *Node) Host() host.Host

Host returns the libp2p peer host

func (*Node) Ledger

func (e *Node) Ledger() (*blockchain.Ledger, error)

Ledger return the ledger which uses the node connection to broadcast messages

func (*Node) Start

func (e *Node) Start(ctx context.Context) error

Start joins the node over the p2p network

type OTP

type OTP struct {
	DHT    OTPConfig `yaml:"dht"`
	Crypto OTPConfig `yaml:"crypto"`
}

type OTPConfig

type OTPConfig struct {
	Interval int    `yaml:"interval"`
	Key      string `yaml:"key"`
	Length   int    `yaml:"length"`
}

type Option

type Option func(cfg *Config) error

type ServiceDiscovery

type ServiceDiscovery interface {
	Run(log.StandardLogger, context.Context, host.Host) error
	Option(context.Context) func(c *libp2p.Config) error
}

type YAMLConnectionConfig

type YAMLConnectionConfig struct {
	OTP OTP `yaml:"otp"`

	RoomName       string `yaml:"room"`
	Rendezvous     string `yaml:"rendezvous"`
	MDNS           string `yaml:"mdns"`
	MaxMessageSize int    `yaml:"max_message_size"`
}

func GenerateNewConnectionData

func GenerateNewConnectionData() *YAMLConnectionConfig

func (YAMLConnectionConfig) Base64

func (y YAMLConnectionConfig) Base64() string

Base64 returns the base64 string representation of the connection

func (YAMLConnectionConfig) YAML

func (y YAMLConnectionConfig) YAML() string

YAML returns the connection config as yaml string