Token Price Oracle - Smart Contracts 📑

Token Price Oracle is a simple on-chain Oracle that can be consumed by other smart contracts for current prices of various tickers.

The contracts are:

• Trustless - Anyone can update the price ✅
• Immutable - The contracts are set in stone 🪨

Since the contracts are trustless, they are also kept in check by the Chainlink oracle behind the scenes to ensure the most correct values.

This repository contains the core Solidity smart contracts.

Documentation 📚

All the Smart Contract documentation can be found inside the /docs folder:

• docs/api - Contains the API of the Smart Contracts generated from the natspec
• docs/diagrams - Contains the Diagrams of common SC interactions

Deployments 🌐

How to Deploy on a new network? 📜

The Deployment is done decoratively using Hardhat Ignition.
To deploy to the new network, you should:

1. Add the network to the hardhat.config.ts file
2. Run yarn hardhat ignition deploy /ignition/modules/TickerPriceStorage.ts --network yournewnetwok --verify

Important

Ensure that the network you're deploying supports Etherscan for verification to be successfull

Bytecode 💼

All the deployment and build artifacts are located inside ignition/deplotments

Block Explorer Links 🔎

Ξ Ethereum Göerli:
TickerUSDFeedRegistry: 0xF3D020838782213d3da52daa079A9c07F0A8e67e
TickerPriceStorage: 0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121

Ξ Ethereum Sepolia:
TickerUSDFeedRegistry: 0xF3D020838782213d3da52daa079A9c07F0A8e67e
TickerPriceStorage: 0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121

Running the project 🚀

Requirements ✅

To run the project, you'll need:

• Node.js (Version 18)
• Yarn

Installation ⚙️

Git

1. Clone the repo: git clone https://github.com/pajicf/token-price-oracle.git
2. Navigate to the folder: cd token-price-oracle

Installing the dependencies

3. Run yarn to install the dependencies
4. Run cp .env.example .env and fill the values

Commands 🧑‍💻

Name	Command	Description
Compile	yarn compile	Compiles the project smart contracts
Tests	yarn test	Tests the project code using the Hardhat framework
Linting	yarn lint	Lints the project using solhint and tslint
Documentation Generator	yarn docs:generate	Generates the API docs for all the smart contracts
New ticker feed	yarn contracts:set-ticker-feed	Sets the new feed address for the given ticker
New ticker price	yarn contracts:set-ticker-price	Sets the new price for the given ticker