celocli validator
View and manage Validators
celocli validator:affiliate ARG1celocli validator:community-rpc-nodescelocli validator:deaffiliatecelocli validator:deregistercelocli validator:listcelocli validator:registercelocli validator:requirementscelocli validator:rpc-urlscelocli validator:send-paymentcelocli validator:show ARG1celocli validator:status
celocli validator:affiliate ARG1
Affiliate a Validator with a Validator Group. This allows the Validator Group to add that Validator as a member. If the Validator is already a member of a Validator Group, affiliating with a different Group will remove the Validator from the first group’s members.
USAGE
$ celocli validator:affiliate ARG1 --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
[-k <value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp] [--yes]
ARGUMENTS
ARG1 ValidatorGroup's address
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Signer or Validator's address
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
--yes
Answer yes to prompt
DESCRIPTION
Affiliate a Validator with a Validator Group. This allows the Validator Group to add
that Validator as a member. If the Validator is already a member of a Validator Group,
affiliating with a different Group will remove the Validator from the first group's
members.
EXAMPLES
affiliate --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95 0x97f7333c51897469e8d98e7af8653aab468050a3
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:community-rpc-nodes
Displays a list of community RPC nodes for the currently elected validator groups
USAGE
$ celocli validator:community-rpc-nodes [-n <value>] [--globalHelp] [--columns <value> | -x]
[--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |
| ] [--sort <value>] [--all]
FLAGS
-n, --node=<value> URL of the node to run commands against or an alias
-x, --extended show extra columns
--all Display all community RPC nodes, not just the ones from
currently elected validator groups
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--globalHelp View all available global flags
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Displays a list of community RPC nodes for the currently elected validator groups
ALIASES
$ celocli network:community-rpc-nodes
$ celocli network:rpc-urls
$ celocli node:list
$ celocli validator:community-rpc-nodes
$ celocli validator:rpc-urls
$ celocli validatorgroup:community-rpc-nodes
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:deaffiliate
Deaffiliate a Validator from a Validator Group, and remove it from the Group if it is also a member.
USAGE
$ celocli validator:deaffiliate --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d [-k
<value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Signer or Validator's address
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
DESCRIPTION
Deaffiliate a Validator from a Validator Group, and remove it from the Group if it is
also a member.
EXAMPLES
deaffiliate --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:deregister
Deregister a Validator. Wait the require lock period after the validator is no longer part of any group, then it will be possible to deregister the validator and start unlocking the CELO. If you wish to deregister your validator, you must first remove it from it’s group, such as by deaffiliating it, then wait the required days before running this command.
USAGE
$ celocli validator:deregister --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d [-k
<value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Signer or Validator's address
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
DESCRIPTION
Deregister a Validator. Wait the require lock period after the validator is no longer
part of any group, then it will be possible to deregister the validator and start
unlocking the CELO. If you wish to deregister your validator, you must first remove it
from it's group, such as by deaffiliating it, then wait the required days before
running this command.
EXAMPLES
deregister --from 0x47e172f6cfb6c7d01c1574fa3e2be7cc73269d95
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:list
List registered Community Rpc Nodes (Formerly Validators), their name (if provided), affiliation, uptime score, and public keys. For rpc urls use “network:rpc-urls”
USAGE
$ celocli validator:list [-n <value>] [--globalHelp] [--columns <value> | -x]
[--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |
| ] [--sort <value>]
FLAGS
-n, --node=<value> URL of the node to run commands against or an alias
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--globalHelp View all available global flags
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
List registered Community Rpc Nodes (Formerly Validators), their name (if provided),
affiliation, uptime score, and public keys. For rpc urls use "network:rpc-urls"
EXAMPLES
list
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:register
Register a new Validator
USAGE
$ celocli validator:register --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
--ecdsaKey 0x [-k <value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp] [--yes]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--ecdsaKey=0x
(required) ECDSA Public Key
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Address for the Validator
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
--yes
Answer yes to prompt
DESCRIPTION
Register a new Validator
EXAMPLES
register --from 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95 --ecdsaKey 0x049b7291ab8813a095d6b7913a7930ede5ea17466abd5e1a26c6c44f6df9a400a6f474080098b2c752c6c4871978ca977b90dcd3aed92bc9d564137c8dfa14ee72 --blsKey 0x4fa3f67fc913878b068d1fa1cdddc54913d3bf988dbe5a36a20fa888f20d4894c408a6773f3d7bde11154f2a3076b700d345a42fd25a0e5e83f4db5586ac7979ac2053cd95d8f2efd3e959571ceccaa743e02cf4be3f5d7aaddb0b06fc9aff00 --blsSignature 0xcdb77255037eb68897cd487fdd85388cbda448f617f874449d4b11588b0b7ad8ddc20d9bb450b513bb35664ea3923900
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:requirements
List the Locked Gold requirements for registering a Validator. This consists of a value, which is the amount of CELO that needs to be locked in order to register, and a duration, which is the amount of time that CELO must stay locked following the deregistration of the Validator.
USAGE
$ celocli validator:requirements [-k <value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
DESCRIPTION
List the Locked Gold requirements for registering a Validator. This consists of a
value, which is the amount of CELO that needs to be locked in order to register, and a
duration, which is the amount of time that CELO must stay locked following the
deregistration of the Validator.
EXAMPLES
requirements
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:rpc-urls
Displays a list of community RPC nodes for the currently elected validator groups
USAGE
$ celocli validator:rpc-urls [-n <value>] [--globalHelp] [--columns <value> | -x]
[--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |
| ] [--sort <value>] [--all]
FLAGS
-n, --node=<value> URL of the node to run commands against or an alias
-x, --extended show extra columns
--all Display all community RPC nodes, not just the ones from
currently elected validator groups
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--globalHelp View all available global flags
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Displays a list of community RPC nodes for the currently elected validator groups
ALIASES
$ celocli network:community-rpc-nodes
$ celocli network:rpc-urls
$ celocli node:list
$ celocli validator:community-rpc-nodes
$ celocli validator:rpc-urls
$ celocli validatorgroup:community-rpc-nodes
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:send-payment
Sends the allocated epoch payment to a validator, their group, and delegation beneficiary.
USAGE
$ celocli validator:send-payment --from 0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d --for
0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d [-k <value> | --useLedger | ] [-n
<value>] [--gasCurrency 0x1234567890123456789012345678901234567890]
[--ledgerAddresses <value> ] [--ledgerLiveMode ] [--globalHelp]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
--for=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Address of the validator to send the payment to
--from=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
(required) Address of the sender
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--useLedger
Set it to use a ledger wallet
DESCRIPTION
Sends the allocated epoch payment to a validator, their group, and delegation
beneficiary.
ALIASES
$ celocli validator:send-payment
EXAMPLES
send-validator-payment --for 0x47e172F6CfB6c7D01C1574fa3E2Be7CC73269D95
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:show ARG1
Show information about a registered Validator.
USAGE
$ celocli validator:show ARG1 [-n <value>] [--globalHelp]
ARGUMENTS
ARG1 Validator's address
FLAGS
-n, --node=<value> URL of the node to run commands against or an alias
--globalHelp View all available global flags
DESCRIPTION
Show information about a registered Validator.
EXAMPLES
show 0x97f7333c51897469E8D98E7af8653aAb468050a3
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',
celocli validator:status
Shows the consensus status of a validator. This command will show whether a validator is currently elected, would be elected if an election were to be run right now, and the percentage of blocks signed and number of blocks successfully proposed within a given window.
USAGE
$ celocli validator:status [-k <value> | --useLedger | ] [-n <value>] [--gasCurrency
0x1234567890123456789012345678901234567890] [--ledgerAddresses <value> ]
[--ledgerLiveMode ] [--globalHelp] [--validator
0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d | --all | --signer
0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d] [--start <value>] [--end <value>]
[--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]]
[--output csv|json|yaml | | ] [--sort <value>]
FLAGS
-k, --privateKey=<value>
Use a private key to sign local transactions with
-n, --node=<value>
URL of the node to run commands against or an alias
-x, --extended
show extra columns
--all
get the status of all registered validators
--columns=<value>
only show provided columns (comma-separated)
--csv
output is csv format [alias: --output=csv]
--end=<value>
[default: -1] what block to end at when looking at signer activity. defaults to the
latest block
--filter=<value>
filter property by partial string matching, ex: name=foo
--gasCurrency=0x1234567890123456789012345678901234567890
Use a specific gas currency for transaction fees (defaults to CELO if no gas
currency is supplied). It must be a whitelisted token.
--globalHelp
View all available global flags
--ledgerAddresses=<value>
[default: 1] If --useLedger is set, this will get the first N addresses for local
signing
--ledgerLiveMode
When set, the 4th postion of the derivation path will be iterated over instead of
the 5th. This is useful to use same address on you Ledger with celocli as you do on
Ledger Wallet
--no-header
hide table header from output
--no-truncate
do not truncate output to fit screen
--output=<option>
output in a more machine friendly format
<options: csv|json|yaml>
--signer=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
address of the signer to check if elected (and validating)
--sort=<value>
property to sort by (prepend '-' for descending)
--start=<value>
[default: -1] what block to start at when looking at signer activity. defaults to
the last 100 blocks
--useLedger
Set it to use a ledger wallet
--validator=0xc1912fEE45d61C87Cc5EA59DaE31190FFFFf232d
address of the validator to check if elected (and validating)
DESCRIPTION
Shows the consensus status of a validator. This command will show whether a validator
is currently elected, would be elected if an election were to be run right now, and
the percentage of blocks signed and number of blocks successfully proposed within a
given window.
EXAMPLES
status --validator 0x5409ED021D9299bf6814279A6A1411A7e866A631
status --validator 0x5409ED021D9299bf6814279A6A1411A7e866A631 --start 1480000
status --all --start 1480000 --end 1490000
FLAG DESCRIPTIONS
-n, --node=<value> URL of the node to run commands against or an alias
Can be a full url like https://forno.celo.org or an alias. default:
http://localhost:8545
Alias options:
local, localhost => 'http://localhost:8545'
testnet, celo-sepolia => Celo Sepolia Testnet,
mainnet, celo, forno => Celo Mainnet chain',