Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Othentic-Labs/simple-price-oracle-avs-example
Boilerplate for AVS development
https://github.com/Othentic-Labs/simple-price-oracle-avs-example
Last synced: about 1 month ago
JSON representation
Boilerplate for AVS development
- Host: GitHub
- URL: https://github.com/Othentic-Labs/simple-price-oracle-avs-example
- Owner: Othentic-Labs
- Created: 2024-02-14T15:23:55.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-03T14:27:11.000Z (about 2 months ago)
- Last Synced: 2024-12-03T15:33:32.892Z (about 2 months ago)
- Language: JavaScript
- Homepage:
- Size: 4.35 MB
- Stars: 4
- Watchers: 33
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-avs - Simple Price Oracle AVS
README
# 🍀 Othentic AVS Samples
# ⚙️ Set Up
To set up the environment, create a `.env` file with the usual Othentic
configurations (see the `.env.example`).
# ✈️ Install the Othentic CLI
Installing Othentic CLI with `npm`:
```console
npm i -g @othentic/othentic-cli
```
Verify installation by the command:
```console
othentic-cli -h
```
# 🧰 Prerequisites
You need to register 3 self-deploy Operators with a minimum of 0.01 stETH.
* Deployer account:
* A minimum of 1.5 holETH (Faucet)
* A minimum of 5 Amoy MATIC (Faucet)
* Operator account x 3 (Script):
* A minimum of 0.02 holETH on Holesky
* ERC-20 token address
# 📑 Contracts Deployment
To deploy the AVS’s on-chain components, run the following command:
``` console
othentic-cli network deploy \\
--erc20 0x73967c6a0904aA032C103b4104747E88c566B1A2 \\
--l1-initial-deposit 1000000000000000000 \\
--l2-initial-deposit 2000000000000000000 \\
--name test-avs-name
```
# 🏋️♂️ Operators Setup
Register as an operator for both EigenLayer and the AVS
``` console
othentic-cli operator register
```
# 🔁 Convert ETH into stETH [Optional]
This command converts 0.012 ETH into stETH before depositing it into EigenLayer pool:
``` console
othentic-cli operator deposit --strategy stETH --shares 0.01 --convert 0.012
```
Activate your Operator by depositing into EigenLayer
Deposit 0.01 stETH into EigenLayer pool.
``` console
othentic-cli operator deposit --strategy stETH --shares 0.01
```
✅ Your internal Operators are now ready to opt-in to your AVS.
## ▶️ Run the demo
We provide a sample docker-compose configuration which sets up the following
services:
- Aggregator node
- 3 Attester nodes
- Validation Service endpoint
- Execution Service endpoint
- Sync Shares of operators across layers
run:
```console
docker-compose up --build
```
> [!NOTE]
> This might take a few minutes when building the images
# 🚀 Executing a task
To execute a task we send a
POST request to the Task Performer service:
``` console
curl -X POST
```
✅ Your demo AVS is functional!
### Updating the Othentic node version
To update the `othentic-cli` inside the docker images to the latest version, you
need to rebuild the images using the following command:
```console
docker-compose build --no-cache
```
## 🏗️ Architecture
The Othentic Attester nodes communicate with an AVS WebAPI endpoint which
validates tasks on behalf of the nodes. The attesters then sign the tasks based
on the AVS WebAPI response.
Attester nodes can either all communicate with a centralized endpoint or each
implement their own validation logic.
### AVS WebAPI
```
POST task/validate returns (bool) {"proofOfTask": "{proofOfTask}"};
```
### Sync Shares
sync the shares of operators between L1 and L2 at a fixed interval. The default interval is 12h and can be modified inside the docker-compose file