snapshot

Documentation

Index

• Constants
• Variables
• type ParametersSnapshots

Constants

const (
	// SolidEntryPointCheckAdditionalThresholdPast is the additional past cone (to BMD) that is walked to calculate the solid entry points.
	SolidEntryPointCheckAdditionalThresholdPast = 5

	// SolidEntryPointCheckAdditionalThresholdFuture is the additional future cone (to BMD) that is needed to calculate solid entry points correctly.
	SolidEntryPointCheckAdditionalThresholdFuture = 5
)

const (
	// CfgSnapshotsForceLoadingSnapshot defines the force loading of a snapshot, even if a database already exists.
	CfgSnapshotsForceLoadingSnapshot = "forceLoadingSnapshot"
)

Variables

var (
	CoreComponent *app.CoreComponent
)

var ParamsSnapshots = &ParametersSnapshots{
	DownloadURLs: []*snapshot.DownloadTarget{
		{
			Full:  "https://files.shimmer.network/snapshots/latest-full_snapshot.bin",
			Delta: "https://files.shimmer.network/snapshots/latest-delta_snapshot.bin",
		},
	},
}

Types

type ParametersSnapshots

type ParametersSnapshots struct {
	// Enabled defines whether to generate snapshot files.
	Enabled bool `default:"false" usage:"whether to generate snapshot files"`
	// Depth defines the depth, respectively the starting point, at which a snapshot of the ledger is generated
	Depth int `default:"50" usage:"the depth, respectively the starting point, at which a snapshot of the ledger is generated"`
	// Interval defines the interval, in milestones, at which snapshot files are created (snapshots are only created if the node is synced)
	Interval int `` /* 133-byte string literal not displayed */
	// FullPath defines the path to the full snapshot file
	FullPath string `default:"shimmer/snapshots/full_snapshot.bin" usage:"path to the full snapshot file"`
	// DeltaPath defines the path to the delta snapshot file
	DeltaPath string `default:"shimmer/snapshots/delta_snapshot.bin" usage:"path to the delta snapshot file"`
	// DeltaSizeThresholdPercentage defines whether to create a full snapshot if the size of a delta snapshot reaches a certain percentage of the full snapshot
	// (0.0 = always create delta snapshot to keep ms diff history)
	DeltaSizeThresholdPercentage float64 `` /* 188-byte string literal not displayed */
	// DeltaSizeThresholdMinSize defines the minimum size of the delta snapshot file before the threshold percentage condition is checked
	// (below that size the delta snapshot is always created)
	DeltaSizeThresholdMinSize string `` /* 173-byte string literal not displayed */
	// DownloadURLs defines the URLs to load the snapshot files from.
	DownloadURLs []*snapshot.DownloadTarget `noflag:"true" usage:"URLs to load the snapshot files from"`
}

ParametersSnapshots contains the definition of the parameters used by snapshots.