snapshot

Documentation

Index

• Constants
• Variables
• func CreateLocalSnapshot(targetIndex milestone_index.MilestoneIndex, filePath string, ...) error
• func LoadGlobalSnapshot(filePathLedger string, filePathsSpent []string, ...) error
• func LoadSnapshotFromFile(filePath string) error
• type WriteCounter
  • func (wc WriteCounter) PrintProgress()
  • func (wc *WriteCounter) Write(p []byte) (int, error)

Constants

const (
	SpentAddressesImportBatchSize       = 100000
	SolidEntryPointCheckThresholdPast   = 50
	SolidEntryPointCheckThresholdFuture = 50
)

const (
	// AdditionalPruningThreshold is needed, because the transactions in the getMilestoneApprovees call in getSolidEntryPoints
	// can reference older transactions as well
	AdditionalPruningThreshold = 50
)

Variables

var (
	PLUGIN = node.NewPlugin("Snapshot", node.Enabled, configure, run)

	ErrNoSnapshotSpecified             = errors.New("no snapshot file was specified in the config")
	ErrNoSnapshotDownloadURL           = fmt.Errorf("No download URL given for local snapshot under config option '%s", config.CfgLocalSnapshotsDownloadURL)
	ErrSnapshotImportWasAborted        = errors.New("snapshot import was aborted")
	ErrSnapshotImportFailed            = errors.New("snapshot import failed")
	ErrSnapshotCreationWasAborted      = errors.New("operation was aborted")
	ErrSnapshotCreationFailed          = errors.New("creating snapshot failed: %v")
	ErrTargetIndexTooNew               = errors.New("snapshot target is too new.")
	ErrTargetIndexTooOld               = errors.New("snapshot target is too old.")
	ErrNotEnoughHistory                = errors.New("not enough history.")
	ErrUnconfirmedTxInSubtangle        = errors.New("Unconfirmed tx in subtangle")
	ErrInvalidBalance                  = errors.New("Invalid balance! Total does not match supply:")
	ErrWrongCoordinatorAddressDatabase = errors.New("Configured coordinator address does not match database information")
)

var ErrUnsupportedLSFileVersion = errors.New("unsupported local snapshot file version")

var (
	SupportedLocalSnapshotFileVersions = []byte{4}
)

Functions

func CreateLocalSnapshot

func CreateLocalSnapshot(targetIndex milestone_index.MilestoneIndex, filePath string, abortSignal <-chan struct{}) error

func LoadGlobalSnapshot

func LoadGlobalSnapshot(filePathLedger string, filePathsSpent []string, snapshotIndex milestone_index.MilestoneIndex) error

func LoadSnapshotFromFile

func LoadSnapshotFromFile(filePath string) error

Types

type WriteCounter

type WriteCounter struct {
	Expected uint64
	Total    uint64
}

WriteCounter counts the number of bytes written to it. It implements to the io.Writer interface and we can pass this into io.TeeReader() which will report progress on each write cycle.

func (WriteCounter) PrintProgress

func (wc WriteCounter) PrintProgress()

func (*WriteCounter) Write

func (wc *WriteCounter) Write(p []byte) (int, error)