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

More complete RPC provider instructions #1665

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/cel2/operators/community-rpc-provider.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# Running community RPC node

After Celo mainnet transitions to Celo L2, validators that are registered and elected can continue to receive rewards by running PRC nodes. These steps outline how validators can publish the URL of their RPC node in order to be eligible for rewards. To reduce the risk of slashing, these steps should be followed before the L2 upgrade.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
After Celo mainnet transitions to Celo L2, validators that are registered and elected can continue to receive rewards by running PRC nodes. These steps outline how validators can publish the URL of their RPC node in order to be eligible for rewards. To reduce the risk of slashing, these steps should be followed before the L2 upgrade.
After Celo mainnet transitions to Celo L2, validators that are registered and elected can continue to receive rewards by running RPC nodes. These steps outline how validators can publish the URL of their RPC node in order to be eligible for rewards. To reduce the risk of slashing, these steps should be followed before the L2 upgrade.


## Registering

If you're not yet a validator, you must first register. You can follow the instructions to do so [here](/network/mainnet/run-validator#registering-as-a-validator).


## Run a node

If you're not yet running a node, see the [following instructions](/cel2/operators/docker-node).

## Register as a community RPC provider

To register as a RPC provider, a public https url needs to be registered on-chain. To do this, we will register the rpc url in a signed metadata file that's used to share additional information about Celo accounts.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To register as a RPC provider, a public https url needs to be registered on-chain. To do this, we will register the rpc url in a signed metadata file that's used to share additional information about Celo accounts.
To register as a RPC provider, a public HTTPS URL needs to be registered on-chain. To do this, we will register the RPC URL in a signed metadata file that's used to share additional information about Celo accounts.
The metadata file has to be made available publicly and the URL where this file is hosted has to be registered on-chain as well.


> Make sure to be in CLI in version at least `6.0.0-beta.5`
>

The `--from` flag in the CLI can either be the validator account itself, or the validator signer.

1. Create a new metadata file. If, instead, you want to update an existing one, download it instead of creating it.

`$ celocli account:create-metadata ./metadata.json --from $VALIDATOR_SIGNER`

2. Register your public RPC url:

`$ celocli account:claim-rpc-url ./metadata.json --from $VALIDATOR_SIGNER --rpcUrl $RPC_URL`

3. Upload this metadata file to a publicly available URL with high availability.
4. Now link this URL to the validator Celo account:

`$ celocli account:register-metadata --url $METADATA_URL --from $ACCOUNT_ADDRESS`

5. Verify that the metadata registration was successful by retrieving it:

`$ celocli account:get-metadata $ACCOUNT_ADDRESS`
5 changes: 5 additions & 0 deletions docs/network/baklava/run-validator.md
Original file line number Diff line number Diff line change
Expand Up @@ -517,6 +517,11 @@ celocli validatorgroup:show $CELO_VALIDATOR_GROUP_ADDRESS

Next, register your Validator by running the following command. Note that because we have authorized a Validator signer, this step could also be performed on the Validator machine. Running it on the local machine allows us to avoid needing to install the [`celocli`](https://docs.celo.org/cli) on the Validator machine.

:::tip
After the Celo L2 transition, make sure to use CLI version at least `6.0.0-beta.5. It is then not needed to include the flags `blsKey` nor `blsSignature`.

:::

```bash
# On your local machine
celocli validator:register --from $CELO_VALIDATOR_ADDRESS --ecdsaKey $CELO_VALIDATOR_SIGNER_PUBLIC_KEY --blsKey $CELO_VALIDATOR_SIGNER_BLS_PUBLIC_KEY --blsSignature $CELO_VALIDATOR_SIGNER_BLS_SIGNATURE
Expand Down
5 changes: 5 additions & 0 deletions sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -1331,6 +1331,11 @@ const sidebars = {
label: "Migrating an L1 node",
id: "cel2/operators/migrate-node",
},
{
type: "doc",
label: "Migrating an L1 archive node",
id: "cel2/operators/migrate-archive-node",
},
{
type: "doc",
label: "Running a community RPC node",
Expand Down