Skip to content

Commit dbb484a

Browse files
authored
Merge pull request #12 from automata-network/v2
Release v0.2.0
2 parents c117491 + 79caf6f commit dbb484a

32 files changed

+26038
-223
lines changed

.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
11

22
holesky/config/operator.json
33
holesky/config/operator_task_fetcher.offset
4+
mainnet/config/operator.json
5+
mainnet/config/operator_task_fetcher.offset
6+
holesky/.env
7+
mainnet/.env
8+
*/config/*.crt
9+
*/config/*.key
10+
prover/*/config/prover.json

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,14 @@ Automata is building TEE Coprocessors on EigenLayer with Multi-Prover AVS. Decen
44

55
![architecture](./architecture.png)
66

7+
## ChangeLog
8+
9+
* **v0.2.0**
10+
* [holesky](holesky/CHANGELOG.md)
11+
* [mainnet](mainnet/CHANGELOG.md)
712

813
## Runbooks
9-
* [Holesky testnet](holesky/README.md)
10-
* [Ethereum mainnet](mainnet/README.md)
14+
* [Operator - Holesky testnet](holesky/README.md)
15+
* [Operator - Ethereum mainnet](mainnet/README.md)
16+
* [Moniroring](monitoring)
17+
* [SGX Prover](prover)

holesky/CHANGELOG.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Changelog
2+
3+
>
4+
> 💡 Check the [README](./README.md) if you are looking for setup from scratch
5+
>
6+
7+
## Table of Contents <!-- omit in toc -->
8+
- [Introduction](#introduction)
9+
- [General Flow](#general-flow)
10+
- [Version Specific Changes](#version-specific-changes)
11+
- [Version 0.2.0](#version-020)
12+
13+
14+
## Introduction
15+
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.
16+
17+
## General Flow
18+
If you are running your operator using docker compose, you can upgrade with the following steps.
19+
20+
1. First pull the latest copy of this repo:
21+
22+
```bash
23+
cd holesky
24+
25+
git pull
26+
```
27+
28+
2. Please check [the section below](#version-specific-changes) for the specific changes you need to make per version before rebooting your services.
29+
30+
3. Stop the the existing services:
31+
32+
```bash
33+
docker compose down
34+
```
35+
36+
4. Now, restart the service:
37+
```bash
38+
docker compose up -d
39+
```
40+
41+
42+
## Version Specific Changes
43+
44+
### Version 0.2.0
45+
46+
#### Operator Configuation Updates <!-- omit in toc -->
47+
48+
**Required updates** to `operator.json`:
49+
- Add `"NodeApiIpPortAddress": "0.0.0.0:15692",`
50+
- Update `"TEELivenessVerifierAddress": "0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6"`
51+
52+
**Recommended updates** to `operator.json`: <!-- omit in toc -->
53+
- 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.
54+
55+
56+
**Optional updates** to `operator.json`: <!-- omit in toc -->
57+
- Remove `"TaskFetcher": { ... }`
58+
- Remove `"ETHWsURL": "wss://ethereum-holesky-rpc.publicnode.com", `
59+
- Remove `"Simulation": false,`
60+
61+
#### Metrics Dashboard <!-- omit in toc -->
62+
63+
We have also included monitoring dashboards in this release. Please feel free to use them to monitor your node and services: [monitoring](../monitoring)
64+
65+
#### SGX Prover <!-- omit in toc -->
66+
67+
In this version, we support running your own SGX Prover. Please refer to the following link for how to run: [prover](../prover)
68+
69+
### FAQ
70+
71+
* **Why I got this error when I start the operator?**
72+
73+
```
74+
[FATAL] [operator.(*Operator).registerAttestationReport:416(balance:0.1);operator.(*Operator).RegisterAttestationReport:462;operator.(*Operator).Start:120(xxx)] execution reverted
75+
```
76+
77+
1. Check whether the `TEELivenessVerifierAddress` in config updated to `0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6`
78+
2. Check whether the balance of the `AttestationLayerEcdsaKey` is enough for sending a transaction (0.005 holETH)c

holesky/README.md

Lines changed: 75 additions & 49 deletions
Large diffs are not rendered by default.

holesky/config/operator.json.example

Lines changed: 2 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,12 @@
22
"BlsKeyFile": "~/.eigenlayer/operator_keys/operator.bls.key.json",
33
"BlsKeyPassword": "",
44
"ProverURL": "https://avs-prover-staging.ata.network",
5-
"Simulation": false,
65
"ETHRpcURL": "https://ethereum-holesky-rpc.publicnode.com",
7-
"ETHWsURL": "wss://ethereum-holesky-rpc.publicnode.com",
86
"AggregatorURL": "https://avs-aggregator-staging.ata.network",
97
"EigenMetricsIpPortAddress": "0.0.0.0:15682",
8+
"NodeApiIpPortAddress": "0.0.0.0:15692",
109
"AttestationLayerRpcURL": "https://ethereum-holesky-rpc.publicnode.com",
1110
"AttestationLayerEcdsaKey": "",
12-
"TaskFetcher": {
13-
"OffsetFile": "config/operator_task_fetcher.offset",
14-
"Endpoint": "https://1rpc.io/eth",
15-
"Topics": [["0x2c32d4ae151744d0bf0b9464a3e897a1d17ed2f1af71f7c9a75f12ce0d28238f"]],
16-
"Addresses": [
17-
"0xa13baf47339d63b743e7da8741db5456dac1e556"
18-
]
19-
},
2011
"RegistryCoordinatorAddress": "0x62c715575cE3Ad7C5a43aA325b881c70564f2215",
21-
"TEELivenessVerifierAddress": "0x63AED86c0c6Df1e60E01AAF9bcD39ad5cD2e3344"
12+
"TEELivenessVerifierAddress": "0x2E8628F6000Ef85dea615af6Da4Fd6dF4fD149e6"
2213
}

holesky/docker-compose-env.sh

Lines changed: 0 additions & 11 deletions
This file was deleted.

holesky/docker-compose.yaml

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,19 @@
1-
version: '3'
1+
networks:
2+
multiprover-network:
3+
name: multiprover-avs-network
24

35
services:
46
operator:
5-
image: ghcr.io/automata-network/multi-prover-avs/operator:v0.1.3
7+
image: ghcr.io/automata-network/multi-prover-avs/operator:v0.2.0
68
container_name: multi-prover-operator
79
command: -c /config/operator.json
810
ports:
9-
- "15682:15682"
11+
- "15692:15692"
12+
expose:
13+
- 15682
1014
volumes:
1115
- ./config:/config
1216
- "${BLS_KEY_FILE_HOST}:${BLS_KEY_FILE_DOCKER}:readonly"
1317
working_dir: /
18+
networks:
19+
- multiprover-network

holesky/helper.sh

Lines changed: 0 additions & 51 deletions
This file was deleted.

holesky/run.sh

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,13 @@
11
#!/bin/bash -e
22

3-
. ./helper.sh
3+
. $(dirname $0)/../utils/helper.sh
4+
cd $(dirname $0)
5+
_init_run
46

57
cmd=$1
8+
if [[ "$cmd" == "" ]]; then
9+
_available_cmd $0
10+
fi
611
shift
712
ecdsa_key=$1
813
if [[ "$ecdsa_key" != "" ]]; then
@@ -11,21 +16,19 @@ fi
1116

1217
if [ "$cmd" = "opt-in" ]; then
1318
_require_ecdsa_key "$ecdsa_key"
14-
. ./docker-compose-env.sh
1519
_oprtool optin $ecdsa_key "$@"
1620
elif [ "$cmd" = "opt-out" ]; then
1721
_require_ecdsa_key "$ecdsa_key"
18-
. ./docker-compose-env.sh
1922
_oprtool optout $ecdsa_key "$@"
2023
elif [ "$cmd" = "deposit" ]; then
2124
_require_ecdsa_key "$ecdsa_key"
22-
. ./docker-compose-env.sh
2325
_oprtool deposit $ecdsa_key "$@"
2426
elif [ "$cmd" = "operator" ]; then
25-
. ./docker-compose-env.sh
27+
_operator_check
2628
docker compose up -d
2729
elif [ "$cmd" = "operator-log" ]; then
2830
docker compose logs
2931
else
30-
echo "Invalid command"
32+
echo "Invalid command"
33+
_available_cmd $0
3134
fi

mainnet/CHANGELOG.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Change Logs
2+
3+
>
4+
> 💡 Check the [README](./README.md) if you are looking for setup from scratch
5+
>
6+
7+
## Table of Contents <!-- omit in toc -->
8+
- [Introduction](#introduction)
9+
- [General Flow](#general-flow)
10+
- [Version Specific Changes](#version-specific-changes)
11+
- [Version 0.2.0](#version-020)
12+
13+
14+
## Introduction
15+
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.
16+
17+
## General Flow
18+
If you are running your operator using docker compose, you can upgrade with the following steps.
19+
20+
1. First pull the latest copy of this repo:
21+
22+
```bash
23+
cd mainnet
24+
25+
git pull
26+
```
27+
28+
2. Please check [the section below](#version-specific-changes) for the specific changes you need to make per version before rebooting your services.
29+
30+
3. Stop the the existing services:
31+
32+
```bash
33+
docker compose down
34+
```
35+
36+
4. Now, restart the service:
37+
```bash
38+
docker compose up -d
39+
```
40+
41+
42+
## Version Specific Changes
43+
44+
### Version 0.2.0
45+
TBD

0 commit comments

Comments
 (0)