This repository demonstrates how to implement a simple price oracle AVS using the Othentic Stack.
The Simple Price Oracle AVS Example demonstrates how to deploy a minimal AVS using Othentic Stack.
- Containerised deployment: Simplifies deployment and scaling.
- Prometheus and Grafana integration: Enables real-time monitoring and observability.
📂 simple-price-oracle-avs-example
├── 📂 Execution_Service # Implements Task execution logic - Express JS Backend
│ ├── 📂 config/
│ │ └── app.config.js # An Express.js app setup with dotenv, and a task controller route for handling `/task` endpoints.
│ ├── 📂 src/
│ │ └── dal.service.js # A module that interacts with Pinata for IPFS uploads
│ │ ├── oracle.service.js # A utility module to fetch the current price of a cryptocurrency pair from the Binance API
│ │ ├── task.controller.js # An Express.js router handling a `/execute` POST endpoint
│ │ ├── 📂 utils # Defines two custom classes, CustomResponse and CustomError, for standardizing API responses
│ ├── Dockerfile # A Dockerfile that sets up a Node.js (22.6) environment, exposes port 8080, and runs the application via index.js
| ├── index.js # A Node.js server entry point that initializes the DAL service, loads the app configuration, and starts the server on the specified port
│ └── package.json # Node.js dependencies and scripts
│
├── 📂 Validation_Service # Implements task validation logic - Express JS Backend
│ ├── 📂 config/
│ │ └── app.config.js # An Express.js app setup with a task controller route for handling `/task` endpoints.
│ ├── 📂 src/
│ │ └── dal.service.js # A module that interacts with Pinata for IPFS uploads
│ │ ├── oracle.service.js # A utility module to fetch the current price of a cryptocurrency pair from the Binance API
│ │ ├── task.controller.js # An Express.js router handling a `/validate` POST endpoint
│ │ ├── validator.service.js # A validation module that checks if a task result from IPFS matches the ETH/USDT price within a 5% margin.
│ │ ├── 📂 utils # Defines two custom classes, CustomResponse and CustomError, for standardizing API responses.
│ ├── Dockerfile # A Dockerfile that sets up a Node.js (22.6) environment, exposes port 8080, and runs the application via index.js.
| ├── index.js # A Node.js server entry point that initializes the DAL service, loads the app configuration, and starts the server on the specified port.
│ └── package.json # Node.js dependencies and scripts
│
├── 📂 grafana # Grafana monitoring configuration
├── 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
└── prometheus.yaml # Prometheus configuration for logs
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.
- Store the result in IPFS.
- Share the IPFS CID as proof.
Validation Service logic:
- Retrieve the price from IPFS using the CID.
- Get the expected ETHUSDT price.
- Validate by comparing the actual and expected prices within an acceptable margin.
-
Clone the repository:
git clone https://github.com/Othentic-Labs/simple-price-oracle-avs-example.git cd simple-price-oracle-avs-example -
Install Othentic CLI:
npm i -g @othentic/othentic-cli
Follow the steps in the official documentation's Quickstart Guide for setup and deployment.
Modify the different configurations, tailor the task execution logic as per your use case, and run the AVS.
Happy Building! 🚀
