bootstrap

Documentation

Overview

Package bootstrap checks for the bootstrap/fallback data update from the spacemesh administrator (a centralized entity controlled by the spacemesh team). This is intended as a short-term solution at the beginning of the network deployment to facilitate recovering from network failures and should be removed once the network is stable.

The updater periodically checks for the latest update from a URL provided by the spacemesh administrator, verifies the data, persists on disk and notifies subscribers of a new update.

Subscribers register by calling `Subscribe()` to receive a channel for the latest update.

Index

• Constants
• Variables
• func PersistFilename(dir string, id int64) string
• func ValidateSchema(data []byte) error
• type Config
  • func DefaultConfig() Config
• type EpochData
• type EpochOverride
• type InnerData
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithFilesystem(fs afero.Fs) Opt
  • func WithHttpClient(c *http.Client) Opt
  • func WithLogger(logger log.Log) Opt
• type Update
• type Updater
  • func New(opts ...Opt) *Updater
  • func (u *Updater) Close()
  • func (u *Updater) DoIt(ctx context.Context) error
  • func (u *Updater) Load(ctx context.Context) error
  • func (u *Updater) Start(ctx context.Context)
  • func (u *Updater) Subscribe() chan *VerifiedUpdate
• type VerifiedUpdate
  • func (vd *VerifiedUpdate) MarshalLogObject(encoder log.ObjectEncoder) error

Constants

const (
	DefaultURL = "http://localhost:3000/bootstrap"
	DirName    = "bootstrap"
)

Variables

var (
	ErrWrongVersion  = errors.New("wrong schema version")
	ErrInvalidBeacon = errors.New("invalid beacon")
)

var Schema string

Functions

func PersistFilename

func PersistFilename(dir string, id int64) string

func ValidateSchema

func ValidateSchema(data []byte) error

Types

type Config

type Config struct {
	URL     string `mapstructure:"bootstrap-url"`
	Version string `mapstructure:"bootstrap-version"`

	DataDir   string
	Interval  time.Duration
	NumToKeep int
}

func DefaultConfig

func DefaultConfig() Config

type EpochData

type EpochData struct {
	ID        uint32   `json:"number"`
	Beacon    string   `json:"beacon"`
	ActiveSet []string `json:"activeSet"`
}

type EpochOverride

type EpochOverride struct {
	Epoch     types.EpochID
	Beacon    types.Beacon
	ActiveSet []types.ATXID
}

type InnerData

type InnerData struct {
	UpdateId int64     `json:"id"`
	Epoch    EpochData `json:"epoch"`
}

type Opt

type Opt func(*Updater)

func WithConfig

func WithConfig(cfg Config) Opt

func WithFilesystem

func WithFilesystem(fs afero.Fs) Opt

func WithHttpClient

func WithHttpClient(c *http.Client) Opt

func WithLogger

func WithLogger(logger log.Log) Opt

type Update

type Update struct {
	Version string    `json:"version"`
	Data    InnerData `json:"data"`
}

type Updater

type Updater struct {
	// contains filtered or unexported fields
}

func New

func New(opts ...Opt) *Updater

func (*Updater) Close

func (u *Updater) Close()

func (*Updater) DoIt

func (u *Updater) DoIt(ctx context.Context) error

func (*Updater) Load

func (u *Updater) Load(ctx context.Context) error

func (*Updater) Start

func (u *Updater) Start(ctx context.Context)

func (*Updater) Subscribe

func (u *Updater) Subscribe() chan *VerifiedUpdate

type VerifiedUpdate

type VerifiedUpdate struct {
	UpdateId  int64
	Data      *EpochOverride
	Persisted string
}

func (*VerifiedUpdate) MarshalLogObject

func (vd *VerifiedUpdate) MarshalLogObject(encoder log.ObjectEncoder) error