shariqanwar20/ERC20

ERC-20 Smart Contract with a;ll functions implemented based on EIP-20 standard. All unit tests are written to make the contract more robust

ERC-20 Contract

Manual Token (MT), ERC-20 token with all functions implemented based on EIP-20 standard along with unit tests written in mocha.

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

About The Project

Manual Token(MT), an ERC-20 contract developed using hardhat environment with properly written unit tests that have a coverage of more than 80%. Mocha/Chai has been used to write tests. This involves a deploy script which can be easily used to deploy to different testsnes and mainnet with just a change in hardhat config file.

(back to top)

Built With

• 
• 
• 

(back to top)

Getting Started

Follow the below steps to get started with this project

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   git clone https://github.com/github_username/repo_name.git

2. Install NPM packages

   npm install

3. Enter your API in .env

    RINKEBY_RPC_URL='RINKEBY_RPC_URL'
    PRIVATE_KEY='YOUR PRIVATE KEY'
    ETHERSCAN_API_KEY='ETHER SCAN API KEY'
    COINMARKETCAP_API_KEY='COINMARKET API KEY'

(back to top)

Usage

Run tests in hardhat environment

npm run hardhat test --network hardhat|rinkeby|localhost

Deploy the contract to testnet or mainnet

npm run hardhat deploy --network rinkeby|mainnet

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Shariq Anwar - @twitter_handle - shariqanwar59@gmail.com

Project Link: https://github.com/shariqanwar20/ERC20

(back to top)