INR Stablecoin using Chainlink Price Feeds

Algorithmic stablecoin for INR using chainlink price feed.

Table of contents

• Getting Started
• Prerequisites
• Installation
• Project structure

Built with

• Hardhat - Smart Contract Development Suite
• Solhint - Linting Suite
• Prettier - Automatic Code Formatting
• Solidity - Smart Contract Programming Language

---

Getting Started

Prerequisites

The repository is built using hardhat. So it is recommended to install hardhat globally through npm or yarn using the following commands. Also the development of these smart contracts are done in npm version 7.16.0 & NodeJs version 16.1.0

sudo npm i -g hardhat

Installation

Step by step instructions on setting up the project and running it

1. Clone the repository git clone https://github.com/ssomraaj/inr-stablecoin

2. Install Dependencies npm install

3. Compiling Smart Contracts (Auto compiles all .sol file inside contracts directory) npx hardhat compile

4. Deploying Smart Contracts npx hardhat run scripts/<contract-name>_deploy.js --network <network-name>

   Network name can be kovan for kovan testnet and testnet for BSC testnet. For adding other networks, please configure them in hardhat.config.js file in the root directory. Name of the smart contracts can be found inside the scripts folders in the root directory.

5. Verification of Smart Contracts npx hardhat verify <deployed-contract-address> --network <network-name>

   Network name can be kovan for kovan testnet and testnet for BSC testnet. For adding other networks, please configure them in hardhat.config.js file in the root directory. Name of the smart contracts to be verified can be found inside the arguments folders in the root directory.

Project structure

1. All contract codes, interfaces and utilites imported in the smart contracts can be found at /contracts

2. Every sub-directory or folder inside the /contracts folder will have interfaces.

3. The helper contracts can be found at /contract/utils

4. Security contracts can be found at /contract/security

5. Deployment scripts for deploying the smart contracts can be found at /scripts

   These are the codes that have to be created while deploying the smart contracts. Make sure the arguments are appropriate before deployment.

All configuration is done in hardhat.config.js & linting configurations are made in .solhint.json & .prettierrc. Configure the .env files before running the deploy and verification commands.

Not audited use at your own risk.

Testnet INRT Smart Contracts 0xaf8a419C1B85D76487596ca3240a0D53e6022ad7

Testnet Chainlink Oracle 0x2275bad4e366ee3ae0ba4daabe31c014ccd39bd9

Tesnet DAI token 0x9cd539ac8dca5757efac30cd32da20cd955e0f8b