Quickstart Guide

The Token-Price-Oracle codebase is fully open source and hosted on Github.

The Smart Contracts

Github Link: https://github.com/pajicf/token-price-oraclearrow-up-right

The project uses Hardhat v2.19.1arrow-up-right as the development environment, Solidity 0.8.19arrow-up-right as the Smart Contract language of choice and Typescript 4.5.0arrow-up-right as language for writing any accompanying tests or scripts.

For package management yarnarrow-up-right is used as it provides better performance and safer dependency resolving in comparsion to npm.

The project Structure

The project is structured in the next manner: contracts - Holds the Solidity Smart Contracts and interfaces for external use scripts - Holds any deployment or on-chain initialisation scripts written in Typescript tasks - Holds helper tasks for the cli to interact with the contracts test - Holds all the project related tests

The Orchestrator - Typescript client

Github Link: https://github.com/pajicf/token-price-oracle-orchestratorarrow-up-right

The project uses Node 18arrow-up-right as the development environment and Typescript 5.3.3arrow-up-right as the primary language. The server functionality is handled through the express.jsarrow-up-right framework and storage is cached in-memory using Redux.jsarrow-up-right.

Web3 interactions are handled using the ethers.jsarrow-up-right library.

For package management yarnarrow-up-right is used as it provides better performance and safer dependency resolving in comparsion to npm.

The Orchestrator - GoLang client

In the works...

Last updated