Skip to content

Latest commit

 

History

History
271 lines (186 loc) · 9.48 KB

README.md

File metadata and controls

271 lines (186 loc) · 9.48 KB
Raw

Ava Protocol Operator setup

This guide will walk you through the process of registering as an operator to Ava OProtocol AVS and running the Ava Protocol software.

This guide focus on running everything with-in docker container. If you don't want to use docker container, you can follow other guide instead

Prerequisite

An operator need to be onboard and setup their own operator with EigenLayer, following the official document

Software/Hardware Requirement

  • Operating System: Linux, MacOS

  • CPU: x64/arm.

  • vCPUs: 1

  • Memory: 1GiB

  • Storage: 100GB

  • EC2 Equivalent: c6gd.medium, m6g.medium, c7a.medium, c6g.large

  • Expected Network Utilization:

    • Total download bandwidth usage: 1 Mbps
    • Upload bandwidth usage: 1 Mbps

  • Incoming Ports:

    • Mainnet: 9190, 9191.
    • Holesky: 9290, 9291

  • Outgoing Ports: 2206

If your cloud providers support Arm CPU, we suggest to use Arm because it's more cost effective.

Operator Setup

1. Clone this repository

git clone [email protected]:AvaProtocol/ap-operator-setup.git

cd ap-operator-setup

We had two directory call holesky and ethereum. To setup testnet, you will do everything inside hokesky directory. For mainnet deployment, you would use files inside ethereum directory.

2. Prepare config file and credential

To setup for holesky testnet, we would do everything inside holesky directory. To setup for ethereum mainnet, we would do everything inside ethereum directory.

Inside holesky or ethereum directory, We will need to prepare 2 files: .env and config.yaml.

  1. Make sure you are under ethereum or holesky direction, and prepare .env file

    cp .env.example .env

  2. Then, edit it and fill in 5 things:

    Specify your operator’s keystore location and password. These are to be used to commit to your registered operator.

    - ECDSA_KEYSTORE_PATH=
- ECDSA_KEY_PASSWORD=
- BLS_KEYSTORE_PATH=
- BLS_KEY_PASSWORD=

    Besides, the DB_PATH is to specify the local path to store your operator’s data for our AVS.

    - DB_PATH=

    We don't use high io so you can store on a normal volume such as gp3 wih 3000 IOPS on EC2.

    If the default ports of PUBLIC_NODEAPI_PORT and PUBLIC_METRICS_PORT were used by different processes, you can also set them to any available ports in your env file too. Make sure to also open firewall to allow traffic incoming to these 2 ports. The default value is as following:

  3. Next, we will create config.yaml file for operator:

    cp config.yaml.example config.yaml

    Only change the value of operator_address to your own operator wallet address.

2.b One-time task: Register your operator to Ava Protocol AVS

This step is only needed to be done once per operator. Also, recall that you would need to cd into holesky for testnet and ethereum for mainnet before running anything.

docker compose run ap-operator register --config=/app/config.yaml

To check the registration status at any given time you can also do:

docker compose run ap-operator status --config=/app/config.yaml

Ensure that you successfully register your operator before moving to step 3.

2.c (Optinal) One-time task: Setting up alias key

At this moment, you're all set to run AP AVS and move to step 3. The step described in 2.c involves security hardening. It's more complicated to set up and less convenient, but it improves key management.

The operator ECDSA key allows access to funds under that key. Optionally, you can use a different ECDSA key pair from your EigenLayer operator ECDSA key and bind this new alias key to your operator. This way, your operator can use the new alias key to interact with the Ava Protocol, and we will still be able to identify your operator address. At the same time, the AP AVS software will not have access to your operator ECDSA key.

The process includes two steps:

  • Generate or import an existing ECDSA key to create an alias key.
  • Bind the alias key to your operator ECDSA key.

While it's not necessary to perform these steps, doing so enhances security by ensuring that your operator ECDSA key remains protected.

You do need access to the operator ECDSA key to perform below steps.

Generate alias key

We will generate an alias key and temporarily put them in a folder call keys. You will move them to the right location later.

# create the temp directory to hold the generated keys
mkdir keys

docker compose run -v `pwd`/keys:/app/keys/ ap-operator --config=/app/config.yaml create-alias-key --name=/app/keys/alias-ecdsa.key.json

A file call alias-ecdsa.key.json should be created inside the keys directory. You can move it to the right place on your node. This will be your alias key moving forward.

Declare the alias key for your operator

Now, we will send an on-chain transaction from your operator ECDSA key to bind the newly generated alias key to it.

Ensure your operator ECDSA key has some fund in it to pay for the gas fee.

docker compose run -v path-to-the-alias-ecdsa-key.json-above-on-your-node:/app/keys/alias-ecdsa.key.json ap-operator declare-alias --config=/app/config.yaml --name=/app/keys/alias-ecdsa.key.json

You should see a message like this at the end

succesfully declared an alias for operator [your-operator-keys] alias address [your-alias-address-key] at tx [tx-hash]

Now, in your .env file, you can replace ECDSA_KEYSTORE_PATH, which is pointed to your operator ECDSA key, to point to the path of the alias key we just create in above step.

ECDSA_KEYSTORE_PATH=<path-to-the-above-alias-ecdsa-key-file-above>

You're all set to move to step 3) to run your operator with the alias key. At any given time, you can also just change the ECDSA_KEYSTORE_PATH to point to your original operator ECDSA key to perform operation that require the operator ECDSA key. Usually, only the registraion and deregistration require that key.

3. Start to run our AVS

  1. Make sure you are under ./ethereum or ./holesky directory.

  2. Run the following command to start the operator

    docker compose pull

docker compose up --force-recreate

    Once the operator is up and running, the output log will look like below.

    docker compose up --force-recreate -d
[+] Running 1/0
✔ Container ap_operator  Created
✔ Container ap_operator  Started

    To view the operator log itself, you can do:

    docker compose logs -f

    The log should appear similar to this:

    ap_operator  | {"level":"info","ts":1719529804.5644045,"caller":"operator/operator.go:263","msg":"Connect to aggregator aggregator-holesky.avaprotocol.org:2206"}
ap_operator  | {"level":"info","ts":1719529804.8751178,"caller":"operator/operator.go:307","msg":"Operator info","operatorId":[74,60,26,85,160,147,136,79,102,183,189,62,99,76,192,151,203,7,97,85,230,236,25,160,46,242,83,194,177,93,63,163],"operatorAddr":"0x2273e70Ea0F159985a9312e875839CbF242f162e","operatorG1Pubkey":"E([13980129839750270625587959504067205960106881892608925358182969477593110597180,2713793992502006479543294653290264953732656227600455037615150886215476630684])","operatorG2Pubkey":"E([10006440951214432193970386287330007898372605552301114697229665952718363326438+2917899138783614023915162275072742305856792653861495716209344717215206657922*u,20465317265628248898772842070116958367267377808142334627836040792686631701030+11895853732396257221594908719294998059804388586884333547663795174064486592588*u])"}
ap_operator  | {"level":"info","ts":1719529805.3309655,"caller":"operator/operator.go:330","msg":"Starting operator."}
ap_operator  | {"level":"info","ts":1719529805.3310997,"caller":"nodeapi/nodeapi.go:104","msg":"Starting node api server at address 0.0.0.0:9010"}
ap_operator  | {"level":"info","ts":1719529805.33198,"caller":"metrics/eigenmetrics.go:81","msg":"Starting metrics server at port 0.0.0.0:9090"}
ap_operator  | {"level":"info","ts":1719529805.3321455,"caller":"nodeapi/nodeapi.go:238","msg":"node api server running","addr":"0.0.0.0:9010"}

FAQ

How to update

# pull the lastest change from our repository
git pull

# cd into either mainnet or holesky directory depend on mainne or testnet
cd ethereum

# then issue a pull command to fetch latest image
docker compose pull

# finally restart the container with the new image
docker compose up --force-recreate -d

How to configure auto update

If you want to configure auto update, check our instruction in watchtower

How to check that my operator is working

When your operator connects to aggregator, it will reports telemetry which we can check to ensure your operator is working properly. We're currently working on prometheus metrics and dashboard to provide operator with visibility.

Beside, you will see some log indicate that the operator is working and processing task that our aggregator asked it to do.

You can also visit the telemetry dashboard

Testnet Operator Status Page

https://aggregator-holesky.avaprotocol.org/telemetry

Ethereum Operator Status Page

https://aggregator.avaprotocol.org/telemetry

Monitoring your AVS.

We provide a prometheus and grafana stack in a completed docker compose setup inside monitor directory. This docker compose stack can be used to configure an end to end monitoring solution for your AVS.