gh: Project Structure refactor (#12)

* move hh project to the repo root * updated the readme * update pr workflow * update .gitignore
pajicf · Dec 10, 2023 · 640d454 · 640d454
1 parent 8b3ab2d
commit 640d454
Show file tree

Hide file tree

Showing 50 changed files with 90 additions and 497 deletions.
diff --git a/contracts/.env.example → .env.example b/contracts/.env.example → .env.example
diff --git a/.env.test b/.env.test
@@ -0,0 +1,6 @@
+DEPLOYER_PRIVATE_KEY=0xabc123abc123abc123abc123abc123abc123abc123abc123abc123abc123abc1
+
+ETHEREUM_GOERLI_RPC=API
+ETHEREUM_SEPOLICA_RPC=API
+
+ETHERSCAN_API_KEY=API
diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml
@@ -69,5 +69,9 @@ jobs:
           path: node_modules
           key: node_modules-${{ hashFiles('**/yarn.lock') }}
 
+      - name: Create mock .env file
+        run: |
+          cp .env.test .env
+
       - name: All Tests pass
         run: yarn test
diff --git a/.gitignore b/.gitignore
@@ -6,11 +6,11 @@
 node_modules/
 
 # Hardhat / Solidity
-contracts/cache
-contracts/artifacts
-contracts/coverage
-contracts/coverage.json
-contracts/typechain
-contracts/typechain-types
-contracts/ignition/deployments/**/build-info
-contracts/ignition/deployments/**/artifacts/*.dbg.json
+/cache
+/artifacts
+/coverage
+/coverage.json
+/typechain
+/typechain-types
+/ignition/deployments/**/build-info
+/ignition/deployments/**/artifacts/*.dbg.json
diff --git a/contracts/.solhint.json → .solhint.json b/contracts/.solhint.json → .solhint.json
diff --git a/contracts/.solhintignore → .solhintignore b/contracts/.solhintignore → .solhintignore
diff --git a/README.md b/README.md
@@ -1,5 +1,56 @@
-# Token Price Oracle
-A simple oracle for tracking token prices on-chain and accompanying API
-for tracking & management of the data.
+![Token Price Oracle - SC - banner](./assets/banner.jpeg)
+# Token Price Oracle - Smart Contracts 📑
+The core Solidity contracts for the Token Price Oracle
 
-## Contributions
+## Requirements ✅
+To run the project, you'll need:
+- [Node.js](https://nodejs.org/en/) (Version 16 works)
+- [Yarn](https://yarnpkg.com/)
+
+## Running the project 🚀
+### 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
+
+#### Hardhat 👷‍♂️
+- Compile: ```yarn compile```
+- Tests: ```yarn test```
+
+#### Contracts CLI 🧑‍💻
+- Set a new price for a ticker: ```yarn contracts:set-ticker-price```
+- Set a new feed for a ticker: ```yarn contracts:set-ticker-feed```
+
+#### Miscellanious 🧹
+- Project linting: ```yarn lint```
+- Documentation generation: ```yarn docs:generate```
+
+## Documentation 📚
+All the Smart Contract documentation can be found inside the `/docs` folder:  
+ - [`docs/api`](https://github.com/pajicf/token-price-oracle/tree/main/docs/api) - Contains the API of the Smart Contracts generated from the natspec
+ - [`docs/diagrams`](https://github.com/pajicf/token-price-oracle/tree/main/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](https://hardhat.org/ignition/docs/getting-started#overview).  
+To deploy to the new network, you should:
+1. Add the network to the [`hardhat.config.ts`](https://github.com/pajicf/token-price-oracle/blob/main/contracts/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`](https://github.com/pajicf/token-price-oracle/tree/main/ignition/deployments) 
+
+### Block Explorer Links 🔎
+Ξ Ethereum Göerli:  
+`TickerUSDFeedRegistry`: [0xF3D020838782213d3da52daa079A9c07F0A8e67e](https://goerli.etherscan.io/address/0xF3D020838782213d3da52daa079A9c07F0A8e67e#code)  
+`TickerPriceStorage`: [0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121](https://goerli.etherscan.io/address/0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121#code)
+
+Ξ Ethereum Sepolia:  
+`TickerUSDFeedRegistry`: [0xF3D020838782213d3da52daa079A9c07F0A8e67e](https://sepolia.etherscan.io/address/0xF3D020838782213d3da52daa079A9c07F0A8e67e#code)  
+`TickerPriceStorage`: [0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121](https://sepolia.etherscan.io/address/0xa909e0bC9a35cC161dE9eA85cA76AB7A9b5b0121#code)
diff --git a/contracts/assets/banner.jpeg → assets/banner.jpeg b/contracts/assets/banner.jpeg → assets/banner.jpeg
diff --git a/contracts/README.md b/contracts/README.md
diff --git a/contracts/contracts/TickerPriceStorage.sol → contracts/TickerPriceStorage.sol b/contracts/contracts/TickerPriceStorage.sol → contracts/TickerPriceStorage.sol
diff --git a/...racts/contracts/TickerUSDFeedRegistry.sol → contracts/TickerUSDFeedRegistry.sol b/...racts/contracts/TickerUSDFeedRegistry.sol → contracts/TickerUSDFeedRegistry.sol
diff --git a/...cts/interfaces/IAggregatorV3Interface.sol → ...cts/interfaces/IAggregatorV3Interface.sol b/...cts/interfaces/IAggregatorV3Interface.sol → ...cts/interfaces/IAggregatorV3Interface.sol
diff --git a/...tracts/interfaces/ITickerPriceStorage.sol → contracts/interfaces/ITickerPriceStorage.sol b/...tracts/interfaces/ITickerPriceStorage.sol → contracts/interfaces/ITickerPriceStorage.sol
diff --git a/...cts/interfaces/ITickerUSDFeedRegistry.sol → ...cts/interfaces/ITickerUSDFeedRegistry.sol b/...cts/interfaces/ITickerUSDFeedRegistry.sol → ...cts/interfaces/ITickerUSDFeedRegistry.sol
diff --git a/...s/contracts/test/TestAggregatorV3Mock.sol → contracts/test/TestAggregatorV3Mock.sol b/...s/contracts/test/TestAggregatorV3Mock.sol → contracts/test/TestAggregatorV3Mock.sol
diff --git a/...contracts/test/TestTickerPriceStorage.sol → contracts/test/TestTickerPriceStorage.sol b/...contracts/test/TestTickerPriceStorage.sol → contracts/test/TestTickerPriceStorage.sol
diff --git a/contracts/docs/.templates/common.hbs → docs/.templates/common.hbs b/contracts/docs/.templates/common.hbs → docs/.templates/common.hbs
diff --git a/contracts/docs/.templates/event.hbs → docs/.templates/event.hbs b/contracts/docs/.templates/event.hbs → docs/.templates/event.hbs
diff --git a/contracts/docs/.templates/helpers.ts → docs/.templates/helpers.ts b/contracts/docs/.templates/helpers.ts → docs/.templates/helpers.ts
diff --git a/contracts/docs/api/TickerPriceStorage.md → docs/api/TickerPriceStorage.md b/contracts/docs/api/TickerPriceStorage.md → docs/api/TickerPriceStorage.md
diff --git a/contracts/docs/api/TickerUSDFeedRegistry.md → docs/api/TickerUSDFeedRegistry.md b/contracts/docs/api/TickerUSDFeedRegistry.md → docs/api/TickerUSDFeedRegistry.md
diff --git a/...ocs/api/interfaces/ITickerPriceStorage.md → docs/api/interfaces/ITickerPriceStorage.md b/...ocs/api/interfaces/ITickerPriceStorage.md → docs/api/interfaces/ITickerPriceStorage.md
diff --git a/.../api/interfaces/ITickerUSDFeedRegistry.md → .../api/interfaces/ITickerUSDFeedRegistry.md b/.../api/interfaces/ITickerUSDFeedRegistry.md → .../api/interfaces/ITickerUSDFeedRegistry.md
diff --git a/...racts/docs/diagrams/TickerPriceStorage.md → docs/diagrams/TickerPriceStorage.md b/...racts/docs/diagrams/TickerPriceStorage.md → docs/diagrams/TickerPriceStorage.md
diff --git a/...ts/docs/diagrams/TickerUSDFeedRegistry.md → docs/diagrams/TickerUSDFeedRegistry.md b/...ts/docs/diagrams/TickerUSDFeedRegistry.md → docs/diagrams/TickerUSDFeedRegistry.md
diff --git a/contracts/hardhat.config.ts → hardhat.config.ts b/contracts/hardhat.config.ts → hardhat.config.ts
diff --git a/...ickerPriceStorage#TickerPriceStorage.json → ...ickerPriceStorage#TickerPriceStorage.json b/...ickerPriceStorage#TickerPriceStorage.json → ...ickerPriceStorage#TickerPriceStorage.json
diff --git a/...SDFeedRegistry#TickerUSDFeedRegistry.json → ...SDFeedRegistry#TickerUSDFeedRegistry.json b/...SDFeedRegistry#TickerUSDFeedRegistry.json → ...SDFeedRegistry#TickerUSDFeedRegistry.json
diff --git a/...ts/chain-11155111/deployed_addresses.json → ...ts/chain-11155111/deployed_addresses.json b/...ts/chain-11155111/deployed_addresses.json → ...ts/chain-11155111/deployed_addresses.json
diff --git a/.../deployments/chain-11155111/journal.jsonl → .../deployments/chain-11155111/journal.jsonl b/.../deployments/chain-11155111/journal.jsonl → .../deployments/chain-11155111/journal.jsonl
diff --git a/...ickerPriceStorage#TickerPriceStorage.json → ...ickerPriceStorage#TickerPriceStorage.json b/...ickerPriceStorage#TickerPriceStorage.json → ...ickerPriceStorage#TickerPriceStorage.json
diff --git a/...SDFeedRegistry#TickerUSDFeedRegistry.json → ...SDFeedRegistry#TickerUSDFeedRegistry.json b/...SDFeedRegistry#TickerUSDFeedRegistry.json → ...SDFeedRegistry#TickerUSDFeedRegistry.json
diff --git a/...ployments/chain-5/deployed_addresses.json → ...ployments/chain-5/deployed_addresses.json b/...ployments/chain-5/deployed_addresses.json → ...ployments/chain-5/deployed_addresses.json
diff --git a/...gnition/deployments/chain-5/journal.jsonl → ignition/deployments/chain-5/journal.jsonl b/...gnition/deployments/chain-5/journal.jsonl → ignition/deployments/chain-5/journal.jsonl
diff --git a/...ts/ignition/modules/TickerPriceStorage.ts → ignition/modules/TickerPriceStorage.ts b/...ts/ignition/modules/TickerPriceStorage.ts → ignition/modules/TickerPriceStorage.ts
diff --git a/...ignition/modules/TickerUSDFeedRegistry.ts → ignition/modules/TickerUSDFeedRegistry.ts b/...ignition/modules/TickerUSDFeedRegistry.ts → ignition/modules/TickerUSDFeedRegistry.ts
diff --git a/contracts/package.json → package.json b/contracts/package.json → package.json
diff --git a/contracts/shared/config.ts → shared/config.ts b/contracts/shared/config.ts → shared/config.ts
diff --git a/contracts/shared/types.ts → shared/types.ts b/contracts/shared/types.ts → shared/types.ts
diff --git a/contracts/shared/util.ts → shared/util.ts b/contracts/shared/util.ts → shared/util.ts
diff --git a/contracts/tasks/index.ts → tasks/index.ts b/contracts/tasks/index.ts → tasks/index.ts
diff --git a/contracts/tasks/setTickerFeed.ts → tasks/setTickerFeed.ts b/contracts/tasks/setTickerFeed.ts → tasks/setTickerFeed.ts
diff --git a/contracts/tasks/setTickerPrice.ts → tasks/setTickerPrice.ts b/contracts/tasks/setTickerPrice.ts → tasks/setTickerPrice.ts
diff --git a/...st/fixtures/tickerPriceStorage.fixture.ts → test/fixtures/tickerPriceStorage.fixture.ts b/...st/fixtures/tickerPriceStorage.fixture.ts → test/fixtures/tickerPriceStorage.fixture.ts
diff --git a/...fixtures/tickerUSDFeedRegistry.fixture.ts → ...fixtures/tickerUSDFeedRegistry.fixture.ts b/...fixtures/tickerUSDFeedRegistry.fixture.ts → ...fixtures/tickerUSDFeedRegistry.fixture.ts
diff --git a/contracts/test/tickerPriceStorage.test.ts → test/tickerPriceStorage.test.ts b/contracts/test/tickerPriceStorage.test.ts → test/tickerPriceStorage.test.ts
diff --git a/contracts/test/tickerUSDFeedRegistry.test.ts → test/tickerUSDFeedRegistry.test.ts b/contracts/test/tickerUSDFeedRegistry.test.ts → test/tickerUSDFeedRegistry.test.ts
diff --git a/contracts/tsconfig.json → tsconfig.json b/contracts/tsconfig.json → tsconfig.json
diff --git a/contracts/tslint.json → tslint.json b/contracts/tslint.json → tslint.json