# Operator Guide

This guide contains the steps needed to set up and register your node for DODOchain MACH AVS.

## Minimal system requirements

* 4 CPU
* 16GB Memory
* 50GB SSD
* Ubuntu 24.04 LTS
* [Docker](https://docs.docker.com/engine/install/) v24 and above
* EigenLayer CLI

## Minimal stake requirements

💡 For smooth onboarding of operators, we will set the initial stake requirement to be 0.

## Supported token strategy

Beacon Chain Ether and all LSTs supported by EigenLayer are supported by our AVS.

## Operator setup

#### Key generation and wallet funding

1. Follow [EigenLayer guide](https://docs.eigenlayer.xyz/eigenlayer/operator-guides/operator-installation#installation-1) and Install EigenLayer CLI
2. Generate ECDSA and BLS keypair using the following command

```bash
eigenlayer operator keys create --key-type ecdsa [keyname]
eigenlayer operator keys create --key-type bls [keyname]
```

💡 **Please ensure you backup your private keys to a safe location. By default, the encrypted keys will be stored in \~/.eigenlayer/operator\_keys/**

1. Fund at least 0.3 ETH to the ECDSA address generated. It will be required for node registration in the later steps.
2. Please submit the ECDSA address via MACH AVS interest form <https://forms.gle/3A6xNWwRf9ip9CnN9>.

#### Register on EigenLayer as an operator

💡 **You may skip the following steps if you are already a registered operator on the EigenLayer testnet and mainnet.**

**You will need to do it once for testnet and once for mainnet.**

1. Create the configuration files needed for operator registration using the following commands. Follow the step-by-step prompt. Once completed, `operator.yaml` and `metadata.json` will be created.

```jsx
eigenlayer operator config create
```

2. Edit `metadata.json` and fill in your operator's details.

```json
{
  "name": "Example Operator",
  "website": "<https://example.com/>",
  "description": "Example description",
  "logo": "<https://example.com/logo.png>",
  "twitter": "<https://twitter.com/example>"
}
```

3. Upload `metadata.json` to a public URL. Then update the `operator.yaml` file with the url (`metadata_url`). If you need hosting service to host the metadata, you can consider uploading the metadata [gist](https://gist.github.com/) and get the `raw` url.
4. If this is your first time registering this operator, run the following command to register and update your operator

   ```bash
   eigenlayer operator register operator.yaml

   ```

   Upon successful registration, you should see `✅ Operator is registered successfully to EigenLayer`

   If you need to edit the metadata in the future, simply update `metadata.json` and run the following command

   ```bash
   eigenlayer operator update operator.yaml
   ```
5. After your operator has been registered, it will be reflected on the [EigenLayer operator page](https://holesky.eigenlayer.xyz/operator).

   Testnet: <https://holesky.eigenlayer.xyz/operator>

   Maiinnet: <https://app.eigenlayer.xyz/operator>

<figure><img src="https://3112893033-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F8DRtEPgHrIg4b65B1smQ%2Fuploads%2FGRJ8DScP7WBuPuwn4vmc%2Fimage.png?alt=media&#x26;token=e7cda65f-1b14-4bcf-bc7b-c8a8a7cca1c9" alt=""><figcaption></figcaption></figure>

You can also check the operator registration status using the following command.

```bash
eigenlayer operator status operator.yaml
```

## Joining MACH AVS

💡 **Training wheels** AltLayer Mach AVS will initially launch in operator allowlist mode. Interested operators can register their interest with us using this form: <https://forms.gle/LmPABTNQcwJhw4UB7>

### Mach AVS Setup

#### Clone the Mach AVS repository

Run the following command to clone the [MACH AVS operator repository](https://github.com/alt-research/mach-avs-operator-setup) and change directory to DODOchain MACH AVS mainnet config.&#x20;

{% hint style="info" %}
DODOchain MACH mainnet AVS will initially provide service to DODOchain testnet. Once DODOchain goes mainnet, DODOchain MACH mainnet AVS will switch over to DODOchain mainnet
{% endhint %}

```bash
git clone https://github.com/alt-research/mach-avs-operator-setup.git
cd mach-avs-operator-setup/ethereum/mach-avs/dodochain-testnet
```

#### Opt-in and out of MACH AVS

For opt-in and out, copy the following env

```
cp .env.opt-example .env.opt
```

Update the `TODO` sections in the `.env.opt`

```bash
###############################################################################
####### TODO: Operators please update below values for your node ##############
###############################################################################
# TODO: Set the metadata url for operator
METADATA_URI=https://path/to/metadata.json

# TODO: Operators need to update this to their own paths
USER_HOME=${HOME}
EIGENLAYER_HOME=${USER_HOME}/.eigenlayer

# TODO: Operators need to update this to their own keys
NODE_ECDSA_KEY_FILE_HOST=${EIGENLAYER_HOME}/operator_keys/opr.ecdsa.key.json
NODE_BLS_KEY_FILE_HOST=${EIGENLAYER_HOME}/operator_keys/opr.bls.key.json

# TODO: Operators need to add password to decrypt the above keys
# If your password contain space, / or $, please use single quote to 
# encapsulate your password e.g 'mypassword /$'
OPERATOR_BLS_KEY_PASSWORD=
OPERATOR_ECDSA_KEY_PASSWORD=
```

**To opt-in**

💡 Before you opt-in to MACH AVS, please ensure that

1. You have the right infrastructure (e.g., cloud hosting) to keep the operator up and running. Non-performing AVS operators may be subjected to ejection out of MACH AVS.
2. You have already been whitelisted as an operator for MACH AVS.

```bash
./run.sh opt-in 
```

**If you no longer want to run the AVS, you can opt out by running**

```bash
./run.sh opt-out 
```

💡 It may take a few minutes for EigenLayer AVS and operator page to be updated This is an automatic process.

#### Running MACH AVS

#### Create the environment file

```bash
cp .env.example .env
```

#### Configuring MACH AVS operator

Update the `TODO` sections in the `.env`

💡 **The default path where your generated keys are stored in \~/.eigenlayer/operator\_keys/**

```bash
###############################################################################
####### TODO: Operators please update below values for your node ##############
###############################################################################
# TODO: Operators need to update this to their own paths
USER_HOME=${HOME}
EIGENLAYER_HOME=${USER_HOME}/.eigenlayer

# TODO: Operators need to set it ecdsa address
# can got by `eigenlayer operator keys list`, the address is in `Key Type: ECDSA`
OPERATOR_ECDSA_ADDRESS=

# TODO: Operators need to update this to their own keys
NODE_BLS_KEY_FILE_HOST=${EIGENLAYER_HOME}/operator_keys/opr.bls.key.json

# TODO: Operators need to add password to decrypt the above keys
# If your password contain space, / or $, please use single quote to 
# encapsulate your password e.g 'mypassword /$'
OPERATOR_BLS_KEY_PASSWORD=
```

#### Configuring rollup endpoint

We have pre-configured `mach-config.toml` with RPC hosted by AltLayer. Alternatively, you can reach out to the AltLayer team members on the Slack working group for instructions on how to host your own RPC node.

**If you encounter rate limits on public endpoints, we recommend that you use managed RPC services such as** [**Infura**](https://www.notion.so/897c331db50947f480b9e45c22f410e5?pvs=21)**,** [**Alchemy**](https://www.alchemy.com/)**, or** [**QuickNode**](https://www.quicknode.com/)&#x20;

If you wish to update L1 or Rollup RPC,&#x20;

1. Navigate to `/chain-config/mach-config.toml`
2. Locate the `fetcher` and  `l1-fetcher.` Look for the variable `url` and `l1_url`. Replace the value with your endpoint.

## Running MACH AVS

To run MACH AVS, you may launch it using docker compose.

```bash
docker compose pull --policy always
docker compose pull
docker compose up -d 
```

To tear down the container

```
docker compose down
```

If you want to enable monitoring, run the following

```
docker compose --profile monitoring up
```

If you want to stop the monitoring:

```
docker compose --profile monitoring down
```

When using the `monitoring` profile, you  may wish to add `grafana` to monitor the service, the default port is `1300` can access via `localhost:13000`.

## Helm chart

To run MACH AVS within your Kubernetes cluster, you can use the reference Helm chart available in the MACH AVS Operator Setup repository. You can find the Helm chart at the following link: [MACH Operator Helm Chart](https://github.com/alt-research/mach-avs-operator-setup/tree/master/helm-charts/mach-operator).&#x20;

## Facing issues?

Please feel free to reach out to us via the Slack working group.

## Frequently ask questions

1. **How do I know whether my operator is running?**

First, check whether your operator docker container is running, by running `docker compose ps`.

```bash
docker compose ps    
NAME                         IMAGE                                          COMMAND                  SERVICE                  CREATED          STATUS          PORTS
mach-avs-operator-node       public.ecr.aws/altlayer/mach-operator:latest   "operator"               mach-operator-node       33 seconds ago   Up 32 seconds   0.0.0.0:9092->9092/tcp, :::9092->9092/tcp
mach-avs-operator-verifier   public.ecr.aws/altlayer/mach:latest            "/usr/local/bin/op-m…"   mach-operator-verifier   33 seconds ago   Up 32 seconds   0.0.0.0:9094->9094/tcp, :::9094->9094/tcp, 9715/tcp
mach-avs-reverse-proxy-1     nginx:latest                                   "/docker-entrypoint.…"   reverse-proxy            33 seconds ago   Up 32 seconds   80/tcp, 0.0.0.0:9091->9091/tcp, :::9091->9091/tcp
```

Next, you can check the logs to see whether the services has been started or not

```bash
2024-04-01T17:04:29.613Z        INFO    logging/zap_logger.go:49        Start operator  {"address": "0xAD6B95793DD4D2b8e184FB4666D1cfb14871A035"}
2024-04-01T17:04:29.956Z        INFO    logging/zap_logger.go:69        Starting operator.
2024-04-01T17:04:29.956Z        INFO    logging/zap_logger.go:69        Starting node api server at address 0.0.0.0:9091
2024-04-01T17:04:29.956Z        INFO    logging/zap_logger.go:69        Starting metrics server at port 0.0.0.0:9092
2024-04-01T17:04:29.956Z        INFO    logging/zap_logger.go:49        start rpc server for got alert
2024-04-01T17:04:29.957Z        INFO    logging/zap_logger.go:49        node api server running {"addr": "0.0.0.0:9091"}
```

2. **Who is running the aggregator and doing BLS signature aggregator?**

AltLayer will provide an aggregator to which your MACH AVS can connect and submit the signatures for aggregation. The aggregator endpoint has been pre-configured in the configuration file.

3. **How do I know when I do not meet sufficient minimal stake requirements during registration?** You will encounter `execution reverted: StakeRegistry.registerOperator: Operator does not meet minimum stake`

```bash
2024-04-02T19:05:40.535Z	INFO	logging/zap_logger.go:49	registering operator with the AVS's registry coordinator	{"avs-service-manager": "0xAE9a4497dee2540DaF489BeddB0706128a99ec63", "operator": "0x44220295991E4Fe4f3A4C5FE04E96B1b19960766", "quorumNumbers": "AA=="}
2024-04-02T19:05:42.162Z	ERROR	logging/zap_logger.go:57	Unable to register operator with avs registry coordinator	{"error": "execution reverted: StakeRegistry.registerOperator: Operator does not meet minimum stake requirement for quorum"}
github.com/Layr-Labs/eigensdk-go/logging.(*ZapLogger).Error
```

4. **Will there be token rewards?**

There will be rewards for mainnet MACH AVS in the future. More details will be announced in the future.

5. **I am unable to opt in and encounter `Unable to register operator with avs registry coordinator`**&#x20;

Please check that your ECDSA address is sufficiently funded. We recommend maintaining at least 0.3 ETH to ensure you have sufficient gas tokens for AVS registering, opt-in and de-registering operations.&#x20;
