https://github.com/telosnetwork/erc20-template

https://github.com/telosnetwork/erc20-template

Last synced: 13 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/telosnetwork/erc20-template
• Owner: telosnetwork
• Created: 2022-06-01T19:45:02.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2023-09-20T18:17:57.000Z (about 1 year ago)
• Last Synced: 2024-08-02T15:07:02.374Z (4 months ago)
• Language: JavaScript
• Size: 90.8 KB
• Stars: 2
• Watchers: 4
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-telos - Telos Hardhat environment & ERC20 Starter

README

        
# ERC20 Template for Telos EVM Testnet Network

This template contains everything you need to deploy a basic Open Zeppelin ERC20 contract to the [Telos EVM](https://www.telos.net/evm) Testnet Network. Follow the steps below to deploy and interact with your own ERC20 token in minutes ! 

## REQUIREMENTS

This template requires [NodeJS & NPM](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed on your machine and a [wallet address on the Telos EVM Testnet Network](https://www.telos.net/developers/getting-started-on-testnet).

Commands used below work on recent Linux or Windows versions but have not been verified for Mac

## INSTALL

- Click the "use this template" button in [this repository](https://github.com/telosnetwork/erc20-template) and copy the **URL** you are redirected to once the generation is finished.

![Use this template](https://i.imgur.com/6TB0NaE.jpg)

- Change the following configuration values in the `.env` file of your newly created repository:

    - `ACCOUNT: MY_TESTNET_EVM_ADDRESS`  

    - `TOKEN_NAME: My Token`

    - `TOKEN_SYMBOL: MYTOK`

    - `TOKEN_INITIAL_SUPPLY: 10000`

- Install the repository on your machine with `git clone [PREVIOUSLY COPIED URL]` (GIT required) or download the code and install it manually

- Enter the directory of the project on your machine and install its dependencies by running `npm install`

## TEST (OPTIONAL)

- Use `npx hardhat test` to build and launch the tests

## DEPLOY

- Build & deploy using `npx hardhat --network testnet deploy`

- Save the contract address returned in the console, ie: `0xe7209d65c5BB05Ddf799b20fF0EC09E691FC3f11`, **you will need it for the next steps !**

- Interact with your contract using  the hardhat console, our [block explorer](https://testnet.teloscan.io), wallets like metamask or by deploying our [example wallet repo](https://github.com/telosnetwork/evm-ui-template-examples)

## VERIFY (OPTIONAL)

- Verify your new token contract with `npx hardhat --network testnet sourcify`

- You may run into a "gateway timeout" error message, do not worry, the contract will still be verified

- Make sure your contract is verified by running the command again, you should get this message back:

`already verified: MyContract (0x2A3b40A59109a84ab82a0Ff1A3910bb595082e09), skipping.`

## TROUBLESHOOT

### Verify: 504 Gateway Timeout

`"\r\n504 Gateway Time-out\r\n\r\n
504 Gateway Time-out
\r\n
nginx/1.14.2\r\n\r\n\r\n"`


The sourcify server connection timed out but your contract is still getting verified, run the `npx hardhat --network testnet sourcify` command again to make sure, it should tell you it is already verified !

**Brand new to development ? Need more help setting things up ? Got a cool idea you need help with ? [Visit our developer channel on Telegram](https://t.me/TelosEVMDevs) !**

## KEEP BUILDING !

- Make it ownable and use your own private key to deploy

- Add reflection

- Make it upgradeable

- Write more tests 

- Modify configuration and deploy to mainnet !

- ...