Skip to content

Commit

Permalink
docs: add operator FAQ and troubleshooting guide (#920)
Browse files Browse the repository at this point in the history
Co-authored-by: Gian <58370608+glpecile@users.noreply.github.com>
  • Loading branch information
JuArce and glpecile authored Sep 5, 2024
1 parent e282e12 commit 7c32f61
Show file tree
Hide file tree
Showing 3 changed files with 113 additions and 0 deletions.
2 changes: 2 additions & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,8 @@
## Operators

* [Running an operator](operator_guides/0_running_an_operator.md)
* [Operator FAQ](operator_guides/1_operator_FAQ.md)
* [Troubleshooting](operator_guides/2_troubleshooting.md)

## Useful links

Expand Down
65 changes: 65 additions & 0 deletions docs/operator_guides/1_operator_FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Operator FAQ

The EigenLayer Operator FAQ is available [here](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-faq).

### How do I get whitelisted to run an operator?

To get whitelisted,
you need to fill out the form available [here](https://docs.google.com/forms/d/e/1FAIpQLSdH9sgfTz4v33lAvwj6BvYJGAeIshQia3FXz36PFfF-WQAWEQ/viewform)
and wait for the Aligned team to approve your request.

### What RPC should I use?

We suggest you use your own nodes for better performance and reliability. Note that the node must support HTTP and WebSockets.

We also recommend the following RPC providers:

- [Infura](https://infura.io/)
- [Blast](https://blastapi.io/)

The default configuration uses the public nodes RPC.

Since `v0.5.2`, there is a fallback mechanism to have two RPCs, so you need to add a second RPC for redundancy.

### How can I check if the version I'm using is the latest one?

You can check the latest version available on the [releases' page](https://github.com/yetanotherco/aligned_layer/releases).

### How do I check the operator version registered on the Aligned version tracking system?

You can get the registered version of your operator by running the following command:

```bash
curl https://holesky.tracker.alignedlayer.com/versions/<operator_address>
```

Replace `<operator_address>` with your operator address.

In future releases, the explorer will show the operator version and the latest available version.

### How do I check the operator version locally?

To see the operator version, run:

```bash
./operator/build/aligned-operator --version
```

You have to be in the root `aligned-layer` directory to run this command.

This will show the version of the operator you have built in your filesystem.

### How do I get the ID of the operator?

You can get the ID of the operator by running the following command:

```bash
cast call \
--rpc-url https://ethereum-holesky-rpc.publicnode.com \
0xD0A725d82649f9e4155D7A60B638Fe33b3F25e3b \
"getOperatorId(address operator)(bytes32)" <operator_address>
```

> Note: You need to have installed [Foundry](https://book.getfoundry.sh/)
This will return the operator ID if the operator is registered, otherwise it will return `0x`.
46 changes: 46 additions & 0 deletions docs/operator_guides/2_troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Troubleshooting

### How to resolve the error "Error in new task subscription"

This error is caused by the operator not being able to subscribe to the task.

Make sure you have configured the RPC correctly and verify that the node is running.

The following RPC providers are known to have issues:

- [dRPC](https://drpc.org/)

### My operator is not showing up on the Aligned Explorer

The [explorer](https://explorer.alignedlayer.com/) does not update the operator status in real time.
The explorer updates the operators' list every 1 hour.

If your operator is not showing up after 1 hour, please check the following:

- The operator is **whitelisted** on the Aligned AVS, you can run the following command:

```bash
cast call \
--rpc-url https://ethereum-holesky-rpc.publicnode.com \
0x3aD77134c986193c9ef98e55e800B71e72835b62 \
"isWhitelisted(address _address)(bool)" <operator_address>
```

If the operator is whitelisted, it will return `true`.

- The operator is **registered** on the Aligned AVS:

```bash
cast call \
--rpc-url https://ethereum-holesky-rpc.publicnode.com \
0xD0A725d82649f9e4155D7A60B638Fe33b3F25e3b \
"getOperatorId(address operator)(bytes32)" <operator_address>
```

If the operator is not registered, it will return `0x0` otherwise it will return the operator ID.

### How to resolve the error "Eth ws url or fallback is empty" or "Eth rpc url or fallback is empty"

This error is caused by the operator not being able to get the RPC urls.

Make sure you have configured the RPC correctly in the [config file](0_running_an_operator.md#step-3---update-the-configuration-for-your-specific-operator).

0 comments on commit 7c32f61

Please sign in to comment.