bootstrap

Documentation

Overview

Package bootstrap is a generated GoMock package.

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(dataDir string, epoch types.EpochID, basename string) string
• func UpdateName(epoch types.EpochID, suffix string) string
• func ValidateSchema(data []byte) error
• type Config
  • func DefaultConfig() Config
• type EpochData
  • func (ed *EpochData) MarshalLogObject(encoder zapcore.ObjectEncoder) error
• type EpochOverride
• type InnerData
• type MocklayerClock
  • func NewMocklayerClock(ctrl *gomock.Controller) *MocklayerClock
  • func (m *MocklayerClock) CurrentLayer() types.LayerID
  • func (m *MocklayerClock) EXPECT() *MocklayerClockMockRecorder
• type MocklayerClockCurrentLayerCall
  • func (c *MocklayerClockCurrentLayerCall) Do(f func() types.LayerID) *MocklayerClockCurrentLayerCall
  • func (c *MocklayerClockCurrentLayerCall) DoAndReturn(f func() types.LayerID) *MocklayerClockCurrentLayerCall
  • func (c *MocklayerClockCurrentLayerCall) Return(arg0 types.LayerID) *MocklayerClockCurrentLayerCall
• type MocklayerClockMockRecorder
  • func (mr *MocklayerClockMockRecorder) CurrentLayer() *MocklayerClockCurrentLayerCall
• type Opt
  • func WithConfig(cfg Config) Opt
  • func WithFilesystem(fs afero.Fs) Opt
  • func WithHttpClient(c *http.Client) Opt
  • func WithLogger(logger *zap.Logger) Opt
• type Update
• type Updater
  • func New(clock layerClock, opts ...Opt) *Updater
  • func (u *Updater) Close() error
  • func (u *Updater) DoIt(ctx context.Context) error
  • func (u *Updater) Downloaded(epoch types.EpochID, suffix string) bool
  • func (u *Updater) Load(ctx context.Context) error
  • func (u *Updater) Start() error
  • func (u *Updater) Subscribe() (<-chan *VerifiedUpdate, error)
• type VerifiedUpdate
  • func (vd *VerifiedUpdate) MarshalLogObject(encoder zapcore.ObjectEncoder) error

Constants

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

	SuffixBeacon    = "bc"
	SuffixActiveSet = "as"
	SuffixBootstrap = "bs"
)

Variables

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

var Schema string

Functions

func PersistFilename

func PersistFilename(dataDir string, epoch types.EpochID, basename string) string

func UpdateName

func UpdateName(epoch types.EpochID, suffix string) 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
}

func DefaultConfig

func DefaultConfig() Config

type EpochData

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

func (*EpochData) MarshalLogObject

func (ed *EpochData) MarshalLogObject(encoder zapcore.ObjectEncoder) error

type EpochOverride

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

type InnerData

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

type MocklayerClock

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

MocklayerClock is a mock of layerClock interface.

func NewMocklayerClock

func NewMocklayerClock(ctrl *gomock.Controller) *MocklayerClock

NewMocklayerClock creates a new mock instance.

func (*MocklayerClock) CurrentLayer

func (m *MocklayerClock) CurrentLayer() types.LayerID

CurrentLayer mocks base method.

func (*MocklayerClock) EXPECT

func (m *MocklayerClock) EXPECT() *MocklayerClockMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

type MocklayerClockCurrentLayerCall

type MocklayerClockCurrentLayerCall struct {
	*gomock.Call
}

MocklayerClockCurrentLayerCall wrap *gomock.Call

func (*MocklayerClockCurrentLayerCall) Do

func (c *MocklayerClockCurrentLayerCall) Do(f func() types.LayerID) *MocklayerClockCurrentLayerCall

Do rewrite *gomock.Call.Do

func (*MocklayerClockCurrentLayerCall) DoAndReturn

func (c *MocklayerClockCurrentLayerCall) DoAndReturn(f func() types.LayerID) *MocklayerClockCurrentLayerCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MocklayerClockCurrentLayerCall) Return

func (c *MocklayerClockCurrentLayerCall) Return(arg0 types.LayerID) *MocklayerClockCurrentLayerCall

Return rewrite *gomock.Call.Return

type MocklayerClockMockRecorder

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

MocklayerClockMockRecorder is the mock recorder for MocklayerClock.

func (*MocklayerClockMockRecorder) CurrentLayer

func (mr *MocklayerClockMockRecorder) CurrentLayer() *MocklayerClockCurrentLayerCall

CurrentLayer indicates an expected call of CurrentLayer.

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 *zap.Logger) 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(clock layerClock, opts ...Opt) *Updater

func (*Updater) Close

func (u *Updater) Close() error

func (*Updater) DoIt

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

func (*Updater) Downloaded

func (u *Updater) Downloaded(epoch types.EpochID, suffix string) bool

func (*Updater) Load

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

func (*Updater) Start

func (u *Updater) Start() error

func (*Updater) Subscribe

func (u *Updater) Subscribe() (<-chan *VerifiedUpdate, error)

type VerifiedUpdate

type VerifiedUpdate struct {
	Data      *EpochOverride
	Persisted string
}

func (*VerifiedUpdate) MarshalLogObject

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