checkpoint

package

v1.5.1 Latest Latest Go to latest Published: Apr 29, 2024 License: MIT Imports: 32 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/spacemeshos/go-spacemesh

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
Variables
func CopyFile(fs afero.Fs, src, dst string) error
func Generate(ctx context.Context, fs afero.Fs, db *sql.Database, dataDir string, ...) error
func RecoveryDir(dataDir string) string
func RecoveryFilename(dataDir, base string, restore types.LayerID) string
func SelfCheckpointFilename(dataDir string, snapshot types.LayerID) string
func ValidateSchema(data []byte) error
type AtxDep
type Config
- func DefaultConfig() Config
type PreservedData
- func Recover(ctx context.Context, logger log.Log, fs afero.Fs, cfg *RecoverConfig) (*PreservedData, error)
- func RecoverWithDb(ctx context.Context, logger log.Log, db *sql.Database, ...) (*PreservedData, error)
type RecoverConfig
type RecoveryFile
- func NewRecoveryFile(aferoFs afero.Fs, path string) (*RecoveryFile, error)
- func (rf *RecoveryFile) Copy(fs afero.Fs, src io.Reader) error
- func (rf *RecoveryFile) Save(fs afero.Fs) error

Constants ¶

View Source

const (
	SchemaVersion = "https://spacemesh.io/checkpoint.schema.json.1.0"

	CommandString = "grpcurl -plaintext -d '%s' 0.0.0.0:9093 spacemesh.v1.AdminService.CheckpointStream"
)

Variables ¶

View Source

var (
	ErrCheckpointNotFound    = errors.New("checkpoint not found")
	ErrUrlSchemeNotSupported = errors.New("url scheme not supported")
)

View Source

var Schema string

Functions ¶

func CopyFile ¶

func CopyFile(fs afero.Fs, src, dst string) error

func Generate ¶

func Generate(
	ctx context.Context,
	fs afero.Fs,
	db *sql.Database,
	dataDir string,
	snapshot types.LayerID,
	numAtxs int,
) error

func RecoveryDir ¶

func RecoveryDir(dataDir string) string

func RecoveryFilename ¶

func RecoveryFilename(dataDir, base string, restore types.LayerID) string

func SelfCheckpointFilename ¶

func SelfCheckpointFilename(dataDir string, snapshot types.LayerID) string

func ValidateSchema ¶

func ValidateSchema(data []byte) error

Types ¶

type AtxDep ¶ added in v1.5.0

type AtxDep struct {
	ID           types.ATXID
	PublishEpoch types.EpochID
	Blob         []byte
}

type Config ¶

type Config struct {
	Uri     string `mapstructure:"recovery-uri"`
	Restore uint32 `mapstructure:"recovery-layer"`

	// set to false if atxs are not compatible before and after the checkpoint recovery.
	PreserveOwnAtx bool `mapstructure:"preserve-own-atx"`
}

func DefaultConfig ¶

func DefaultConfig() Config

type PreservedData ¶

type PreservedData struct {
	Deps   []*AtxDep
	Proofs []*types.PoetProofMessage
}

func Recover ¶

func Recover(
	ctx context.Context,
	logger log.Log,
	fs afero.Fs,
	cfg *RecoverConfig,
) (*PreservedData, error)

func RecoverWithDb ¶

func RecoverWithDb(
	ctx context.Context,
	logger log.Log,
	db *sql.Database,
	localDB *localsql.Database,
	fs afero.Fs,
	cfg *RecoverConfig,
) (*PreservedData, error)

type RecoverConfig ¶

type RecoverConfig struct {
	GoldenAtx      types.ATXID
	DataDir        string
	DbFile         string
	LocalDbFile    string
	PreserveOwnAtx bool
	NodeIDs        []types.NodeID
	Uri            string
	Restore        types.LayerID
}

type RecoveryFile ¶

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

func NewRecoveryFile ¶

func NewRecoveryFile(aferoFs afero.Fs, path string) (*RecoveryFile, error)

func (*RecoveryFile) Copy ¶

func (rf *RecoveryFile) Copy(fs afero.Fs, src io.Reader) error

func (*RecoveryFile) Save ¶

func (rf *RecoveryFile) Save(fs afero.Fs) error

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL