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
- API
  
  Reference documentation for the pkg.go.dev API
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

config

package module

Go to main page

Versions in this module

v1

v1.2.0

Jun 7, 2026

Changes in this version

+ const BootstrapIDsKey

+ const BootstrapIPsKey

+ const BootstrapNodesKey

+ const ChainConfigDirKey

+ const ChainsDir

+ const ConfigFile

+ const ConfigFileKey

+ const ConfigFileName

+ const CurrentPluginsDir

+ const DBPathKey

+ const DBTypeKey

+ const DataDirKey

+ const DefaultDataDir

+ const EnvPrefix

+ const GenesisFile

+ const GenesisFileKey

+ const HTTPHostKey

+ const HTTPPortKey

+ const IndexAllowIncompleteKey

+ const IndexEnabledKey

+ const KeysDir

+ const LogCompressKey

+ const LogDirKey

+ const LogFormatKey

+ const LogLevelKey

+ const LogMaxAgeKey

+ const LogMaxFilesKey

+ const LogMaxSizeKey

+ const LogShowCallerKey

+ const LogShowColorsKey

+ const LogsDirKey

+ const LuxDir

+ const LuxNodeDataDirVar

+ const NetConfigDirKey

+ const NetworkAPIEndpointKey

+ const NetworkAllowPrivateIPsKey

+ const NetworkIDKey

+ const NetworkLocal

+ const NetworkMainnet

+ const NetworkNameKey

+ const NetworkTestnet

+ const NetworksDir

+ const PartialSyncPrimaryNetworkKey

+ const PluginDirKey

+ const PluginsDir

+ const RunPrefix

+ const RunsDir

+ const SignerKeyFile

+ const SnapshotsDir

+ const StakingCertFile

+ const StakingCertPathKey

+ const StakingKeyFile

+ const StakingPortKey

+ const StakingSignerKeyPathKey

+ const StakingTLSKeyPathKey

+ const SybilProtectionEnabledKey

+ const TrackChainsKey

+ const UpgradeFile

+ const VMNameCoreVM

+ const VMNameLuxEVM

+ const VMNameXVM

+ var FlagDescriptions = map[string]string

+ func AddAllFlags(fs *pflag.FlagSet)

+ func AddGlobalFlags(fs *pflag.FlagSet)

+ func AddLogFlags(fs *pflag.FlagSet)

+ func AddNetworkFlags(fs *pflag.FlagSet)

+ func AddNodeFlags(fs *pflag.FlagSet)

+ func CreateDevelopmentLogger(name string) (*zap.Logger, error)

+ func CreateNopLogger() *zap.Logger

+ func CreateProductionLogger(name string, logDir string) (*zap.Logger, error)

+ func Exists(path string) bool

+ func FormatError(err error, context string, args ...interface{}) string

+ func GPUBackend() string

+ func GetChainIDFromGenesis(genesis []byte) (uint64, error)

+ func GetFlagDescription(key string) string

+ func IsGPUEnabled() bool

+ func IsSymlink(path string) bool

+ func NewRunID() string

+ func ResolvePluginBaseDir() string

+ func ResolvePluginDir() string

+ func SetGlobal(cfg *LuxConfig)

+ func SetGlobalGPUConfig(cfg GPUConfig) error

+ func VMID(vmName string) string

+ func WellKnownVMIDs() map[string]string

+ type AirdropConfig struct

+ ClaimPeriod uint64

+ ConversionRatio float64

+ Enabled bool

+ SnapshotDate string

+ VestingPeriod uint64

+ type ChainConfig struct

+ Config json.RawMessage

+ Genesis json.RawMessage

+ Name string

+ Upgrade json.RawMessage

+ type ChainManager struct

+ func DefaultChainManager() (*ChainManager, error)

+ func NewChainManager(paths *Paths) *ChainManager

+ func (cm *ChainManager) ChainExists(chainName string) bool

+ func (cm *ChainManager) CopyChainConfigsToNode(chainName, chainID, nodeDir string) error

+ func (cm *ChainManager) DeleteChain(chainName string) error

+ func (cm *ChainManager) ListChains() ([]string, error)

+ func (cm *ChainManager) LoadChain(chainName string) (*ChainConfig, error)

+ func (cm *ChainManager) LoadGenesis(chainName string) ([]byte, error)

+ func (cm *ChainManager) SaveChain(cc *ChainConfig) error

+ func (cm *ChainManager) SaveGenesis(chainName string, genesis []byte) error

+ type ChainStakeRequirement struct

+ AccessRequirements string

+ ChainID string

+ MinimumStake uint64

+ RequiresSpecialAccess bool

+ type DefaultPluginManager struct

+ func (pm *DefaultPluginManager) EnsureDir() error

+ func (pm *DefaultPluginManager) Exists(vmID string) bool

+ func (pm *DefaultPluginManager) Get(ctx context.Context, vmID string) (*PluginInfo, error)

+ func (pm *DefaultPluginManager) GetPath(vmID string) string

+ func (pm *DefaultPluginManager) GetPluginDir() string

+ func (pm *DefaultPluginManager) GetTarget(vmID string) (string, error)

+ func (pm *DefaultPluginManager) Install(ctx context.Context, source string, vmID string) error

+ func (pm *DefaultPluginManager) IsSymlink(vmID string) bool

+ func (pm *DefaultPluginManager) Link(vmID, binaryPath string) error

+ func (pm *DefaultPluginManager) LinkByName(vmName, binaryPath string) error

+ func (pm *DefaultPluginManager) List(ctx context.Context) ([]PluginInfo, error)

+ func (pm *DefaultPluginManager) Uninstall(ctx context.Context, vmID string) error

+ func (pm *DefaultPluginManager) Verify(vmID string) error

+ type GPUConfig struct

+ Backend string

+ DeviceIndex int

+ Enabled bool

+ LogLevel string

+ func DefaultGPUConfig() GPUConfig

+ func GetGlobalGPUConfig() GPUConfig

+ func (c GPUConfig) ResolveBackend() string

+ func (c GPUConfig) Validate() error

+ type Loader struct

+ func NewLoader(opts ...LoaderOption) *Loader

+ func (l *Loader) BindFlags(fs *pflag.FlagSet) error

+ func (l *Loader) GetConfigFilePath() string

+ func (l *Loader) Load() (*LuxConfig, error)

+ type LoaderOption func(*Loader)

+ func WithConfigFile(path string) LoaderOption

+ func WithConfigPaths(paths ...string) LoaderOption

+ type LogConfig struct

+ Compress bool

+ Directory string

+ Format string

+ Level string

+ MaxAge int

+ MaxFiles int

+ MaxSize int

+ ShowCaller bool

+ ShowColors bool

+ type LogFactory struct

+ func NewLogFactory(cfg LogConfig) *LogFactory

+ func NewLogFactoryFromGlobal() *LogFactory

+ func (f *LogFactory) CreateLogger(name string) (*zap.Logger, error)

+ type LogFormat string

+ const LogFormatJSON

+ const LogFormatPlain

+ const LogFormatTerminal

+ type LogLevel string

+ const LogLevelDebug

+ const LogLevelError

+ const LogLevelFatal

+ const LogLevelInfo

+ const LogLevelOff

+ const LogLevelTrace

+ const LogLevelVerbo

+ const LogLevelWarn

+ type LoggerAdapter struct

+ func NewLoggerAdapter(logger *zap.Logger) *LoggerAdapter

+ func (l *LoggerAdapter) Sugared() *zap.SugaredLogger

+ func (l *LoggerAdapter) WithContext(ctx map[string]interface{}) *LoggerAdapter

+ type LuxConfig struct

+ DataDir string

+ Log LogConfig

+ Network NetworkConfig

+ Node NodeConfig

+ PluginDir string

+ func DefaultConfig() *LuxConfig

+ func Global() *LuxConfig

+ func MustLoad(opts ...LoaderOption) *LuxConfig

+ func (c *LuxConfig) GetChainsConfigPath() string

+ func (c *LuxConfig) GetConfigsPath() string

+ func (c *LuxConfig) GetDBPath() string

+ func (c *LuxConfig) GetLogPath(name string) string

+ func (c *LuxConfig) GetNetsConfigPath() string

+ func (c *LuxConfig) GetPluginPath(vmID string) string

+ func (c *LuxConfig) GetStakingPath() string

+ func (c *LuxConfig) GetVMsConfigPath() string

+ func (c *LuxConfig) Validate() error

+ type NFTTier struct

+ MaxValidators uint32

+ Name string

+ RequiredLUX uint64

+ StakingMultiplier uint32

+ type NetworkConfig struct

+ APIEndpoint string

+ ID uint32

+ Name string

+ type NodeConfig struct

+ DBType string

+ HTTPPort int

+ StakingPort int

+ type Paths struct

+ BaseDir string

+ func DefaultPaths() (*Paths, error)

+ func NewPaths(baseDir string) *Paths

+ func (p *Paths) ChainConfig(chainName string) string

+ func (p *Paths) ChainDir(chainName string) string

+ func (p *Paths) ChainGenesis(chainName string) string

+ func (p *Paths) ChainUpgrade(chainName string) string

+ func (p *Paths) ChainsBaseDir() string

+ func (p *Paths) CurrentPluginsDir() string

+ func (p *Paths) EnsureChainDir(chainName string) error

+ func (p *Paths) EnsureCurrentPluginsDir() error

+ func (p *Paths) EnsureDir(path string) error

+ func (p *Paths) EnsureNetworkRunsDir(networkName string) error

+ func (p *Paths) EnsureNodeKeysDir(networkName, nodeName string) error

+ func (p *Paths) FindLatestRun(networkName string) (string, error)

+ func (p *Paths) GetOrCreateRun(networkName string) (string, error)

+ func (p *Paths) KeysBaseDir() string

+ func (p *Paths) NetworkDir(networkName string) string

+ func (p *Paths) NetworkKeysDir(networkName string) string

+ func (p *Paths) NetworkRunDir(networkName, runID string) string

+ func (p *Paths) NetworkRunsDir(networkName string) string

+ func (p *Paths) NetworksBaseDir() string

+ func (p *Paths) NodeDir(networkName, runID, nodeName string) string

+ func (p *Paths) NodeKeysDir(networkName, nodeName string) string

+ func (p *Paths) NodeSignerKey(networkName, nodeName string) string

+ func (p *Paths) NodeStakingCert(networkName, nodeName string) string

+ func (p *Paths) NodeStakingKey(networkName, nodeName string) string

+ func (p *Paths) PluginPath(vmID string) string

+ func (p *Paths) PluginsBaseDir() string

+ func (p *Paths) SnapshotDir(snapshotName string) string

+ func (p *Paths) SnapshotsBaseDir() string

+ type PluginInfo struct

+ Description string

+ Installed bool

+ ModTime time.Time

+ Name string

+ Path string

+ Size int64

+ VMID string

+ Version string

+ type PluginManager interface

+ EnsureDir func() error

+ Exists func(vmID string) bool

+ Get func(ctx context.Context, vmID string) (*PluginInfo, error)

+ GetPath func(vmID string) string

+ GetPluginDir func() string

+ Install func(ctx context.Context, source string, vmID string) error

+ List func(ctx context.Context) ([]PluginInfo, error)

+ Uninstall func(ctx context.Context, vmID string) error

+ func NewPluginManager(cfg *LuxConfig) PluginManager

+ func NewPluginManagerWithDir(pluginDir string) PluginManager

+ type PluginManifest struct

+ Aliases []string

+ Binary string

+ Description string

+ InstalledAt time.Time

+ Name string

+ Org string

+ Repository string

+ Size int64

+ VMID string

+ VMName string

+ Version string

+ type PluginPackageManager struct

+ func NewPluginPackageManager(baseDir string) (*PluginPackageManager, error)

+ func (pm *PluginPackageManager) Activate(ctx context.Context, org, name, version string) error

+ func (pm *PluginPackageManager) ActivePath(vmid string) string

+ func (pm *PluginPackageManager) GetActiveDir() string

+ func (pm *PluginPackageManager) GetManifest(org, name, version string) (*PluginManifest, error)

+ func (pm *PluginPackageManager) Install(ctx context.Context, manifest *PluginManifest, binaryPath string) error

+ func (pm *PluginPackageManager) Link(ctx context.Context, manifest *PluginManifest, binaryPath string) error

+ func (pm *PluginPackageManager) List(ctx context.Context) ([]PluginManifest, error)

+ func (pm *PluginPackageManager) ListActive(ctx context.Context) (map[string]PluginManifest, error)

+ func (pm *PluginPackageManager) MigrateFromLegacy(ctx context.Context, legacyDir string) error

+ func (pm *PluginPackageManager) PackagePath(org, name, version string) string

+ func (pm *PluginPackageManager) Uninstall(ctx context.Context, org, name, version string) error

+ type PluginRegistry struct

+ Active map[string]string

+ Plugins map[string][]string

+ UpdatedAt time.Time

+ type StakingConfig struct

+ AllowCombinedStaking bool

+ ChainValidatorRequirements map[string]ChainStakeRequirement

+ MaxDelegationRatio uint32

+ MinimumDelegatorStake uint64

+ MinimumValidatorStake uint64

+ NFTStakingEnabled bool

+ NFTTiers []NFTTier

+ type TokenomicsConfig struct

+ AirdropConfig AirdropConfig

+ ChainAllocations map[string]uint64

+ StakingConfig StakingConfig

+ TotalSupply uint64

+ func DefaultTokenomicsConfig() *TokenomicsConfig

+ func (c *TokenomicsConfig) GetMinimumStake(hasNFT bool, nftTier string) uint64

+ func (c *TokenomicsConfig) GetStakingMultiplier(nftTier string) uint32

v1.1.2

Feb 14, 2026

v1.1.1

Jan 9, 2026

v1.1.0

Jan 5, 2026

v1.0.0

Dec 22, 2025