commands

package

v1.13.2 Latest Latest Go to latest Published: Jul 20, 2025 License: BSD-3-Clause Imports: 12 Imported by: 0

Details

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

Repository

github.com/luxfi/cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Index ¶

Constants
func AddPermissionlessValidator(subnetName string, nodeID string, stakeAmount string, stakingPeriod string) (string, error)
func ApplyUpgradeLocal(subnetName string) (string, error)
func ApplyUpgradeToPublicNode(subnetName, luxChainConfDir string) (string, error)
func CleanNetwork()
func CleanNetworkHard()
func ConfigureChainConfig(subnetName string, genesisPath string)
func ConfigurePerNodeChainConfig(subnetName string, perNodeChainConfigPath string)
func CreateCustomVMConfig(subnetName string, genesisPath string, vmPath string)
func CreateKey(keyName string) (string, error)
func CreateKeyForce(keyName string) (string, error)
func CreateKeyFromPath(keyName string, keyPath string) (string, error)
func CreateSubnetEvmConfig(subnetName string, genesisPath string) (string, string)
func CreateSubnetEvmConfigWithVersion(subnetName string, genesisPath string, version string)
func DeleteElasticSubnetConfig(subnetName string)
func DeleteKey(keyName string) (string, error)
func DeleteSubnetConfig(subnetName string)
func DeploySubnetLocally(subnetName string) string
func DeploySubnetLocallyExpectError(subnetName string)
func DeploySubnetLocallyWithArgs(subnetName string, version string, confPath string) string
func DeploySubnetLocallyWithArgsAndOutput(subnetName string, version string, confPath string) ([]byte, error)
func DeploySubnetLocallyWithArgsExpectError(subnetName string, version string, confPath string)
func DeploySubnetLocallyWithVersion(subnetName string, version string) string
func DeploySubnetLocallyWithViperConf(subnetName string, confPath string) string
func DescribeSubnet(subnetName string) (string, error)
func ExportKey(keyName string) (string, error)
func ExportKeyToFile(keyName string, outputPath string) (string, error)
func GetVersion() string
func ImportSubnetConfig(repoAlias string, subnetName string)
func ImportSubnetConfigFromURL(repoURL string, branch string, subnetName string)
func ImportUpgradeBytes(subnetName, filepath string) (string, error)
func ListKeys() (string, error)
func ListValidators(subnetName string, network string) (string, error)
func RemoveValidator(subnetName string, nodeID string) (string, error)
func SimulateFujiAddValidator(subnetName string, key string, nodeID string, start string, period string, ...) string
func SimulateFujiDeploy(subnetName string, key string, controlKeys string) string
func SimulateFujiJoin(subnetName string, nodeConfig string, pluginDir string, nodeID string) string
func SimulateFujiRemoveValidator(subnetName string, key string, nodeID string) string
func SimulateFujiTransformSubnet(subnetName string, key string) (string, error)
func SimulateGetSubnetStatsFuji(subnetName, subnetID string) string
func SimulateMainnetAddValidator(subnetName string, nodeID string, start string, period string, weight string) string
func SimulateMainnetDeploy(subnetName string) string
func SimulateMainnetJoin(subnetName string, nodeConfig string, pluginDir string, nodeID string) string
func StartNetwork() string
func StartNetworkWithVersion(version string) string
func StopNetwork()
func TransformElasticSubnetLocally(subnetName string) (string, error)
func TransformElasticSubnetLocallyandTransformValidators(subnetName string, stakeAmount string) (string, error)
func UpgradeCustomVM(subnetName string, binaryPath string) (string, error)
func UpgradeCustomVMLocal(subnetName string, binaryPath string) string
func UpgradeVMConfig(subnetName string, targetVersion string) (string, error)
func UpgradeVMLocal(subnetName string, targetVersion string) string
func UpgradeVMPublic(subnetName string, targetVersion string, pluginDir string) (string, error)

Constants ¶

View Source

const (
	CLIBinary           = "./bin/lux"
	SubnetCmd           = "subnet"
	NetworkCmd          = "network"
	KeyCmd              = "key"
	UpgradeCmd          = "upgrade"
	ElasticTransformCmd = "elastic"
	JoinCmd             = "join"
	RemoveValidatorCmd  = "removeValidator"
)

Variables ¶

This section is empty.

Functions ¶

func AddPermissionlessValidator ¶

func AddPermissionlessValidator(subnetName string, nodeID string, stakeAmount string, stakingPeriod string) (string, error)

func ApplyUpgradeLocal ¶

func ApplyUpgradeLocal(subnetName string) (string, error)

#nosec G204

func ApplyUpgradeToPublicNode ¶

func ApplyUpgradeToPublicNode(subnetName, luxChainConfDir string) (string, error)

#nosec G204

func CleanNetwork ¶

func CleanNetwork()

#nosec G204

func CleanNetworkHard ¶

func CleanNetworkHard()

#nosec G204

func ConfigureChainConfig ¶

func ConfigureChainConfig(subnetName string, genesisPath string)

#nosec G204

func ConfigurePerNodeChainConfig ¶

func ConfigurePerNodeChainConfig(subnetName string, perNodeChainConfigPath string)

#nosec G204

func CreateCustomVMConfig ¶

func CreateCustomVMConfig(subnetName string, genesisPath string, vmPath string)

#nosec G204

func CreateKey ¶

func CreateKey(keyName string) (string, error)

#nosec G204

func CreateKeyForce ¶

func CreateKeyForce(keyName string) (string, error)

#nosec G204

func CreateKeyFromPath ¶

func CreateKeyFromPath(keyName string, keyPath string) (string, error)

#nosec G204

func CreateSubnetEvmConfig ¶

func CreateSubnetEvmConfig(subnetName string, genesisPath string) (string, string)

#nosec G204

func CreateSubnetEvmConfigWithVersion ¶

func CreateSubnetEvmConfigWithVersion(subnetName string, genesisPath string, version string)

#nosec G204

func DeleteElasticSubnetConfig ¶

func DeleteElasticSubnetConfig(subnetName string)

func DeleteKey ¶

func DeleteKey(keyName string) (string, error)

#nosec G204

func DeleteSubnetConfig ¶

func DeleteSubnetConfig(subnetName string)

#nosec G204

func DeploySubnetLocally ¶

func DeploySubnetLocally(subnetName string) string

Returns the deploy output

#nosec G204

func DeploySubnetLocallyExpectError ¶

func DeploySubnetLocallyExpectError(subnetName string)

#nosec G204

func DeploySubnetLocallyWithArgs ¶

func DeploySubnetLocallyWithArgs(subnetName string, version string, confPath string) string

Returns the deploy output

#nosec G204

func DeploySubnetLocallyWithArgsAndOutput ¶

func DeploySubnetLocallyWithArgsAndOutput(subnetName string, version string, confPath string) ([]byte, error)

func DeploySubnetLocallyWithArgsExpectError ¶

func DeploySubnetLocallyWithArgsExpectError(subnetName string, version string, confPath string)

#nosec G204

func DeploySubnetLocallyWithVersion ¶

func DeploySubnetLocallyWithVersion(subnetName string, version string) string

Returns the deploy output

#nosec G204

func DeploySubnetLocallyWithViperConf ¶

func DeploySubnetLocallyWithViperConf(subnetName string, confPath string) string

Returns the deploy output

#nosec G204

func DescribeSubnet ¶

func DescribeSubnet(subnetName string) (string, error)

#nosec G204

func ExportKey ¶

func ExportKey(keyName string) (string, error)

#nosec G204

func ExportKeyToFile ¶

func ExportKeyToFile(keyName string, outputPath string) (string, error)

#nosec G204

func GetVersion ¶

func GetVersion() string

func ImportSubnetConfig ¶

func ImportSubnetConfig(repoAlias string, subnetName string)

#nosec G204

func ImportSubnetConfigFromURL ¶

func ImportSubnetConfigFromURL(repoURL string, branch string, subnetName string)

#nosec G204

func ImportUpgradeBytes ¶

func ImportUpgradeBytes(subnetName, filepath string) (string, error)

#nosec G204

func ListKeys ¶

func ListKeys() (string, error)

#nosec G204

func ListValidators ¶

func ListValidators(subnetName string, network string) (string, error)

#nosec G204

func RemoveValidator ¶

func RemoveValidator(subnetName string, nodeID string) (string, error)

func SimulateFujiAddValidator ¶ added in v1.7.9

func SimulateFujiAddValidator(
	subnetName string,
	key string,
	nodeID string,
	start string,
	period string,
	weight string,
) string

simulates fuji add validator execution path on a local network

#nosec G204

func SimulateFujiDeploy ¶ added in v1.7.9

func SimulateFujiDeploy(
	subnetName string,
	key string,
	controlKeys string,
) string

simulates fuji deploy execution path on a local network

#nosec G204

func SimulateFujiJoin ¶ added in v1.7.9

func SimulateFujiJoin(
	subnetName string,
	nodeConfig string,
	pluginDir string,
	nodeID string,
) string

simulates fuji join execution path on a local network

#nosec G204

func SimulateFujiRemoveValidator ¶ added in v1.7.9

func SimulateFujiRemoveValidator(
	subnetName string,
	key string,
	nodeID string,
) string

simulates fuji add validator execution path on a local network

func SimulateFujiTransformSubnet ¶ added in v1.7.9

func SimulateFujiTransformSubnet(
	subnetName string,
	key string,
) (string, error)

func SimulateGetSubnetStatsFuji ¶ added in v1.7.9

func SimulateGetSubnetStatsFuji(subnetName, subnetID string) string

#nosec G204

func SimulateMainnetAddValidator ¶

func SimulateMainnetAddValidator(
	subnetName string,
	nodeID string,
	start string,
	period string,
	weight string,
) string

simulates mainnet add validator execution path on a local network

#nosec G204

func SimulateMainnetDeploy ¶

func SimulateMainnetDeploy(
	subnetName string,
) string

simulates mainnet deploy execution path on a local network

#nosec G204

func SimulateMainnetJoin ¶

func SimulateMainnetJoin(
	subnetName string,
	nodeConfig string,
	pluginDir string,
	nodeID string,
) string

simulates mainnet join execution path on a local network

#nosec G204

func StartNetwork ¶

func StartNetwork() string

#nosec G204

func StartNetworkWithVersion ¶

func StartNetworkWithVersion(version string) string

#nosec G204

func StopNetwork ¶

func StopNetwork()

#nosec G204

func TransformElasticSubnetLocally ¶

func TransformElasticSubnetLocally(subnetName string) (string, error)

func TransformElasticSubnetLocallyandTransformValidators ¶

func TransformElasticSubnetLocallyandTransformValidators(subnetName string, stakeAmount string) (string, error)

func UpgradeCustomVM ¶

func UpgradeCustomVM(subnetName string, binaryPath string) (string, error)

#nosec G204

func UpgradeCustomVMLocal ¶

func UpgradeCustomVMLocal(subnetName string, binaryPath string) string

#nosec G204

func UpgradeVMConfig ¶

func UpgradeVMConfig(subnetName string, targetVersion string) (string, error)

#nosec G204

func UpgradeVMLocal ¶

func UpgradeVMLocal(subnetName string, targetVersion string) string

#nosec G204

func UpgradeVMPublic ¶

func UpgradeVMPublic(subnetName string, targetVersion string, pluginDir string) (string, error)

#nosec G204

Types ¶

This section is empty.

Source Files ¶

View all Source files

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