https://github.com/miohtama/hugs-token

Hugs Token
https://github.com/miohtama/hugs-token

Last synced: 11 days ago
JSON representation

Hugs Token

• Host: GitHub
• URL: https://github.com/miohtama/hugs-token
• Owner: miohtama
• Created: 2023-05-03T06:22:56.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-05-03T18:46:05.000Z (over 1 year ago)
• Last Synced: 2024-11-11T12:45:36.410Z (2 months ago)
• Language: Solidity
• Size: 219 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Hugs ERC-20 token

- Hugs token is OpenZeppelin v4.7.3 baed ERC-20 token

- The token is burnable

- The token and OpenZeppelin base ERC-20 contracts have been modified to allow metadata updates (name, symbol) 

# Deploy

The deployment is done using Alchemy API service and Etherscan.

Create deployment key with Python and web3:

```shell

python -c "from web3 import Web3; w3 = Web3(); acc = w3.eth.account.create(); print(f'private key={w3.to_hex(acc._private_key)}, account={acc.address}')"

```

Set up your environment:

```shell

export PRIVATE_KEY=0x....

export ALCHEMY_API_KEY=...

export ETHERSCAN_API_KEY=...

```

## Mumbai testnet

Deploy to Mumbai using Hardhat:

```

npx hardhat compile

npx hardhat run scripts/deploy.js --network mumbai

```

Verify the deployment:

```shell

DEPLOYED_CONTRACT_ADDRESS=0x549b63daf6A23267b813F704aEDdDc61302E6729

npx hardhat verify --network mumbai --contract contracts/HugsToken.sol:HugsToken  $DEPLOYED_CONTRACT_ADDRESS

```

## Polygon mainnet

Deploy to Ethereum mainnet using Hardhat:

```

# Use mainnet API key

export ALCHEMY_API_KEY=...

npx hardhat compile

npx hardhat run scripts/deploy.js --network polygon

```

Verify the deployment:

```shell

DEPLOYED_CONTRACT_ADDRESS=0x549b63daf6A23267b813F704aEDdDc61302E6729

npx hardhat verify --network polygon --contract contracts/HugsToken.sol:HugsToken  $DEPLOYED_CONTRACT_ADDRESS

```

# Deliver tokens

Deliver the full token amount to an address.

[See transfer script example](https://web3-ethereum-defi.readthedocs.io/tutorials/transfer.html).

```shell

export JSON_RPC_URL=https://polygon-mainnet.g.alchemy.com/v2/

export PRIVATE_KEY=...

python deliver.py

```

# Tests

To run tests:

```shell

export PRIVATE_KEY=0x`openssl rand -hex 32`

npx hardhat test

```