Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

nodeutils

package

Go to main page

Versions in this module

v2

v2.2.1

Feb 6, 2026

v2.2.0

Jan 11, 2026

Changes in this version

+ type MockStats struct

+ func NewMockStats() *MockStats

+ func (m *MockStats) GetCPU() float64

+ func (m *MockStats) GetMemory() uint64

+ func (m *MockStats) SetCPU(cores float64)

+ func (m *MockStats) SetCPUMillicores(millicores int64)

+ func (m *MockStats) SetMemory(bytes uint64)

+ func (m *MockStats) SetMemoryGiB(gib float64)

+ func (m *MockStats) SetMemoryMiB(mib int64)

type Option

+ func WithMockMode(enable bool) Option

type Options

+ MockMode bool

+ type StatsClient interface

+ GetCPUStats func(ctx context.Context, since time.Duration) (float64, error)

+ GetMemoryStats func(ctx context.Context, since time.Duration) (uint64, error)

v2.2.0-rc.1

Jan 5, 2026

v2.1.1

Dec 24, 2025

v2.1.0

Dec 23, 2025

v2.0.1

Dec 23, 2025

v2.0.0

Dec 22, 2025

Changes in this version

+ const DefaultDataPath

+ const DefaultHost

+ const DefaultPort

+ const DefaultTraceStore

+ const DefaultUpgradesConfig

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

+ type Client struct

+ func NewClient(host string) *Client

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

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

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

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

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

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

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

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

+ type NodeUtils struct

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

+ func (s *NodeUtils) Start() error

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

+ func (s *NodeUtils) StopNode() error

+ type Option func(*Options)

+ func CreateFifo(create bool) Option

+ func WithBlockThreshold(n time.Duration) Option

+ func WithDataPath(path string) Option

+ func WithHaltHeight(height int64) Option

+ func WithHost(s string) Option

+ func WithPort(v int) Option

+ func WithTmkmsProxy(enable bool) Option

+ func WithTraceStore(path string) Option

+ func WithUpgradesConfig(path string) Option

+ type Options struct

+ BlockThreshold time.Duration

+ CreateFifo bool

+ DataPath string

+ HaltHeight int64

+ Host string

+ Port int

+ TmkmsProxy bool

+ TraceStore string

+ UpgradesConfig string

+ type ProcessStats struct

+ CPUTimeSec float64

+ MemoryRSS uint64

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

+ type Upgrade struct

+ Height int64

+ Image string

+ Source UpgradeSource

+ Status string

+ type UpgradeChecker struct

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

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

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

+ func (u *UpgradeChecker) WatchConfigFile() error

+ type UpgradeSource string

+ const ManualUpgrade

+ const OnChainUpgrade

+ const UpgradeScheduled

+ type UpgradesConfig struct

+ Upgrades []Upgrade