toolset

Documentation

Index

• Constants
• Variables
• func HandleTools()
• func ShouldHandleTools() bool
• type GetMessageFunc
• type ProxyStorage
  • func NewProxyStorage(storeTarget *storage.Storage, ...) (*ProxyStorage, error)
  • func (s *ProxyStorage) CachedMessage(messageID hornet.MessageID) (*storage.CachedMessage, error)
  • func (s *ProxyStorage) CachedMessageMetadata(messageID hornet.MessageID) (*storage.CachedMetadata, error)
  • func (s *ProxyStorage) Cleanup()
  • func (s *ProxyStorage) MergeStorages() error
  • func (s *ProxyStorage) SolidEntryPointsContain(messageID hornet.MessageID) (bool, error)
  • func (s *ProxyStorage) SolidEntryPointsIndex(messageID hornet.MessageID) (milestone.Index, bool, error)
  • func (s *ProxyStorage) StoreChild(parentMessageID hornet.MessageID, childMessageID hornet.MessageID) *storage.CachedChild
  • func (s *ProxyStorage) StoreIndexation(index []byte, messageID hornet.MessageID) *storage.CachedIndexation
  • func (s *ProxyStorage) StoreMessageIfAbsent(message *storage.Message) (cachedMsg *storage.CachedMessage, newlyAdded bool)
  • func (s *ProxyStorage) StoreMilestoneIfAbsent(index milestone.Index, messageID hornet.MessageID, timestamp time.Time) (*storage.CachedMilestone, bool)
• type StoreMessageInterface

Constants

const (
	FlagToolDatabaseEngine       = "databaseEngine"
	FlagToolDatabaseEngineSource = "sourceDatabaseEngine"
	FlagToolDatabaseEngineTarget = "targetDatabaseEngine"

	FlagToolConfigFilePath = "configFile"

	FlagToolDatabasePath       = "databasePath"
	FlagToolDatabasePathSource = "sourceDatabasePath"
	FlagToolDatabasePathTarget = "targetDatabasePath"

	FlagToolSnapshotPath       = "snapshotPath"
	FlagToolSnapshotPathFull   = "fullSnapshotPath"
	FlagToolSnapshotPathDelta  = "deltaSnapshotPath"
	FlagToolSnapshotPathTarget = "targetSnapshotPath"
	FlagToolSnapshotGlobal     = "global"

	FlagToolOutputPath = "outputPath"

	FlagToolPrivateKey = "privateKey"
	FlagToolPublicKey  = "publicKey"

	FlagToolHRP       = "hrp"
	FlagToolBIP32Path = "bip32Path"
	FlagToolMnemonic  = "mnemonic"
	FlagToolNetworkID = "networkID"
	FlagToolPassword  = "password"
	FlagToolSalt      = "salt"

	FlagToolOutputJSON            = "json"
	FlagToolDescriptionOutputJSON = "format output as JSON"

	FlagToolBenchmarkCount    = "count"
	FlagToolBenchmarkSize     = "size"
	FlagToolBenchmarkThreads  = "threads"
	FlagToolBenchmarkDuration = "duration"

	FlagToolCoordinatorFixStateCooStateFilePath = "stateFilePath"

	FlagToolSnapGenMintAddress        = "mintAddress"
	FlagToolSnapGenTreasuryAllocation = "treasuryAllocation"

	FlagToolDatabaseTargetIndex            = "targetIndex"
	FlagToolDatabaseMergeNodeURL           = "nodeURL"
	FlagToolDatabaseMergeChronicle         = "chronicleMode"
	FlagToolDatabaseMergeChronicleKeyspace = "chronicleKeySpace"
)

const (
	ToolPwdHash                 = "pwd-hash"
	ToolP2PIdentityGen          = "p2pidentity-gen"
	ToolP2PExtractIdentity      = "p2pidentity-extract"
	ToolEd25519Key              = "ed25519-key"
	ToolEd25519Addr             = "ed25519-addr"
	ToolJWTApi                  = "jwt-api"
	ToolSnapGen                 = "snap-gen"
	ToolSnapMerge               = "snap-merge"
	ToolSnapInfo                = "snap-info"
	ToolSnapHash                = "snap-hash"
	ToolBenchmarkIO             = "bench-io"
	ToolBenchmarkCPU            = "bench-cpu"
	ToolDatabaseLedgerHash      = "db-hash"
	ToolDatabaseHealth          = "db-health"
	ToolDatabaseMerge           = "db-merge"
	ToolDatabaseMigration       = "db-migration"
	ToolDatabaseSnapshot        = "db-snapshot"
	ToolDatabaseSplit           = "db-split"
	ToolDatabaseVerify          = "db-verify"
	ToolCoordinatorFixStateFile = "coo-fix-state"
)

const (
	DefaultValueAPIJWTTokenSalt          = "HORNET"
	DefaultValueMainnetDatabasePath      = "mainnetdb"
	DefaultValueP2PDatabasePath          = "p2pstore"
	DefaultValueCoordinatorStateFilePath = "coordinator.state"
	DefaultValueDatabaseEngine           = database.EngineRocksDB
)

Variables

var (
	// Returned when a critical error stops the execution of a task.
	ErrCritical = errors.New("critical error")
)

var (
	// ErrNoNewTangleData is returned when there is no new data in the source database.
	ErrNoNewTangleData = errors.New("no new tangle history available")
)

Functions

func HandleTools

func HandleTools()

HandleTools handles available tools.

func ShouldHandleTools

func ShouldHandleTools() bool

ShouldHandleTools checks if tools were requested.

Types

type GetMessageFunc

type GetMessageFunc func(messageID hornet.MessageID) (*iotago.Message, error)

type ProxyStorage

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

ProxyStorage is used to temporarily store changes to an intermediate storage, which then can be merged with the target store in a single commit.

func NewProxyStorage

func NewProxyStorage(
	storeTarget *storage.Storage,
	milestoneManager *milestonemanager.MilestoneManager,
	getMessageFunc GetMessageFunc) (*ProxyStorage, error)

func (*ProxyStorage) CachedMessage

func (s *ProxyStorage) CachedMessage(messageID hornet.MessageID) (*storage.CachedMessage, error)

message +1

func (*ProxyStorage) CachedMessageMetadata

func (s *ProxyStorage) CachedMessageMetadata(messageID hornet.MessageID) (*storage.CachedMetadata, error)

meta +1

func (*ProxyStorage) Cleanup

func (s *ProxyStorage) Cleanup()

Cleanup shuts down, flushes and closes the proxy store.

func (*ProxyStorage) MergeStorages

func (s *ProxyStorage) MergeStorages() error

func (*ProxyStorage) SolidEntryPointsContain

func (s *ProxyStorage) SolidEntryPointsContain(messageID hornet.MessageID) (bool, error)

func (*ProxyStorage) SolidEntryPointsIndex

func (s *ProxyStorage) SolidEntryPointsIndex(messageID hornet.MessageID) (milestone.Index, bool, error)

func (*ProxyStorage) StoreChild

func (s *ProxyStorage) StoreChild(parentMessageID hornet.MessageID, childMessageID hornet.MessageID) *storage.CachedChild

func (*ProxyStorage) StoreIndexation

func (s *ProxyStorage) StoreIndexation(index []byte, messageID hornet.MessageID) *storage.CachedIndexation

func (*ProxyStorage) StoreMessageIfAbsent

func (s *ProxyStorage) StoreMessageIfAbsent(message *storage.Message) (cachedMsg *storage.CachedMessage, newlyAdded bool)

StoreMessageInterface

func (*ProxyStorage) StoreMilestoneIfAbsent

func (s *ProxyStorage) StoreMilestoneIfAbsent(index milestone.Index, messageID hornet.MessageID, timestamp time.Time) (*storage.CachedMilestone, bool)

type StoreMessageInterface

type StoreMessageInterface interface {
	StoreMessageIfAbsent(message *storage.Message) (cachedMsg *storage.CachedMessage, newlyAdded bool)
	StoreChild(parentMessageID hornet.MessageID, childMessageID hornet.MessageID) *storage.CachedChild
	StoreIndexation(index []byte, messageID hornet.MessageID) *storage.CachedIndexation
	StoreMilestoneIfAbsent(index milestone.Index, messageID hornet.MessageID, timestamp time.Time) (*storage.CachedMilestone, bool)
}