The LUKSO CLI is a command line tool to install, manage and set up validators of different clients for the LUKSO Blockchain. For more information and tutorial, please check the LUKSO Tech Docs.
- 🧰 Installation of Execution, Consensus, and Validator Clients
- đź“€ Running a node as a validator
- đź“‘ Accessing various client logs
The LUKSO CLI is able to install multiple clients for running the node.
- Execution Clients: Geth, Erigon
- Consensus Clients: Prysm, Lighthouse
- Validator Staking Clients: Prysm, Lighthouse
More clients will be added in the future.
The LUKSO CLI is officially supported on Mac, Ubuntu, and Debian with the following architectures:
x86/x86_64: Intel and AMD ProcessorsARM/aarch64: Single-Board Computers as M1 or Raspberry
The experience might differ with other setups or versions of these operating systems.
Process of setting up the node using the LUSKO CLI.
- Download and execute the LUKSO CLI installation script
- Running this script will install the full LUKSO CLI on Mac and Linux
- Installation directory:
/usr/local/bin/lukso
# Might need admin access by typing `sudo` in front of the command
$ curl https://install.lukso.network | sh- Create and move into a working directory for your node's data
# Exchange [folder_name] with the folder name you want
$ mkdir [folder_name] && cd ./[folder_name]- Initialize the working directory
# Downloads all network configs from https://github.com/lukso-network/network-configs
$ lukso init- Install choosen LUKSO clients into the working directory
# Installing Execution, Consensus, and Validator Client
# Might need admin access by typing `sudo` in front of the command
$ lukso installPlease refer to the start command below for more information.
As the LUKSO CLI is able to manage multiple clients for multiple blockchain networks in one folder, the structure of the node is set up in a generic way.
- When initializing the node (with
lukso init), a global configuration folder is created, which holds shared and unique client information for each type of network. - When executing commands, directories for the associated network type will be created accordingly.
Network Types: mainnet, testnet, devnet
Even if multiple networks are set up, only one can be active simultaneously, as the LUKSO CLI runs natively within your system environments.
lukso-node
│
├───configs // Configuration
│ └───[network_type] // Network's Config Data
│ ├───shared
| | ├───genesis.json // Genesis JSON Data
| | ├───genesis.ssz // Genesis Validator File
| | └───config.yaml // Global Client Config
│ ├───geth // Config for Geth Client
│ ├───prysm // Config for Prysm Client
│ ├───erigon // Config for Erigon Client
│ └───lighthouse // Config for Lighthouse Client
│
├───[network_type]-keystore // Network's Validator Wallet
│ ├───keys // Encrypted Private Keys
│ ├───... // Files for Signature Creation
| ├───pubkeys.json // Validator Public Keys
| ├───deposit_data.json // Deposit JSON for Validators
| └───node_config.yaml // Node Configuration File
|
├───[network_type]-data // Network's Blockchain Data
│ ├───consensus // Storage of used Consensus Client
│ ├───execution // Storage of used Execution Client
│ └───validator // Storage of Validator Client
│
├───[network_type]-logs // Network's Logged Data
|
└───cli-config.yaml // Global CLI Configuration
| Command | Description |
|---|---|
install |
Installs choosen clients (Execution, Consensus, Validator) and their binary dependencies |
init |
Initializes the working directory, it's structure, and network configuration |
start |
Starts all or specific clients and connects to the specified network |
stop |
Stops all or specific clients that are currently running |
logs |
Listens to and logs all events from a specific client in the current terminal window |
status |
Shows the client processes that are currently running |
reset |
Resets all or specific client data directories and logs excluding the validator keys |
validator import |
Import the validator keys in the wallet |
validator list |
Display the imported validator keys |
version |
Display the version of the LUKSO CLI that is currently installed |
help, h |
Shows the full list of commands, global options, and their usage |
| Flag | Description |
|---|---|
| --help, -h | Can be added before or after a command to show it's help page |
For almost each command in the list, options can be added after it to modify or specify certain behavior. Below, you can find examples and options tables for all available commands.
Options containting [string] expects a string input in quotes.
Options containting [int] expects an int input without quotes.
# User is able to select its Consensus and Execution clients.
# Detects pre-installed clients and will ask for overrides
$ lukso install
# Installs clients and agrees with Terms & Conditions automatically
$ lukso install --agree-terms| Option | Description |
|---|---|
| --agree-terms | Automatically accept Terms and Conditions |
# Starts your node and connects to LUKSO mainnet
# Uses the default config files from configs/mainnet folder
$ lukso start
# Starts your node and connects to mainnet as a validator
$ lukso start --validator --transaction-fee-recipient "0x1234..."
# Starts your node and connects to the LUKSO testnet
$ lukso start --testnet
# Starts your node and connects to testnet as a validator
$ lukso start --testnet --validator --transaction-fee-recipient "0x1234..."# Geth Configutation
# Change [config] to the name of your configuration file
$ lukso start --geth-config "./[config].toml"
# Prysm Configutation
# Change [config] to the name of your configuration file
# Change [custom_bootnode] to the bootnode's name
$ lukso start --prysm-config "./[config].yaml" --geth-bootnodes "[custom_bootnode]"
# Lighthouse Configutation
# Change [config] to the name of your configuration file
# Change [custom_bootnode] to the bootnode's name
$ lukso start --lighthouse-config "./[config].yaml" --lighthouse-bootnodes "[custom_bootnode]"
# An experienced user can also start custom clients
# Example with Lighthouse and Erigon clients
$ lukso start --lighthouse --erigon# Setting up a custom logs directory
# Change [folder path] to a static or dynamic directory path
$ lukso start --logs-folder "[folder_path]"Checkpoint synchronization is a feature that significantly speeds up the initial sync time of the consensus client. If enabled, your node will begin syncing from a recently finalized consensus checkpoint instead of genesis. The shortcut makes installation, validator migration, or recovery much faster.
# Mainnet Checkpoint for Prysm Consensus Client
$ lukso start --prysm-checkpoint-sync-url=https://checkpoints.mainnet.lukso.network
# Mainnet Checkpoint for Lighthouse Consensus Client
$ lukso start --lighthouse-checkpoint-sync-url=https://checkpoints.mainnet.lukso.network
# Testnet Checkpoint for Prysm Consensus Client
$ lukso start --testnet --prysm-checkpoint-sync-url=https://checkpoints.testnet.lukso.network
# Testnet Checkpoint for Lighthouse Consensus Client
$ lukso start --testnet --lighthouse-checkpoint-sync-url=https://checkpoints.testnet.lukso.network| Option | Description |
|---|---|
| NETWORK | |
| --mainnet | Starts the LUKSO node with mainnet data [default] (./configs/mainnet) |
| --testnet | Starts the LUKSO node with testnet data (./configs/tesnet) |
| --devnet | Starts the LUKSO node with devnet data (./configs/devnet) |
| VALIDATOR | |
| --validator | Starts the validator client |
| --validator-keys [string] | Directory of the validator keys (default: "./[network_type]-keystore") |
| --validator-wallet-password [string] | Location of password file that you used for generated validator keys |
| --validator-config [string] | Path to prysms validator.yaml config file |
| --transaction-fee-recipient [string] | The address that receives block reward from transactions (required for --validator flag) |
| --genesis-json [string] | The path to genesis JSON file |
| --genesis-ssz [string] | The path to genesis SSZ file |
| --no-slasher | Disables slasher |
| CLIENT OPTIONS | |
| --logs-folder [string] | Sets up a custom logs directory (default: "./[network_type]-logs") |
| --geth-config [string] | Defines the path to geth TOML config file |
| --prysm-config [string] | Defines the path to prysm YAML config file |
| --erigon-config [string] | Defines the path to erigon TOML config file |
| --geth-[command] | The command will be passed to the Geth client. See the client docs for details |
| --prysm-[command] | The command will be passed to the Prysm client. See the client docs for details |
| --lighhouse-[command] | The command will be passed to the Lighthouse client. See the client docs for details |
| --erigon-[command] | The command will be passed to the Erigon client. See the client docs for details |
# Stops all running node clients
$ lukso stop
# Only stops the validator client
$ lukso stop --validator
# Only stops the execution client
$ lukso stop --execution
# Only stops the consensus client
$ lukso stop --consensus| Option | Description |
|---|---|
| --validator | Stops the validator client |
| --execution | Stops the execution client |
| --consensus | Stops the consensus client |
# Displays and saves the logs of the mainnet's consensus client
$ lukso logs consensus
# Displays and saves the logs of the devnet's execution client
$ lukso logs execution --devnet
# Displays and saves the logs of the testnet's validator
$ lukso logs validator --testnet| Option | Description |
|---|---|
| --mainnet | Logs the mainnet client [default] (./mainnet-logs/[client_type]/) |
| --testnet | Logs the testnet client (./testnet-logs/[client_type]/) |
| --devnet | Logs the devnet client (./devnet-logs/[client_type]/) |
# Shows which client processes are currently running
$ lukso status# Resets LUKSO's mainnet data directory
$ lukso reset
# Resets LUKSO's testnet data directory
$ lukso reset --testnet
# Resets LUKSO's devnet data directory
$ lukso reset --devnet| Option | Description |
|---|---|
| --mainnet | Resets LUKSO's mainnet data [default] |
| --testnet | Resets LUKSO's testnet data |
| --devnet | Resets LUKSO's devnet data |
# Displays the currently installed version of the LUKSO CLI
$ lukso versionIn addition to the help command, the global help flag can be used to generate help pages for commands
# Displays the global help page
$ lukso help
# Displays the help page of the start command
$ lukso start --help
# Displays the help page of the start command
$ lukso start -hValidator keys can be generated using:
- CLI: tools-key-gen-cli
- GUI: wagyu-key-gen
Both of them will generate the validator keys directory.
After generating the validator keys, they can be imported into the LUKSO CLI. To fill the validator keys with funds to participate on the LUKSO Blockchain, you must use the LUKSO Launchpad to send LYXe from your wallet to the generated keys.
- All genesis validators will be prompted to vote for the initial token supply of LYX
- The initial token supply will determine how much LYX the Foundation will receive
- More details at: https://deposit.mainnet.lukso.network
- Genesis Validators need to have at least 32 LYXe per validator
- Validators also need some ETH on their wallet to pay for gas expenses
Import existing EIP-2335 keystore files (such as those generated by the Wagyu Keygen) into Prysm.
For validator import command the --validator-keys flag is required.
# Regular import process
# You will be asked for the passwords - of your validator keys and newly generated wallet
lukso validator import --validator-keys "./myKeysDir"
# You will be asked only for wallet password
lukso validator import --validator-keys "./myKeysDir" --validator-password "./myKeysPasswordFile.txt"| Option | Description |
|---|---|
| --validator-keys [string] | Directory of the validator keys (default: "./[network_type]-keystore") |
| --validator-password [string] | Path to validator keys' password file |
| NETWORK | |
| --mainnet | Will import the keys for mainnet [default] (Will use: "./mainnet-keystore") |
| --testnet | Will import the keys for testnet (Will use: "./testnet-keystore") |
| --devnet | Will import the keys for devnet (Will use: "./devnet-keystore") |
List all imported keys from the validators keystore.
# List imported keys for mainnet keystore
# You will be asked for the password
lukso validator list
# List imported keys for devnet keystore
# You will be asked for the password
lukso validator list --devnet| Option | Description |
|---|---|
| NETWORK | |
| --mainnet | Will list the keys for mainnet [default] (default: "./mainnet-keystore") |
| --testnet | Will list the keys for testnet (default: "./testnet-keystore") |
| --devnet | Will list the keys for devnet (default: "./devnet-keystore") |
For specific validator options, please visit the Prysm Validator Specification. All flags and their parameters will be passed to the client. This can be useful to configure additional features like the validator's graffiti, extended logging, or connectivity options.
When you use --validator, the --transaction-fee-recipient flag is required.
# Specify the transaction fee recipient, also known as coinbase
# It is the address where the transactions fees are sent to
$ lukso start --validator --transaction-fee-recipient "0x12345678..."If you want to provide a specific keystore directory, you can use the --validator-keys flag. If no --validator-keys flag was specified, the CLI will look in the default directory: ./[network_type]-keystore.:
# Validator keys
# Command split across multiple lines for readability
# Change [file_name] with the your password text file's name
$ lukso start --validator \
--transaction-fee-recipient "0x12345678..." \
--validator-keys "./custom-keystore-dir-path"# Command split across multiple lines for readability
# Make sure that both SSZ and JSON files are placed correctly
$ lukso start \
--genesis-ssz "./config/mainnet/shared/genesis.ssz" \
--genesis-json "./config/mainnet/shared/genesis.json"The LUKSO CLI and downloaded clients are located within the binary folder of the user's system directory. It can be removed at any time. All node data is directly located within the working directory.
# Make sure to stop the node
$ lukso stop
# Uninstall the LUKSO CLI
$ rm -rf /usr/local/bin/lukso
# Uninstall Geth Execution Client
$ rm -rf /usr/local/bin/geth
# Uninstall Prysm Consensus Client
$ rm -rf /usr/local/bin/prysm
# Uninstall Lighthouse Consensus Client
$ rm -rf /usr/local/bin/lighthouse
# Uninstall Erigon Execution Client
$ rm -rf /usr/local/bin/erigon
# Remove the node data
# Make sure to backup your keys first
$ rm -rf ~/myNodeFolderIf you want to contribute to this repository, please check CONTRIBUTING.md.