This repository contains Nayms V3 smart contracts.
This is a Foundry based project, so make sure you have it installed.
.env.example to see some of the environment variables you should have set in
.env in order to run some of the commands.
.env and ensure it contains:
nayms_mnemonic.txt file and ensure it contains the team mnemonic.
This will generate the diamond proxy interface, diamond helper library and the abi file.
A script -
script/gemforge/deploy.js - is provided as a convenience for handling the Nayms phased deployments flow. You can call this directly or just use
yarn deploy ...
Currently supported deployment targets are:
local: Local Anvil Node
baseGoerli: Base Goerli testnet
sepoliaFork: a local fork of Sepolia
mainnetFork: a local for of Mainnet
To see how the current deployed Diamond differs from the compiled code for a target:
yarn query <target>
To do a fresh deployment to a given target:
yarn deploy <target> --fresh
To upgrade a deployment on a target:
yarn deploy <target> --upgrade-start
yarn deploy <target> --upgrade-finish
Note: For mainnet you will need to enable the upgrade using the MPC wallet. For non-mainnet targets the script will automatically do this for you.
For development purposes, you can run a node locally using foundry's
anvil. It's a simple way to bring up a local node exposing a JSON-RPC endpoint at
http://127.0.0.1:8545. Make sure to start
anvil in one of your terminal windows and in another one run a make target to deploy the Nayms' contracts to it.
Following commands are provided for working with
anvil, to make it more convenient:
|Run the local node seeding it with Nayms' shared wallet
|Run Anvil in debug mode to get verbose log output
|Do a full deployment of Nayms' contracts to local node
|Upgrade deployment of Nayms' contracts on local node
GToken to local node
GToken as supported external token
Sepolia test net locally
⚠️Anvil state is kept in
anvil.jsonfile in project root, except for forks. If this file is not present, node starts fresh and creates this file. In which case you need to do the deployment and setup.
One of the things you will need, to do proper testing with local node, is to deploy an ERC-20 compatible token along with Nayms contracts and make that token a supported external token. Below is an example of how to do that.
When working with local node, there are a few things you might need to do in preparation to be able to actually use it with client applications. As a convenience, a script is provided automating the following tasks.
- Deploy the diamond to local node
- Deploy test ERC20 compatible token (
GTOKEN) to local node
- Make this token a supported external token
- Mint some tokens to
Run it from project root folder against fresh new local node instance, otherwise some steps might fail:
In case you run into an issue of
forge not being able to find a compatible version of solidity compiler for one of your contracts/scripts, you may want to install the solidity version manager
svm. To be able to do so, you will need to have Rust installed on your system and with it the accompanying package manager
cargo. Once that is done, to install
svm run the following command:
cargo install svm-rs
To list the available versions of solidity compiler run:
Make sure the version you need is in this list, or choose the closest one and install it:
svm install "0.8.20"
Convenience targets are provided in the Makefile for running a specific test against a forked network.
To run a test against a Goerli fork use the following command passing in the test matching expression i.e.
make test-goerli MT=testStartTokenSale
Similarly a Mainnet fork test can be executed via:
make test-mainnet MT=testStartTokenSale
Run integration tests with mainnet forking.
Ensure "initialization" of entire system.
Use deterministic deployment.
Monitor all events, Nayms Diamond transactions, mempool.
Ramesh Nair @hiddentao