Help us shape the future of Go! Take the 2026 Go Developer Survey

admin

package
v1.1.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 16, 2026 License: BSD-3-Clause Imports: 3 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AliasArgs

type AliasArgs struct {
	Endpoint string `json:"endpoint"`
	Alias    string `json:"alias"`
}

AliasArgs are the arguments for calling Alias.

type AliasChainArgs

type AliasChainArgs struct {
	Chain string `json:"chain"`
	Alias string `json:"alias"`
}

AliasChainArgs are the arguments for calling AliasChain.

type DBGetArgs

type DBGetArgs struct {
	Key string `json:"key"`
}

DBGetArgs are the arguments for DBGet.

type DBGetReply

type DBGetReply struct {
	Value string `json:"value"`
}

DBGetReply is the reply for DBGet.

type EmptyReply

type EmptyReply = types.EmptyReply

EmptyReply is an alias to common empty reply.

type GetChainAliasesArgs

type GetChainAliasesArgs struct {
	Chain string `json:"chain"`
}

GetChainAliasesArgs are the arguments for calling GetChainAliases.

type GetChainAliasesReply

type GetChainAliasesReply struct {
	Aliases []string `json:"aliases"`
}

GetChainAliasesReply are the aliases of the given chain.

type GetLoggerLevelArgs

type GetLoggerLevelArgs struct {
	LoggerName string `json:"loggerName"`
}

GetLoggerLevelArgs are the arguments for getting logger levels.

type GetTrackedChainsReply

type GetTrackedChainsReply struct {
	TrackedChains []string `json:"trackedChains"`
}

GetTrackedChainsReply is the response for GetTrackedChains.

type ListVMsReply

type ListVMsReply struct {
	VMs map[string]VMInfo `json:"vms"`
}

ListVMsReply contains the response for ListVMs.

type LoadArgs

type LoadArgs struct {
	Path string `json:"path"`
}

LoadArgs are the arguments for Load.

type LoadVMsReply

type LoadVMsReply struct {
	NewVMs        map[ids.ID][]string `json:"newVMs"`
	FailedVMs     map[ids.ID]string   `json:"failedVMs"`
	ChainsRetried int                 `json:"chainsRetried"`
}

LoadVMsReply contains the response for LoadVMs.

type LogAndDisplayLevels

type LogAndDisplayLevels struct {
	LogLevel     string `json:"logLevel"`
	DisplayLevel string `json:"displayLevel"`
}

LogAndDisplayLevels pairs log and display levels.

type LoggerLevelReply

type LoggerLevelReply struct {
	LoggerLevels map[string]LogAndDisplayLevels `json:"loggerLevels"`
}

LoggerLevelReply are the levels of the loggers.

type Service

type Service interface {
	StartCPUProfiler(ctx context.Context) (*EmptyReply, error)
	StopCPUProfiler(ctx context.Context) (*EmptyReply, error)
	MemoryProfile(ctx context.Context) (*EmptyReply, error)
	LockProfile(ctx context.Context) (*EmptyReply, error)

	Alias(ctx context.Context, args *AliasArgs) (*EmptyReply, error)
	AliasChain(ctx context.Context, args *AliasChainArgs) (*EmptyReply, error)
	GetChainAliases(ctx context.Context, args *GetChainAliasesArgs) (*GetChainAliasesReply, error)

	Stacktrace(ctx context.Context) (*EmptyReply, error)
	SetLoggerLevel(ctx context.Context, args *SetLoggerLevelArgs) (*EmptyReply, error)
	GetLoggerLevel(ctx context.Context, args *GetLoggerLevelArgs) (*LoggerLevelReply, error)
	GetConfig(ctx context.Context) (any, error)

	LoadVMs(ctx context.Context) (*LoadVMsReply, error)
	DbGet(ctx context.Context, args *DBGetArgs) (*DBGetReply, error)
	ListVMs(ctx context.Context) (*ListVMsReply, error)

	SetTrackedChains(ctx context.Context, args *SetTrackedChainsArgs) (*SetTrackedChainsReply, error)
	GetTrackedChains(ctx context.Context) (*GetTrackedChainsReply, error)

	// Snapshot creates a database backup to the specified path.
	// Use .zst extension for zstd compression.
	// since: 0 for full backup, or version from last backup for incremental.
	// Returns the version number for future incremental backups.
	Snapshot(ctx context.Context, args *SnapshotArgs) (*SnapshotReply, error)

	// Load restores the database from a backup file.
	// Detects compression from .zst extension.
	Load(ctx context.Context, args *LoadArgs) (*EmptyReply, error)
}

Service defines the admin API contract.

type SetLoggerLevelArgs

type SetLoggerLevelArgs struct {
	LoggerName   string `json:"loggerName"`
	LogLevel     string `json:"logLevel"`
	DisplayLevel string `json:"displayLevel"`
}

SetLoggerLevelArgs are the arguments for setting a logger's levels.

type SetTrackedChainsArgs

type SetTrackedChainsArgs struct {
	Chains []string `json:"chains"`
}

SetTrackedChainsArgs are the arguments for SetTrackedChains.

type SetTrackedChainsReply

type SetTrackedChainsReply struct {
	TrackedChains []string `json:"trackedChains"`
}

SetTrackedChainsReply is the response for SetTrackedChains.

type SnapshotArgs

type SnapshotArgs struct {
	Path  string `json:"path"`
	Since uint64 `json:"since"`
}

SnapshotArgs are the arguments for Snapshot.

type SnapshotReply

type SnapshotReply struct {
	Version uint64 `json:"version"`
}

SnapshotReply is the response for Snapshot.

type VMInfo

type VMInfo struct {
	ID      string   `json:"id"`
	Aliases []string `json:"aliases"`
	Path    string   `json:"path,omitempty"`
}

VMInfo contains information about a registered VM.

Jump to

Keyboard shortcuts

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