Simple Price Oracle AVS Rust Example

This repository demonstrates how to implement a simple price oracle AVS in Rust using the Othentic Stack.

---

Table of Contents

1. Overview
2. Project Structure
3. Architecture
4. Prerequisites
5. Installation
6. Usage

---

Overview

The Simple Price Oracle AVS Example demonstrates how to deploy a minimal AVS using Othentic Stack.

Features

• Containerised deployment: Simplifies deployment and scaling.

Project Structure

📂 simple-price-oracle-avs-rust-example
├── 📂 Execution_Service         # Implements Task execution logic - Backend
│   ├── main.rs                  # A Rust program to initialize services, set up a POST endpoint `/task/execute`
│   ├── 📂 handlers/
│   │   └── task.rs              # Handler for executing a task by processing a POST request.
│   ├── 📂 services/
│   │   └── dal_service.rs       # A service to call `sendTask` RPC call.
│   │   ├── oracle_service.rs    # A utility module to fetch the current price of a cryptocurrency pair from the Binance API
│   ├── Dockerfile               # Dockerfile for building and running a Rust app on port 8080.
│   └── Cargo.toml               # Defines the `Execution_Service` module and required dependencies.
│
├── 📂 Validation_Service        # Implements task validation logic - Backend
│   ├── main.rs                  # A Rust program to initialize services, set up a POST endpoint `/task/validate`
│   ├── 📂 handlers/
│   │   └── task.rs              # Handler for validating a task by processing a POST request.
│   ├── 📂 services/
│   │   ├── validation_service.rs # Task verification logic
│   │   ├── oracle_service.rs    # A utility module to fetch the current price of a cryptocurrency pair from the Binance API
│   ├── Dockerfile               # Dockerfile for building and running a Rust app on port 8080.
│   └── Cargo.toml               # Defines the `Validation_Service` module and required dependencies.
│
├── docker-compose.yml            # Docker setup for Operator Nodes (Performer, Attesters, Aggregator), Execution Service, Validation Service, and monitoring tools
├── .env.example                  # An example .env file containing configuration details and contract addresses
└── README.md                     # Project documentation

Architecture

The Performer node executes tasks using the Task Execution Service and sends the results to the p2p network.

Attester Nodes validate task execution through the Validation Service. Based on the Validation Service's response, attesters sign the tasks. In this AVS:

Task Execution logic:

• Fetch the ETHUSDT price.
• Share the price as proof.

Validation Service logic:

• Get the expected ETHUSDT price.
• Validate by comparing the actual and expected prices within an acceptable margin.

---

Prerequisites

• Rust (v 1.23 )
• Foundry
• Docker

Installation

1. Clone the repository:

   git clone https://github.com/Othentic-Labs/simple-price-oracle-avs-rust-example.git
   cd simple-price-oracle-avs-rust-example

2. Install Othentic CLI:

   npm i -g @othentic/cli
   npm i -g @othentic/node

Usage

Follow the steps in the official documentation's Quickstart Guide for setup and deployment.

If you already have all the information required to run the AVS, simply copy the .env file into your project directory and then run:

docker-compose up --build

Trigger task execution with following command

curl -X POST http://localhost:4003/task/execute -H "Content-Type: application/json" -d "{}"

Next

Modify the different configurations, tailor the task execution logic as per your use case, and run the AVS.

Happy Building! 🚀