Skip to content
SKALE Docs

Validator CLI - v1.2.0

Installation

Section titled “Installation”

  1. Download the executable

    Terminal window
    VERSION_NUM={put the version number here} && sudo -E bash -c "curl -L https://github.com/skalenetwork/validator-cli/releases/download/$VERSION_NUM/sk-val-$VERSION_NUM-`uname -s`-`uname -m` >  /usr/local/bin/sk-val"

  2. Apply executable permissions to the binary

    Terminal window
    sudo chmod +x /usr/local/bin/sk-val

CLI Usage

Section titled “CLI Usage”

Initialize Validator CLI

Section titled “Initialize Validator CLI”

Download SKALE Manager contracts info and set the supernode of the network

Terminal window
sk-val init

Required Arguments

  • --endpoint/-e is the RPC endpoint of the supernode in the network where SKALE Manager is deployed [http or https]
  • --contracts-url/-c is the URL to SKALE Manager contracts ABI and addresses
  • -w/--wallet is the type of the wallet that will be used to sign transactions. Must be of type software, sgx, or hardware.

Usage Example

Terminal window
sk-val init -e ws://geth.test.com:8546 -c https://test.com/manager.json --wallet software

SGX Commands

Section titled “SGX Commands”

Init

Section titled “Init”

This command creates an SGX Wallet.

Terminal window
sk-val sgx init [SGX_SERVER_URL]

Optional Arguments

  • --force/-f rewrites the current sgx wallet data
  • --ssl-port specifies the port that is used by the sgx server to establish a TLS connection

Info

Section titled “Info”

This command prints information about the SGX Wallet.

Terminal window
sk-val sgx info

Optional Arguments

  • --raw prints info in plain JSON

Validator Commands

Section titled “Validator Commands”

Register

Section titled “Register”

Registers as a new SKALE validator.

Terminal window
sk-val validator register

Required Arguments

  • --name/-n is the validator name
  • --description/-d is the validator description
  • --commission-rate/-c is the commission rate in percentage form
  • --min-delegation is the minimum delegation amount that the validator will accept

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Usage Example

Section titled “Usage Example”
Terminal window
sk-val validator register -n test -d "test description" -c 20 --min-delegation 1000 --pk-file ./pk.txt

List

Section titled “List”

Lists all available validators.

Terminal window
sk-val validator ls

Optional Arguments

  • --wei/-w can be used to show the amount of tokens in wei

Delegations

Section titled “Delegations”

Returns a list of delegations for a given validator id.

Terminal window
sk-val validator delegations [VALIDATOR_ID]

Required Parameters

  1. VALIDATOR_ID is the id of the validator. This is a numeric value.

Accept Pending Delegations

Section titled “Accept Pending Delegations”

This command will accept pending delegations by delegation Id.

Terminal window
sk-val validator accept-delegation --pk-file ./pk.txt

Requirement Arguments

  • --delegation-id is the id of he delegation request to accept

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Accept All Pending Delegations

Section titled “Accept All Pending Delegations”
Terminal window
sk-val validator accept-all-delegations ./pk.txt

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.

Validator Linked Addresses

Section titled “Validator Linked Addresses”

Lists the linked addresses for the validator address.

Terminal window
sk-val validator linked-addresses [ADDRESS]

Required Parameters

  1. ADDRESS is the Ethereum address of the validator
Section titled “Link Address”

Links a supernode address to the validator account.

Terminal window
sk-val validator link-address [ADDRESS] [NODE_SIGNATURE] --pk-file ./pk.txt

Required Parameters

  1. ADDRESS is the Ethereum address that will be linked
  2. NODE_SIGNATURE is the signature of the supernode that you can get using the skale node signature command from the SKALE Node CLI

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance
Section titled “Unlink Address”

Unlinks a supernode address from the validator account.

Terminal window
sk-val validator unlink-address [ADDRESS] --pk-file ./pk.txt

Required Parameters

  1. ADDRESS is the Ethereum address that will be unlinked

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Validator Info

Section titled “Validator Info”

Shows info about a given validator.

Terminal window
sk-val validator info [VALIDATOR_ID]

Required Parameters

  1. VALIDATOR_ID is the validator id to lookup

Output Includes:

  1. Validator Id
  2. Validator Name
  3. Validator Address
  4. Validator Fee Rate (in percentage form)
  5. Minimum Delegation Amount (SKL)
  6. If the validator is accepting new delegation requests

Withdraw Fee

Section titled “Withdraw Fee”

Withdraws earned fees to a specified address.

Terminal window
sk-val validator withdraw-fee [RECIPIENT_ADDRESS] --pk-file ./pk.txt

Required Parameters

  1. RECIPIENT_ADDRESS is the address to transfer the bounties too

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Set Minimum Delegation Amount (MDA)

Section titled “Set Minimum Delegation Amount (MDA)”

Sets new minimum delegation amount for the validator.

Terminal window
sk-val validator set-mda [NEW_MDA] --pk-file ./pk.txt

Required Parameters

  1. NEW_MDA is the new mda value

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Request Address Change

Section titled “Request Address Change”

Requests a change of Ethereum Address for the validator.

Terminal window
sk-val validator change-address [ADDRESS] --pk-file ./pk.txt

Required Parameters

  1. ADDRESS is the validator Ethereum address

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Confirm Address Change

Section titled “Confirm Address Change”

Confirms a requested address change for the validator.

Terminal window
sk-val validator confirm-address [VALIDATOR_ID] --pk-file ./pk.txt

Required Parameters

  1. VALIDATOR_ID is the ID of the associated validator

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes the confirmation flag may be set in advance

Earned Fees

Section titled “Earned Fees”

Retrieves the earned fee amount for the validator address.

Terminal window
sk-val validator earned-fees [ADDRESS]

*Required Parameters

  1. ADDRESS is the validator address to check

Optional Arguments

  • --wei can be used to show the amount in wei

Holder Commands

Section titled “Holder Commands”

Delegate

Section titled “Delegate”

Delegate tokens to a validator

Terminal window
sk-val holder delegate

Required Arguments

  • --validator-id is the id of the validator to delegate to
  • --amount is the amount of SKL tokens to delegate
  • --delegation-period is the delegation period in months [Set to 2]
  • --info to request info on the delegation

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.

Delegations

Section titled “Delegations”

Use to list out all delegations for an address.

Terminal window
sk-val holder delegations [ADDRESS]

Required Parameters

  1. ADDRESS is the Ethereum address of the SKL token holder

Optional Arguments

  • --wei/-w to show amounts in wei

Cancel Pending Delegation

Section titled “Cancel Pending Delegation”

Use to cancel a pending delegation request.

Terminal window
sk-val holder cancel-delegation [DELEGATION_ID]

Required Parameters

  1. DELEGATION_ID is the id of the delegation to cancel

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.

Request Undelegation

Section titled “Request Undelegation”

Request undelegation which goes into affect at the end of the undelegation period.

Terminal window
sk-val holder undelegate [DELEGATION_ID]

Required Parameters

  1. DELEGATION_ID is the id of the delegation to cancel

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.

Withdraw Bounty

Section titled “Withdraw Bounty”

Withdraws a bounty to the specified address

Terminal window
sk-val holder withdraw-bounty [VALIDATOR_ID] [RECIPIENT_ADDRESS] --pk-file ./pk.txt

Required Parameters

  1. VALIDATOR_ID is the id of the validator
  2. RECIPIENT_ADDRESS is the Ethereum address to have the bounty sent too

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --gas-price allows the executor to specify the gas price value in gwei for a transaction. If not specified, the average gas price of the network will be double and set.
  • --yes confirmation flag can be used to auto execute

Locked

Section titled “Locked”

Shows the amount of locked tokens for an address.

Terminal window
sk-val holder locked [ADDRESS]

Required Parameters

  1. ADDRESS is the Ethereum address of the SKL token holder

Optional Arguments

  • --wei/-w to show amounts in wei

Earned Bounties

Section titled “Earned Bounties”

Reads the amount of earned bounties by a token holder for a single validator.

Terminal window
sk-val holder earned-bounties [VALIDATOR_ID] [ADDRESS]

Required Parameters

  1. VALIDATOR_ID is the id of the validator
  2. ADDRESS is the Ethereum address of the SKL token holder

Optional Arguments

  • --wei/-w to show amounts in wei

Wallet Commands

Section titled “Wallet Commands”

Setup Ledger

Section titled “Setup Ledger”
Terminal window
sk-val wallet setup-ledger

Required Arguments

  • --address-index is the index of the wallet to use (starts at 0)
  • --keys-type is the type of Ledger keys whether live or legacy

Send ETH Tokens

Section titled “Send ETH Tokens”

Executes a transfer of ETH tokens to a specific address.

Terminal window
sk-val wallet send-eth [ADDRESS] [AMOUNT]

Required Parameters

  1. ADDRESS is the Ethereum receiver address (e.g to)
  2. AMOUNT is the amount of ETH tokens to send

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --yes confirmation flag can be used to auto execute

Usage Example

Section titled “Usage Example”
Terminal window
sk-val wallet send-eth 0x01C19c5d3Ad1C3014145fC82263Fbae09e23924A 0.01 --pk-file ./pk.txt --yes

Send SKL Tokens

Section titled “Send SKL Tokens”

Executes a transfer of SKL tokens to a specific address.

Terminal window
sk-val wallet send-skl [ADDRESS] [AMOUNT]

Required Parameters

  1. ADDRESS is the Ethereum receiver address (e.g to)
  2. AMOUNT is the amount of ETH tokens to send

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --yes confirmation flag can be used to auto execute

Usage Example

Section titled “Usage Example”
Terminal window
sk-val wallet send-skl 0x01C19c5d3Ad1C3014145fC82263Fbae09e23924A 0.01 --pk-file ./pk.txt --yes

Self-Recharging Wallet Commands

Section titled “Self-Recharging Wallet Commands”

Balance

Section titled “Balance”

Shows the balance of the validator self-recharging wallet.

Terminal window
sk-val srw balance [VALIDATOR_ID]

Required Parameters

  1. VALIDATOR_ID is the ID of the validator

Optional Arguments

  • --wei/-w shows the amount in wei

Usage Example

Section titled “Usage Example”
Terminal window
sk-val srw balance 1 --wei

Recharge Wallet

Section titled “Recharge Wallet”

Recharges the validator SRW wallet (amount in ETH).

Terminal window
sk-val srw recharge [AMOUNT]

Required Parameters

  1. AMOUNT is the amount of ETH tokens to send

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --yes confirmation flag can be used to auto execute

Usage Example

Section titled “Usage Example”
Terminal window
sk-val srw recharge 0.1 --pk-file ./tests/test-pk.txt

Withdraw

Section titled “Withdraw”

Withdraw ETH from validator SRW (amount in ETH).

Terminal window
sk-val srw withdraw [AMOUNT]

Required Parameters

  1. AMOUNT is the amount of ETH tokens to send

Optional Arguments

  • --pk-file is a path to a file with private key (only supported for software wallet type)
  • --yes confirmation flag can be used to auto execute

Usage Example

Section titled “Usage Example”
Terminal window
sk-val srw withdraw 0.1 --pk-file ./tests/test-pk.txt

Exit Codes

Section titled “Exit Codes”
CodeExplanation
0Everything is OK
1General error exit code
3Bad API response
4Script execution error
5Transaction error
6Revert error