constants

package
v1.21.42 Latest Latest
Warning

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

 Go to latest Published: Dec 24, 2025 License: BSD-3-Clause Imports: 3 Imported by: 0

Documentation

Overview

Copyright (C) 2022-2025, Lux Industries Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022-2025, Lux Industries, Inc. All rights reserved. See the file LICENSE for licensing terms.

Copyright (C) 2022-2025, Lux Industries, Inc. All rights reserved. See the file LICENSE for licensing terms.

Index

Constants

View Source 
const (
	DefaultPerms755    = 0o755
	WriteReadReadPerms = 0o644

	BaseDirName = ".lux"
	LogDir      = "logs"

	ServerRunFile = "gRPCserver.run"
	LuxCliBinDir  = "bin"
	RunDir        = "runs"

	SuffixSeparator            = "_"
	SidecarFileName            = "sidecar.json"
	GenesisFileName            = "genesis.json"
	ElasticChainConfigFileName = "elastic_chain_config.json"
	NodeConfigJSONFile         = "node-config.json"
	NodeConfigFileName         = "node-config.json"
	SidecarSuffix              = SuffixSeparator + SidecarFileName
	GenesisSuffix              = SuffixSeparator + GenesisFileName
	NodeFileName               = "node.json"

	SidecarVersion             = "1.4.0"
	LatestPreReleaseVersionTag = "latest-prerelease"
	LatestReleaseVersionTag    = "latest"

	MaxLogFileSize   = 4
	MaxNumOfLogFiles = 5
	RetainOldFiles   = 0 // retain all old log files

	// RequestTimeout increased from 3 to 10 minutes to match netrunner's
	// waitForHealthyTimeout for proper mainnet validator bootstrapping
	RequestTimeout         = 10 * time.Minute
	E2ERequestTimeout      = 30 * time.Second
	ANRRequestTimeout      = 10 * time.Minute
	APIRequestTimeout      = 30 * time.Second
	APIRequestLargeTimeout = 2 * time.Minute

	SimulatePublicNetwork = "SIMULATE_PUBLIC_NETWORK"
	TestnetAPIEndpoint    = "https://api.lux-test.network"
	MainnetAPIEndpoint    = "http://127.0.0.1:9630" // Local mainnet for development

	// WebSocket endpoints
	MainnetWSEndpoint = "ws://127.0.0.1:9630/ext/bc/C/ws" // Local mainnet WS for development
	TestnetWSEndpoint = "wss://api.lux-test.network/ext/bc/C/ws"

	// Default values for relayer and validators
	DefaultRelayerAmount = float64(10)

	// Metrics
	MetricsNetwork   = "network"
	LocalWSEndpoint  = "ws://127.0.0.1:9630/ext/bc/C/ws"
	DevnetWSEndpoint = "wss://api.lux-dev.network/ext/bc/C/ws"

	// Cloud service constants
	GCPCloudService            = "gcp"
	AWSCloudService            = "aws"
	E2EDocker                  = "e2e-docker"
	E2EClusterName             = "e2e-test-cluster"
	E2ENetworkPrefix           = "10.0.0"
	E2EBaseDirName             = ".e2e-test"
	AnsibleInventoryDir        = "ansible/inventory"
	GCPNodeAnsiblePrefix       = "gcp_node"
	AWSNodeAnsiblePrefix       = "aws_node"
	E2EDockerLoopbackHost      = "127.0.0.1"
	GCPDefaultImageProvider    = "canonical"
	GCPImageFilter             = "ubuntu-os-cloud"
	CloudNodeCLIConfigBasePath = "/home/ubuntu/.lux"
	CodespaceNameEnvVar        = "CODESPACE_NAME"
	AnsibleSSHShellParams      = "-o StrictHostKeyChecking=no"
	RemoteSSHUser              = "ubuntu"
	StakerCertFileName         = "staker.crt"
	StakerKeyFileName          = "staker.key"
	BLSKeyFileName             = "bls.key"
	RingtailKeyFileName        = "ringtail.key"
	MLDSAKeyFileName           = "mldsa.key"
	ValidatorUptimeDeductible  = 5 * time.Minute

	// SSH constants
	SSHSleepBetweenChecks = 1 * time.Second
	SSHFileOpsTimeout     = 10 * time.Second
	SSHScriptTimeout      = 120 * time.Second
	SSHPOSTTimeout        = 30 * time.Second
	SSHDirOpsTimeout      = 30 * time.Second

	// Docker constants
	DockerNodeConfigPath   = "/data/.luxgo/configs"
	WriteReadUserOnlyPerms = 0o600

	// AWS constants
	AWSCloudServerRunningState = "running"

	// this depends on bootstrap snapshot
	LocalAPIEndpoint                 = "http://127.0.0.1:9630"
	DevnetAPIEndpoint                = "https://api.lux-dev.network"
	LocalNetworkID                   = 1337
	DefaultNumberOfLocalMachineNodes = 5
	LocalNetworkNumNodes             = 5

	DefaultTokenName = "TEST"

	// Default versions
	DefaultLuxdVersion = "v1.21.0"

	// Staking constants
	BootstrapValidatorBalanceNanoLUX = 1_000_000_000_000 // 1000 LUX
	BootstrapValidatorWeight         = 20                // Default validator weight
	PoSL1MinimumStakeDurationSeconds = 86400             // 24 hours

	// Logging
	DefaultAggregatorLogLevel = "INFO"

	// Git
	GitExtension = ".git"

	// Ansible
	AnsibleHostInventoryFileName = "hosts"
	AnsibleSSHUseAgentParams     = "-o ForwardAgent=yes"

	// Cloud node
	CloudNodeConfigPath           = "/home/ubuntu/.luxgo/configs"
	CloudNodePrometheusConfigPath = "/home/ubuntu/.luxgo/configs/prometheus"
	CloudNodeStakingPath          = "/home/ubuntu/.luxgo/staking"
	UpgradeFileName               = "upgrade.json"
	NodePrometheusConfigFileName  = "prometheus.yml"
	ServicesDir                   = "services"
	WarpRelayerInstallDir         = "warp-relayer"
	WarpRelayerConfigFilename     = "warp-relayer.yml"

	// Config keys
	ConfigSnapshotsAutoSaveKey = "SnapshotsAutoSaveEnabled"
	ConfigUpdatesDisabledKey   = "UpdatesDisabled"

	// Build environment
	BuildEnvGolangVersion = "1.24.5"

	// Docker images and repos
	LuxdDockerImage = "luxfi/luxd"
	LuxdGitRepo     = "https://github.com/luxfi/node"
	LuxdRepoName    = "node"

	// Organizations
	LuxOrg = "luxfi"

	// Repo names
	LuxRepoName = "node"
	EVMRepoName = "evm"

	// Install directories
	LuxInstallDir     = "lux"
	LuxNodeInstallDir = "luxd"
	LuxGoInstallDir   = "luxd" // Deprecated: use LuxNodeInstallDir
	EVMInstallDir     = "evm"

	// Directories
	ChainsDir        = "chains" // Canonical chain definitions (genesis, sidecar)
	ReposDir         = "repos"
	SnapshotsDirName = "snapshots"
	CustomVMDir      = "customvms"
	PluginDir        = "plugins"
	ConfigDir        = "config"
	KeyDir           = "keys"
	LPMPluginDir     = "lpm-plugins"

	// Unified Chain Config Directories
	// All nodes share these directories for consistent chain configuration
	NetworksDir      = "networks"        // ~/.lux/networks/ - persistent network state
	CurrentPluginDir = "plugins/current" // Active plugins symlinked here

	// Unified chain config file names (used in ~/.lux/chains/<chainName>/)
	ChainConfigFile         = "config.json"  // Chain-specific config (eth-apis, etc.)
	UnifiedChainGenesisFile = "genesis.json" // Chain genesis
	UnifiedChainUpgradeFile = "upgrade.json" // Chain upgrades

	// Network structure: ~/.lux/networks/<networkName>/runs/<runID>/
	// This keeps network state persistent across runs
	NetworkRunsDir = "runs"

	// Cloud node paths
	CloudNodeEVMBinaryPath = "/home/ubuntu/.lux/bin/evm"

	// File names
	UpgradeBytesFileName         = "upgrade.json"
	LPMLogName                   = "lpm.log"
	OldConfigFileName            = ".cli-config.json"
	OldMetricsConfigFileName     = ".cli-metrics.json"
	ConfigLPMAdminAPIEndpointKey = "lpm-admin-api-endpoint"
	ConfigLPMCredentialsFileKey  = "lpm-credentials-file"

	// Devnet flags
	DevnetFlagsProposerVMUseCurrentHeight = true // This is a boolean flag

	// Validator constants
	BootstrapValidatorBalanceLUX      = 1000000000000000 // 1M LUX in nanoLUX
	DefaultValidationIDExpiryDuration = 48 * time.Hour
	MaxL1TotalWeightChange            = 0.2              // 20% max weight change
	SignatureAggregatorTimeout        = 60 * time.Second // Timeout for signature aggregator

	// File names
	AliasesFileName = "aliases.json"

	// Directories
	DashboardsDir = "dashboards"

	// Grafana
	CustomGrafanaDashboardJSON = "custom_dashboard.json"

	// Config metrics keys
	ConfigMetricsUserIDKey        = "metrics-user-id"
	ConfigMetricsEnabledKey       = "metrics-enabled"
	ConfigAuthorizeCloudAccessKey = "authorize-cloud-access"

	// Environment variables
	MetricsAPITokenEnvVarName = "METRICS_API_TOKEN"

	HealthCheckInterval = 100 * time.Millisecond

	// it's unlikely anyone would want to name a snapshot `default`
	// but let's add some more entropy
	DefaultSnapshotName          = "default-1654102509"
	BootstrapSnapshotArchiveName = "bootstrapSnapshot.tar.gz"
	BootstrapSnapshotLocalPath   = "assets/" + BootstrapSnapshotArchiveName
	BootstrapSnapshotURL         = "https://github.com/luxfi/cli/raw/main/" + BootstrapSnapshotLocalPath
	BootstrapSnapshotSHA256URL   = "https://github.com/luxfi/cli/raw/main/assets/sha256sum.txt"

	CliInstallationURL    = "https://raw.githubusercontent.com/luxfi/cli/main/scripts/install.sh"
	ExpectedCliInstallErr = "resource temporarily unavailable"

	KeySuffix  = ".pk"
	YAMLSuffix = ".yml"

	Enable = "enable"

	// AWS constants
	AWSGP3DefaultThroughput = 125
	AWSGP3DefaultIOPS       = 3000
	AWSDefaultCredential    = "default"
	AWSVolumeTypeGP3        = "gp3"
	AWSVolumeTypeIO1        = "io1"
	AWSVolumeTypeIO2        = "io2"

	Disable = "disable"

	TimeParseLayout = "2006-01-02 15:04:05"

	LuxCLISuffix              = "-lux-cli"
	E2EDockerComposeFile      = "docker-compose-e2e.yml"
	LuxdMachineMetricsPort    = "9091"
	LuxdMachineMetricsPortInt = 9091
	LoadTestRole              = "load-test"
	LoadTestDir               = "loadtest"

	// EVM constants
	EVMArchive    = "evm_%s_linux_amd64.tar.gz"
	EVMReleaseURL = "https://github.com/luxfi/evm/releases/download/%s/%s"

	// Key names for signing
	PlatformKeyName = "platformvm"
	EVMKeyName      = "evm"
	XVMKeyName      = "xvm"

	// Primary network validation constants
	PrimaryNetworkValidatingStartLeadTimeNodeCmd = 5 * time.Minute
	PrimaryNetworkValidatingStartLeadTime        = 2 * time.Minute
	DefaultTestnetStakeDuration                  = 7 * 24 * time.Hour  // 1 week
	DefaultMainnetStakeDuration                  = 14 * 24 * time.Hour // 2 weeks

	// Currency symbols
	LUXSymbol = "LUX"

	// GCP constants
	GCPDefaultAuthKeyPath = ".gcp/auth_key.json"
	GCPEnvVar             = "GOOGLE_APPLICATION_CREDENTIALS"

	// Cluster constants
	ClusterYAMLFileName = "cluster.yaml"
	MinStakeDuration    = 24 * 14 * time.Hour
	MaxStakeDuration    = 24 * 365 * time.Hour
	MaxStakeWeight      = 100
	MinStakeWeight      = 1
	DefaultStakeWeight  = 20
	// The absolute minimum is 25 seconds, but set to 1 minute to allow for
	// time to go through the command
	StakingStartLeadTime       = 1 * time.Minute
	StakingMinimumLeadTime     = 25 * time.Second
	DevnetStakingStartLeadTime = 30 * time.Second

	DefaultConfigFileName = ".lux"
	DefaultConfigFileType = "json"

	CliRepoName = "cli"

	EVMBin = "evm"

	DefaultNodeRunURL = "http://127.0.0.1:9630"

	// Latest EVM version
	LatestEVMVersion = "v0.8.13"

	LPMDir = ".lpm"

	// Network ports
	SSHTCPPort      = 22
	LuxdAPIPort     = 9630
	LuxdGrafanaPort = 3000

	// Node roles
	APIRole       = "api"
	ValidatorRole = "validator"

	// Cluster config
	ClustersConfigFileName = "clusters.json"
	MonitorRole            = "monitor"
	WarpRelayerRole        = "warp-relayer"

	// Warp constants
	WarpDir              = "warp"
	WarpBranch           = "main"
	WarpURL              = "https://github.com/luxfi/warp.git"
	WarpKeyName          = "warp"
	WarpVersion          = "v1.0.0"
	WarpRelayerDockerDir = "warp-relayer-docker"

	// Relayer constants
	DefaultRelayerVersion = "v1.0.0"

	// Payment messages
	PayTxsFeesMsg = "pay transaction fees"

	// Units
	OneLux = 1_000_000_000 // 1 LUX = 1e9 nLUX

	// Node types
	DefaultNodeType        = "default"
	AWSDefaultInstanceType = "t3.xlarge"
	GCPDefaultInstanceType = "e2-standard-4"

	// SSH timeouts
	SSHServerStartTimeout = 5 * time.Minute

	// Metrics constants
	MetricsNumRegions          = "num_regions"
	MetricsCloudService        = "cloud_service"
	MetricsNodeType            = "node_type"
	MetricsUseStaticIP         = "use_static_ip"
	MetricsValidatorCount      = "validator_count"
	MetricsAPICount            = "api_count"
	MetricsAWSVolumeType       = "aws_volume_type"
	MetricsAWSVolumeSize       = "aws_volume_size"
	MetricsEnableMonitoring    = "enable_monitoring"
	MetricsCalledFromWiz       = "called_from_wizard"
	MetricsChainVM             = "chain_vm"
	MetricsCustomVMRepoURL     = "custom_vm_repo_url"
	MetricsCustomVMBranch      = "custom_vm_branch"
	MetricsCustomVMBuildScript = "custom_vm_build_script"

	// Ubuntu version
	UbuntuVersionLTS = "22.04"

	// Certificate suffix
	CertSuffix = ".pem"

	// AWS constants
	AWSSecurityGroupSuffix = "-sg"
	EIPLimitErr            = "EIP limit reached"
)
View Source 
const (
	// HTTPAccess values
	HTTPAccessPublic  HTTPAccess = "public"
	HTTPAccessPrivate HTTPAccess = "private"

	// SSH timeouts
	SSHLongRunningScriptTimeout = 10 * time.Minute
	DefaultLuxPackage           = "luxfi/plugins-core"

	// #nosec G101
	GithubAPITokenEnvVarName = "LUX_CLI_GITHUB_TOKEN"

	VMDir          = "vms"
	ChainConfigDir = "chains"

	ChainType                  = "chain type"
	ChainSubnetConfigFile      = "subnet.json" // Subnet/validator config for the chain
	PerNodeChainConfigFileName = "per-node-chain.json"
	CustomAirdrop              = "customAirdrop"
	PrecompileType             = "precompileType"
	NumberOfAirdrops           = "numberOfAirdrops"

	GitRepoCommitName  = "Lux CLI"
	GitRepoCommitEmail = "info@lux.network"

	LuxMaintainers = "luxfi"

	UpgradeBytesLockExtension = ".lock"
	NotAvailableLabel         = "Not available"
	// LuxServerCmd is the base command name for the gRPC backend server
	// Network-specific variants: lux-mainnet-grpc, lux-testnet-grpc, etc.
	LuxServerCmd = "lux-server"
	// BackendCmd is deprecated, use LuxServerCmd instead
	BackendCmd = LuxServerCmd

	// Network-specific gRPC server command names
	// These allow easy identification and management of network-specific servers
	LuxMainnetGRPCCmd = "lux-mainnet-grpc"
	LuxTestnetGRPCCmd = "lux-testnet-grpc"
	LuxDevnetGRPCCmd  = "lux-devnet-grpc"
	LuxCustomGRPCCmd  = "lux-custom-grpc"
)
View Source 
const (
	LuxCompatibilityVersionAdded = "v1.9.2"
	LuxCompatibilityURL          = "https://raw.githubusercontent.com/luxfi/node/master/version/compatibility.json"
	LuxdCompatibilityURL         = LuxCompatibilityURL // Alias for backward compatibility
	EVMRPCCompatibilityURL       = "https://raw.githubusercontent.com/luxfi/evm/main/compatibility.json"
	CLIMinVersionURL             = "https://raw.githubusercontent.com/luxfi/cli/main/min-version.json"
	CLILatestDependencyURL       = CLIMinVersionURL // Alias for backward compatibility

	YesLabel = "Yes"
	NoLabel  = "No"

	// Default Warp Messenger Address
	DefaultWarpMessengerAddress = "0x0000000000000000000000000000000000000005"

	// C-Chain Warp Registry Addresses
	MainnetCChainWarpRegistryAddress = "0x0000000000000000000000000000000000000006"

	ChainIDLabel      = "ChainID: "
	BlockchainIDLabel = "BlockchainID: "

	Network        = "network"
	SkipUpdateFlag = "skip-update-check"
	LastFileName   = ".last_actions.json"

	DefaultWalletCreationTimeout = 5 * time.Second

	DefaultConfirmTxTimeout = 20 * time.Second

	// Cloud and network constants
	CloudOperationTimeout            = 5 * time.Minute
	LuxdP2PPort                      = 9651
	LuxdMonitoringPort               = 9090
	LuxdLokiPort                     = 23101
	GCPStaticIPPrefix                = "lux-"
	CloudServerStorageSize           = 100 // GB
	MonitoringCloudServerStorageSize = 200 // GB
	ErrReleasingGCPStaticIP          = "error releasing GCP static IP"
	IPAddressSuffix                  = "-ip"

	// Local network constants
	ExtraLocalNetworkDataFilename = "extra_local_network_data.json"
	LocalNetworkMetaFile          = "local_network_meta.json"
	FastGRPCDialTimeout           = 3 * time.Second
)

Variables

View Source 
var (
	ErrNoBlockchainID                 = errors.New("\n\nNo blockchainID found. To resolve this:\n- Use 'lux blockchain deploy' to deploy the blockchain and generate a blockchainID.\n- Or use 'lux blockchain import' to import an existing configuration.\n") //nolint:stylecheck
	ErrNoSubnetID                     = errors.New("\n\nNo subnetID found. To resolve this:\n- Use 'lux blockchain deploy' to create the subnet and generate a subnetID.\n- Or use 'lux blockchain import' to import an existing configuration.\n")             //nolint:stylecheck
	ErrInvalidValidatorManagerAddress = errors.New("invalid validator manager address")
	ErrKeyNotFoundOnMap               = errors.New("key not found on map")
)
View Source 
var EtnaActivationTime = map[uint32]time.Time{
	luxconstants.TestnetID: time.Date(2024, time.November, 25, 16, 0, 0, 0, time.UTC),
	luxconstants.MainnetID: time.Date(2024, time.December, 16, 17, 0, 0, 0, time.UTC),
	LocalNetworkID:         time.Unix(0, 0),
}

Functions

func GetServerCmdForNetwork added in v1.21.42 

func GetServerCmdForNetwork(networkType string) string

GetServerCmdForNetwork returns the network-specific gRPC server command name

Types

type HTTPAccess 

type HTTPAccess string

HTTPAccess represents HTTP access configuration

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.