nodeutils

package

v2.1.1 Latest Latest Go to latest Published: Dec 24, 2025 License: MIT Imports: 27 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/voluzi/cosmopilot

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func StateSyncChunkMetricsExist(ctx context.Context, metricsURL string) (bool, error)
type Client
- func NewClient(host string) *Client
type NodeUtils
- func New(nodeBinaryName string, opts ...Option) (*NodeUtils, error)
type Option
type Options
type ProcessStats
- func GetProcessStats(proc *process.Process) (*ProcessStats, error)
type Upgrade
type UpgradeChecker
- func NewUpgradeChecker(configFile string) (*UpgradeChecker, error)
type UpgradeSource
type UpgradesConfig

Constants ¶

View Source

const (
	// DefaultPort is the default port for the node-utils HTTP server.
	DefaultPort = 8000

	// DefaultHost is the default host for the node-utils HTTP server.
	DefaultHost = "0.0.0.0"

	// DefaultDataPath is the default path to the node's data directory.
	DefaultDataPath = "/home/app/data"

	// DefaultUpgradesConfig is the default path to the upgrades configuration file.
	DefaultUpgradesConfig = "/config/upgrades.json"

	// DefaultTraceStore is the default path to the trace store FIFO.
	DefaultTraceStore = "/trace/trace.fifo"
)

Variables ¶

This section is empty.

Functions ¶

func StateSyncChunkMetricsExist ¶

func StateSyncChunkMetricsExist(ctx context.Context, metricsURL string) (bool, error)

Types ¶

type Client ¶

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

Client provides methods to interact with the node-utils HTTP server.

func NewClient ¶

func NewClient(host string) *Client

NewClient creates a new node-utils client for the given host. The host should be a hostname or IP address without scheme or port.

func (*Client) GetCPUStats ¶

func (c *Client) GetCPUStats(ctx context.Context, since time.Duration) (float64, error)

GetCPUStats returns the CPU usage percentage. If since is greater than 0, it returns the average over that duration.

func (*Client) GetDataSize ¶

func (c *Client) GetDataSize(ctx context.Context) (int64, error)

GetDataSize returns the current size of the node's data directory in bytes.

func (*Client) GetLatestHeight ¶

func (c *Client) GetLatestHeight(ctx context.Context) (int64, error)

GetLatestHeight returns the latest block height from the blockchain node.

func (*Client) GetMemoryStats ¶

func (c *Client) GetMemoryStats(ctx context.Context, since time.Duration) (uint64, error)

GetMemoryStats returns the memory usage in bytes. If since is greater than 0, it returns the average over that duration.

func (*Client) IsStateSyncing ¶

func (c *Client) IsStateSyncing(ctx context.Context) (bool, error)

IsStateSyncing returns true if the node is currently performing state-sync.

func (*Client) ListSnapshots ¶

func (c *Client) ListSnapshots(ctx context.Context) ([]int64, error)

ListSnapshots returns a list of available snapshot heights.

func (*Client) RequiresUpgrade ¶

func (c *Client) RequiresUpgrade(ctx context.Context) (bool, error)

RequiresUpgrade checks if the node requires an upgrade. Returns true if an upgrade is required, false otherwise.

func (*Client) ShutdownNodeUtilsServer ¶

func (c *Client) ShutdownNodeUtilsServer(ctx context.Context) error

ShutdownNodeUtilsServer sends a shutdown signal to the node-utils server.

type NodeUtils ¶

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

func New ¶

func New(nodeBinaryName string, opts ...Option) (*NodeUtils, error)

func (*NodeUtils) Start ¶

func (s *NodeUtils) Start() error

func (*NodeUtils) Stop ¶

func (s *NodeUtils) Stop(force bool) error

func (*NodeUtils) StopNode ¶

func (s *NodeUtils) StopNode() error

type Option ¶

type Option func(*Options)

func CreateFifo ¶

func CreateFifo(create bool) Option

func WithBlockThreshold ¶

func WithBlockThreshold(n time.Duration) Option

func WithDataPath ¶

func WithDataPath(path string) Option

func WithHaltHeight ¶

func WithHaltHeight(height int64) Option

func WithHost ¶

func WithHost(s string) Option

func WithPort ¶

func WithPort(v int) Option

func WithTmkmsProxy ¶

func WithTmkmsProxy(enable bool) Option

func WithTraceStore ¶

func WithTraceStore(path string) Option

func WithUpgradesConfig ¶

func WithUpgradesConfig(path string) Option

type Options ¶

type Options struct {
	Host           string
	Port           int
	DataPath       string
	BlockThreshold time.Duration
	UpgradesConfig string
	TraceStore     string
	CreateFifo     bool
	TmkmsProxy     bool
	HaltHeight     int64
}

type ProcessStats ¶

type ProcessStats struct {
	CPUTimeSec float64 `json:"cpu_time_sec"`     // total CPU time in seconds
	MemoryRSS  uint64  `json:"memory_rss_bytes"` // resident memory usage
}

func GetProcessStats ¶

func GetProcessStats(proc *process.Process) (*ProcessStats, error)

GetProcessStats extracts CPU + memory usage from a gopsutil Process

type Upgrade ¶

type Upgrade struct {
	Height int64         `json:"height"`
	Status string        `json:"status"`
	Image  string        `json:"image"`
	Source UpgradeSource `json:"source"`
}

type UpgradeChecker ¶

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

func NewUpgradeChecker ¶

func NewUpgradeChecker(configFile string) (*UpgradeChecker, error)

func (*UpgradeChecker) GetUpgrade ¶

func (u *UpgradeChecker) GetUpgrade(height int64) (*Upgrade, error)

func (*UpgradeChecker) ShouldUpgrade ¶

func (u *UpgradeChecker) ShouldUpgrade(height int64) bool

func (*UpgradeChecker) WatchConfigFile ¶

func (u *UpgradeChecker) WatchConfigFile() error

type UpgradeSource ¶

type UpgradeSource string

const (
	UpgradeScheduled = "scheduled"

	ManualUpgrade  UpgradeSource = "manual"
	OnChainUpgrade UpgradeSource = "on-chain"
)

type UpgradesConfig ¶

type UpgradesConfig struct {
	Upgrades []Upgrade `json:"upgrades"`
}

Source Files ¶

View all Source files

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