application

package

v1.21.41 Latest Latest Go to latest Published: Dec 23, 2025 License: BSD-3-Clause Imports: 16 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 ¶

Constants ¶

View Source

const (
	WriteReadReadPerms = 0o644
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Downloader ¶

type Downloader interface {
	Download(url string) ([]byte, error)
	DownloadWithTee(url string, filePath string) ([]byte, error)
	GetLatestReleaseVersion(releaseURL string) (string, error)
	GetLatestPreReleaseVersion(releaseURL string) (string, error)
	GetAllReleasesForRepo(org, repo string) ([]string, error)
}

This is a generic interface for performing highly testable downloads. All methods here involve external http requests. To write tests using these functions, provide a mocked version of this interface to your application object.

func NewDownloader ¶

func NewDownloader() Downloader

type LastActions ¶

type LastActions struct {
	LastSkipCheck time.Time
	LastUpdated   time.Time
}

type Lux ¶

type Lux struct {
	*sdkapp.Lux                // Embed SDK's Lux type
	Conf        *config.Config // CLI-specific config
}

Lux extends the SDK's application.Lux type with CLI-specific functionality

func New ¶

func New() *Lux

func (*Lux) CheckCertInSSHDir ¶

func (app *Lux) CheckCertInSSHDir(certName string) bool

CheckCertInSSHDir checks if a certificate exists in the SSH directory

func (*Lux) ClusterExists ¶

func (app *Lux) ClusterExists(clusterName string) (bool, error)

ClusterExists checks if a cluster exists

func (*Lux) ConfigFileExists ¶

func (app *Lux) ConfigFileExists() bool

func (*Lux) CreateNodeCloudConfigFile ¶

func (app *Lux) CreateNodeCloudConfigFile(clusterName string, nodeConfig interface{}) error

func (*Lux) GetAggregatorLogDir ¶

func (app *Lux) GetAggregatorLogDir(clusterName string) string

GetAggregatorLogDir returns the signature aggregator log directory

func (*Lux) GetBasePath ¶

func (app *Lux) GetBasePath() string

GetBasePath returns the base directory path for the CLI

func (*Lux) GetClusterConfig ¶

func (app *Lux) GetClusterConfig(clusterName string) (map[string]interface{}, error)

GetClusterConfig loads cluster configuration from disk

func (*Lux) GetClusterYAMLFilePath ¶

func (app *Lux) GetClusterYAMLFilePath(clusterName string) string

GetClusterYAMLFilePath returns the path to a cluster's YAML config file

func (*Lux) GetClustersConfig ¶

func (app *Lux) GetClustersConfig() (map[string]interface{}, error)

func (*Lux) GetEVMBinDir ¶

func (app *Lux) GetEVMBinDir() string

func (*Lux) GetLoadTestInventoryDir ¶

func (app *Lux) GetLoadTestInventoryDir(clusterName string) string

GetLoadTestInventoryDir returns the load test inventory directory

func (*Lux) GetLuxBinDir ¶

func (app *Lux) GetLuxBinDir() string

func (*Lux) GetLuxCompatibilityURL ¶

func (*Lux) GetLuxCompatibilityURL() string

func (*Lux) GetLuxNodeBinDir ¶ added in v1.21.23

func (app *Lux) GetLuxNodeBinDir() string

func (*Lux) GetLuxgoBinDir ¶

func (app *Lux) GetLuxgoBinDir() string

GetLuxgoBinDir is deprecated, use GetLuxNodeBinDir instead

func (*Lux) GetMonitoringDashboardDir ¶

func (app *Lux) GetMonitoringDashboardDir() string

func (*Lux) GetNodeConfigPath ¶

func (app *Lux) GetNodeConfigPath(nodeName string) string

GetNodeConfigPath returns the path to a node's config file

func (*Lux) GetNodeInstanceDirPath ¶

func (app *Lux) GetNodeInstanceDirPath(nodeName string) string

func (*Lux) GetNodeStakingDir ¶

func (app *Lux) GetNodeStakingDir(nodeName string) string

GetNodeStakingDir returns the staking directory for a node

func (*Lux) GetReposDir ¶

func (app *Lux) GetReposDir() string

func (*Lux) GetSDKApp ¶

func (app *Lux) GetSDKApp() *sdkapp.Lux

GetSDKApp returns the embedded SDK application for compatibility with SDK-based functions

func (*Lux) GetSSHCertFilePath ¶

func (app *Lux) GetSSHCertFilePath(certName string) (string, error)

func (*Lux) GetUpgradeBytesFilepath ¶

func (app *Lux) GetUpgradeBytesFilepath(subnetName string) string

func (*Lux) GetWarpRelayerBinDir ¶

func (app *Lux) GetWarpRelayerBinDir() string

func (*Lux) GetWarpRelayerServiceConfigPath ¶

func (a *Lux) GetWarpRelayerServiceConfigPath(blockchainName string) string

GetWarpRelayerServiceConfigPath returns the path to the warp relayer service config

func (*Lux) GetWarpRelayerServiceStorageDir ¶ added in v1.9.4

func (app *Lux) GetWarpRelayerServiceStorageDir() string

func (*Lux) HasEVMGenesis ¶ added in v1.21.40

func (app *Lux) HasEVMGenesis(blockchainName string) (bool, string, error)

HasEVMGenesis checks if the blockchain has a EVM genesis

func (*Lux) LoadClusterNodeConfig ¶

func (app *Lux) LoadClusterNodeConfig(clusterName string, nodeName string) (map[string]interface{}, error)

LoadClusterNodeConfig loads node configuration for a cluster

func (*Lux) LoadConfig ¶

func (app *Lux) LoadConfig() (types.Config, error)

func (*Lux) LoadEvmGenesis ¶

func (app *Lux) LoadEvmGenesis(blockchainName string) (*types.EvmGenesis, error)

LoadEvmGenesis loads EVM genesis for a blockchain

func (*Lux) ReadLastActionsFile ¶

func (app *Lux) ReadLastActionsFile() (*LastActions, error)

func (*Lux) SaveClustersConfig ¶

func (app *Lux) SaveClustersConfig(config map[string]interface{}) error

SaveClustersConfig saves the clusters configuration

func (*Lux) SetClusterConfig ¶

func (app *Lux) SetClusterConfig(clusterName string, config map[string]interface{}) error

SetClusterConfig saves cluster configuration to disk

func (*Lux) Setup ¶

func (app *Lux) Setup(baseDir string, log luxlog.Logger, conf *config.Config, prompt prompts.Prompter, downloader Downloader)

func (*Lux) SetupMonitoringEnv ¶

func (app *Lux) SetupMonitoringEnv(clusterName string) error

SetupMonitoringEnv sets up monitoring environment

func (*Lux) WriteConfigFile ¶

func (app *Lux) WriteConfigFile(data []byte) error

CLI-specific config methods

func (*Lux) WriteLastActionsFile ¶

func (app *Lux) WriteLastActionsFile(acts *LastActions)

Source Files ¶

View all Source files

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