bootstrap

Documentation

Index

• type Config
  • func (config *Config) Verify(log *zap.Logger) error
• type DB
• type Peer
  • func New(log *zap.Logger, full *identity.FullIdentity, db DB, ...) (*Peer, error)
  • func (peer *Peer) Addr() string
  • func (peer *Peer) Close() error
  • func (peer *Peer) ID() storj.NodeID
  • func (peer *Peer) Local() overlay.NodeDossier
  • func (peer *Peer) PrivateAddr() string
  • func (peer *Peer) Run(ctx context.Context) error
  • func (peer *Peer) URL() storj.NodeURL

Types

type Config

type Config struct {
	Identity identity.Config

	Server   server.Config
	Kademlia kademlia.Config

	Web bootstrapserver.Config

	Version version.Config
}

Config is all the configuration parameters for a Bootstrap Node

func (*Config) Verify

func (config *Config) Verify(log *zap.Logger) error

Verify verifies whether configuration is consistent and acceptable.

type DB

type DB interface {
	// CreateTables initializes the database
	CreateTables() error
	// Close closes the database
	Close() error

	// TODO: use better interfaces
	RoutingTable() (kdb, ndb, adb storage.KeyValueStore)
}

DB is the master database for Boostrap Node

type Peer

type Peer struct {
	// core dependencies
	Log      *zap.Logger
	Identity *identity.FullIdentity
	DB       DB

	Dialer rpc.Dialer

	Server *server.Server

	Version *version.Service

	// services and endpoints
	Kademlia struct {
		RoutingTable *kademlia.RoutingTable
		Service      *kademlia.Kademlia
		Endpoint     *kademlia.Endpoint
		Inspector    *kademlia.Inspector
	}

	// Web server with web UI
	Web struct {
		Listener net.Listener
		Service  *bootstrapweb.Service
		Endpoint *bootstrapserver.Server
	}
}

Peer is the representation of a Bootstrap Node.

func New

func New(log *zap.Logger, full *identity.FullIdentity, db DB, revDB extensions.RevocationDB, config Config, versionInfo version.Info) (*Peer, error)

New creates a new Bootstrap Node.

func (*Peer) Addr

func (peer *Peer) Addr() string

Addr returns the public address.

func (*Peer) Close

func (peer *Peer) Close() error

Close closes all the resources.

func (*Peer) ID

func (peer *Peer) ID() storj.NodeID

ID returns the peer ID.

func (*Peer) Local

func (peer *Peer) Local() overlay.NodeDossier

Local returns the peer local node info.

func (*Peer) PrivateAddr

func (peer *Peer) PrivateAddr() string

PrivateAddr returns the private address.

func (*Peer) Run

func (peer *Peer) Run(ctx context.Context) error

Run runs bootstrap node until it's either closed or it errors.

func (*Peer) URL

func (peer *Peer) URL() storj.NodeURL

URL returns the storj.NodeURL