naym-coin

The NAYM ERC-20 token.

Features:

• Has an owner that can be changed (0x0 not allowed).
• Has changeable minter that is set by owner. Only the minter can mint new tokens.
• Anyone can burn their own tokens.

On-chain addresses

• Base Mainnet: 0x314d7f9e2f55B430ef656FBB98A7635D43a2261E

Developer guide

Install pre-requisites:

• Foundry
• Yarn

Then copy .env.example to .env:

$ cp .env.example .env

Then run:

$ yarn

To compile the contracts:

$ yarn build

To test:

$ yarn test

To run a local devnet:

$ yarn devnet

Test an upgrade against Base mainnnet

To test a contract upgrade against the current token code on Base mainnet:

1. In a separate terminal, clone the contracts-v3 repo and run make base-fork. This should start a local node forked from Base mainnet.
2. Back in this repo...
3. Run yarn deploy baseFork --upgrade-start
   • To run an upgrade initialization use: yarn deploy baseFork --upgrade-start --upgrade-init-contract <contract name> --upgrade-init-method <method name>
   • Note down the upgrade ID for use in the following command...
4. Run yarn approve-upgrade --id <upgrade ID> --contract 0x314d7f9e2f55B430ef656FBB98A7635D43a2261E
5. Run yarn deploy baseFork --upgrade-finish

License

GPLv3 - see LICENSE.md

Naym-Coin smart contracts Copyright (C) 2024 Nayms

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.