Merge pull request #12 from automata-network/v2

Release v0.2.0

.gitignore

@@ -1,3 +1,10 @@
 
 holesky/config/operator.json
 holesky/config/operator_task_fetcher.offset
+mainnet/config/operator.json
+mainnet/config/operator_task_fetcher.offset
+holesky/.env
+mainnet/.env
+*/config/*.crt
+*/config/*.key
+prover/*/config/prover.json

README.md

@@ -4,7 +4,14 @@ Automata is building TEE Coprocessors on EigenLayer with Multi-Prover AVS. Decen
 
 ![architecture](./architecture.png)
 
+## ChangeLog
+
+* **v0.2.0**
+  * [holesky](holesky/CHANGELOG.md)
+  * [mainnet](mainnet/CHANGELOG.md)
 
 ## Runbooks
-* [Holesky testnet](holesky/README.md)
-* [Ethereum mainnet](mainnet/README.md)
+* [Operator - Holesky testnet](holesky/README.md)
+* [Operator - Ethereum mainnet](mainnet/README.md)
+* [Moniroring](monitoring)
+* [SGX Prover](prover)

holesky/CHANGELOG.md

@@ -0,0 +1,78 @@
+# Changelog
+
+>
+> 💡 Check the [README](./README.md) if you are looking for setup from scratch
+>
+
+## Table of Contents <!-- omit in toc -->
+- [Introduction](#introduction)
+- [General Flow](#general-flow)
+- [Version Specific Changes](#version-specific-changes)
+  - [Version 0.2.0](#version-020)
+
+
+## Introduction
+If you are currently running an older version of the operator and its corresponding components, this guide will cover how to upgrade to the newer version.
+
+## General Flow
+If you are running your operator using docker compose, you can upgrade with the following steps.
+
+1. First pull the latest copy of this repo:
+
+```bash
+cd holesky
+
+git pull
+```
+
+2. Please check [the section below](#version-specific-changes) for the specific changes you need to make per version before rebooting your services.
+
+3. Stop the the existing services:
+
+```bash
+docker compose down
+```
+
+4. Now, restart the service:
+```bash
+docker compose up -d
+```
+
+
+## Version Specific Changes
+
+### Version 0.2.0
+
+#### Operator Configuation Updates <!-- omit in toc -->
+
+**Required updates** to `operator.json`:
+- Add `"NodeApiIpPortAddress": "0.0.0.0:15692",`
+- Update `"TEELivenessVerifierAddress": "0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6"`
+
+**Recommended updates** to `operator.json`: <!-- omit in toc -->
+- Update `AttestationLayerEcdsaKey`: If you are currently using your operator's ECDSA private key for this, it is recommended to change it to use a separate externally owned account (EOA). Please fund 1 holETH to this EOA. For your security, we recommend using this EOA for the sole purpose of submitting attestations.
+
+
+**Optional updates** to `operator.json`: <!-- omit in toc -->
+- Remove `"TaskFetcher": { ... }`
+- Remove `"ETHWsURL": "wss://ethereum-holesky-rpc.publicnode.com", `
+- Remove `"Simulation": false,`
+
+#### Metrics Dashboard <!-- omit in toc -->
+
+We have also included monitoring dashboards in this release. Please feel free to use them to monitor your node and services: [monitoring](../monitoring)
+
+#### SGX Prover <!-- omit in toc -->
+
+In this version, we support running your own SGX Prover. Please refer to the following link for how to run: [prover](../prover)
+
+### FAQ
+
+* **Why I got this error when I start the operator?**
+
+```
+[FATAL] [operator.(*Operator).registerAttestationReport:416(balance:0.1);operator.(*Operator).RegisterAttestationReport:462;operator.(*Operator).Start:120(xxx)] execution reverted
+```
+
+1. Check whether the `TEELivenessVerifierAddress` in config updated to `0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6`
+2. Check whether the balance of the `AttestationLayerEcdsaKey` is enough for sending a transaction (0.005 holETH)c

holesky/config/operator.json.example

@@ -2,21 +2,12 @@
     "BlsKeyFile": "~/.eigenlayer/operator_keys/operator.bls.key.json",
     "BlsKeyPassword": "",
     "ProverURL": "https://avs-prover-staging.ata.network",
-    "Simulation": false,
     "ETHRpcURL": "https://ethereum-holesky-rpc.publicnode.com",
-    "ETHWsURL": "wss://ethereum-holesky-rpc.publicnode.com", 
     "AggregatorURL": "https://avs-aggregator-staging.ata.network",
     "EigenMetricsIpPortAddress": "0.0.0.0:15682",
+    "NodeApiIpPortAddress": "0.0.0.0:15692",
     "AttestationLayerRpcURL": "https://ethereum-holesky-rpc.publicnode.com",
     "AttestationLayerEcdsaKey": "",
-    "TaskFetcher": {
-        "OffsetFile": "config/operator_task_fetcher.offset",
-        "Endpoint": "https://1rpc.io/eth",
-        "Topics": [["0x2c32d4ae151744d0bf0b9464a3e897a1d17ed2f1af71f7c9a75f12ce0d28238f"]],
-        "Addresses": [
-            "0xa13baf47339d63b743e7da8741db5456dac1e556"
-        ]
-    },
     "RegistryCoordinatorAddress": "0x62c715575cE3Ad7C5a43aA325b881c70564f2215",
-    "TEELivenessVerifierAddress": "0x63AED86c0c6Df1e60E01AAF9bcD39ad5cD2e3344"
+    "TEELivenessVerifierAddress": "0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6"
 }

holesky/docker-compose.yaml

@@ -1,13 +1,19 @@
-version: '3'
+networks:
+  multiprover-network:
+    name: multiprover-avs-network
 
 services:
   operator:
-    image: ghcr.io/automata-network/multi-prover-avs/operator:v0.1.3
+    image: ghcr.io/automata-network/multi-prover-avs/operator:v0.2.0
     container_name: multi-prover-operator
     command: -c /config/operator.json
     ports:
-      - "15682:15682"
+      - "15692:15692"
+    expose:
+      - 15682
     volumes:
       - ./config:/config
       - "${BLS_KEY_FILE_HOST}:${BLS_KEY_FILE_DOCKER}:readonly"
     working_dir: /
+    networks:
+      - multiprover-network

holesky/run.sh

@@ -1,8 +1,13 @@
 #!/bin/bash -e
 
-. ./helper.sh
+. $(dirname $0)/../utils/helper.sh
+cd $(dirname $0)
+_init_run
 
 cmd=$1
+if [[ "$cmd" == "" ]]; then
+	_available_cmd $0
+fi
 shift
 ecdsa_key=$1
 if [[ "$ecdsa_key" != "" ]]; then
@@ -11,21 +16,19 @@ fi
 
 if [ "$cmd" = "opt-in" ]; then
 	_require_ecdsa_key "$ecdsa_key"
-	. ./docker-compose-env.sh
 	_oprtool optin $ecdsa_key "$@"
 elif [ "$cmd" = "opt-out" ]; then
 	_require_ecdsa_key "$ecdsa_key"
-	. ./docker-compose-env.sh
 	_oprtool optout $ecdsa_key "$@"
 elif [ "$cmd" = "deposit" ]; then
 	_require_ecdsa_key "$ecdsa_key"
-	. ./docker-compose-env.sh
 	_oprtool deposit $ecdsa_key "$@"
 elif [ "$cmd" = "operator" ]; then
-	. ./docker-compose-env.sh
+	_operator_check
 	docker compose up -d
 elif [ "$cmd" = "operator-log" ]; then
 	docker compose logs
 else
-  echo "Invalid command"
+	echo "Invalid command"
+	_available_cmd $0
 fi

mainnet/CHANGELOG.md

@@ -0,0 +1,45 @@
+# Change Logs
+
+>
+> 💡 Check the [README](./README.md) if you are looking for setup from scratch
+>
+
+## Table of Contents <!-- omit in toc -->
+- [Introduction](#introduction)
+- [General Flow](#general-flow)
+- [Version Specific Changes](#version-specific-changes)
+  - [Version 0.2.0](#version-020)
+
+
+## Introduction
+If you are currently running an older version of the operator and its corresponding components, this guide will cover how to upgrade to the newer version.
+
+## General Flow
+If you are running your operator using docker compose, you can upgrade with the following steps.
+
+1. First pull the latest copy of this repo:
+
+```bash
+cd mainnet
+
+git pull
+```
+
+2. Please check [the section below](#version-specific-changes) for the specific changes you need to make per version before rebooting your services.
+
+3. Stop the the existing services:
+
+```bash
+docker compose down
+```
+
+4. Now, restart the service:
+```bash
+docker compose up -d
+```
+
+
+## Version Specific Changes
+
+### Version 0.2.0
+TBD