Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

List community RPC nodes #470

Draft
wants to merge 13 commits into
base: master
Choose a base branch
from
5 changes: 5 additions & 0 deletions .changeset/afraid-wombats-agree.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/metadata-claims': patch
---

Backwards compatibility for existing ATTESTATIONS_SERVICE_URL claims
5 changes: 5 additions & 0 deletions .changeset/curly-dolls-heal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@celo/celocli': minor
---

Introduce `validatorgroup:rpc-urls` command to list community RPC nodes
5 changes: 5 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ _Describe any minor or "drive-by" changes here. If none delete this section_

_An explanation of how the changes were tested or an explanation as to why they don't need to be._


### How to QA

_List of steps required to QA the change if applicable_

### Related issues

- Fixes #[issue number here]
96 changes: 96 additions & 0 deletions docs/command-line-interface/network.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,60 @@

View details about the network, like contracts and parameters

* [`celocli network:community-rpc-nodes`](#celocli-networkcommunity-rpc-nodes)
* [`celocli network:contracts`](#celocli-networkcontracts)
* [`celocli network:info`](#celocli-networkinfo)
* [`celocli network:parameters`](#celocli-networkparameters)
* [`celocli network:rpc-urls`](#celocli-networkrpc-urls)
* [`celocli network:whitelist`](#celocli-networkwhitelist)

## `celocli network:community-rpc-nodes`

Displays a list of community RPC nodes for the currently elected validator groups

```
USAGE
$ celocli network: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'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

## `celocli network:contracts`

Lists Celo core contracts and their addresses.
Expand Down Expand Up @@ -106,6 +155,53 @@ FLAG DESCRIPTIONS

_See code: [src/commands/network/parameters.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/network/parameters.ts)_

## `celocli network:rpc-urls`

Displays a list of community RPC nodes for the currently elected validator groups

```
USAGE
$ celocli network: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'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

## `celocli network:whitelist`

List the whitelisted fee currencies
Expand Down
48 changes: 48 additions & 0 deletions docs/command-line-interface/node.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
Manage your Celo node

* [`celocli node:accounts`](#celocli-nodeaccounts)
* [`celocli node:list`](#celocli-nodelist)
* [`celocli node:synced`](#celocli-nodesynced)

## `celocli node:accounts`
Expand Down Expand Up @@ -53,6 +54,53 @@ FLAG DESCRIPTIONS

_See code: [src/commands/node/accounts.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/node/accounts.ts)_

## `celocli node:list`

Displays a list of community RPC nodes for the currently elected validator groups

```
USAGE
$ celocli node:list [-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'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

## `celocli node:synced`

Check if the node is synced
Expand Down
96 changes: 96 additions & 0 deletions docs/command-line-interface/validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,14 @@
View and manage Validators

* [`celocli validator:affiliate ARG1`](#celocli-validatoraffiliate-arg1)
* [`celocli validator:community-rpc-nodes`](#celocli-validatorcommunity-rpc-nodes)
* [`celocli validator:deaffiliate`](#celocli-validatordeaffiliate)
* [`celocli validator:deregister`](#celocli-validatorderegister)
* [`celocli validator:downtime-slash`](#celocli-validatordowntime-slash)
* [`celocli validator:list`](#celocli-validatorlist)
* [`celocli validator:register`](#celocli-validatorregister)
* [`celocli validator:requirements`](#celocli-validatorrequirements)
* [`celocli validator:rpc-urls`](#celocli-validatorrpc-urls)
* [`celocli validator:set-bitmaps`](#celocli-validatorset-bitmaps)
* [`celocli validator:show ARG1`](#celocli-validatorshow-arg1)
* [`celocli validator:signed-blocks`](#celocli-validatorsigned-blocks)
Expand Down Expand Up @@ -79,6 +81,53 @@ FLAG DESCRIPTIONS

_See code: [src/commands/validator/affiliate.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/validator/affiliate.ts)_

## `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'
alfajores => Celo Alfajores 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.
Expand Down Expand Up @@ -426,6 +475,53 @@ FLAG DESCRIPTIONS

_See code: [src/commands/validator/requirements.ts](https://github.com/celo-org/developer-tooling/tree/master/packages/cli/src/commands/validator/requirements.ts)_

## `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'
alfajores => Celo Alfajores Testnet,
mainnet, celo, forno => Celo Mainnet chain',
```

## `celocli validator:set-bitmaps`

Set validator signature bitmaps for provided intervals
Expand Down
Loading
Loading