Release v3.9.0

.env.example

@@ -1,9 +1,13 @@
-export LOCAL_RPC_URL=
+export ETHERSCAN_API_KEY=
+export BASESCAN_API_KEY=
+export BLOCKSCOUT_API_KEY=
 export ETH_MAINNET_RPC_URL=
 export ETH_SEPOLIA_RPC_URL=
-export BASE_GOERLI_RPC_URL=
-export ETH_GOERLI_RPC_URL=
-export ETHERSCAN_API_KEY=
+export ETH_LOCAL_RPC_URL=
+export BASE_SEPOLIA_RPC_URL=
+export BASE_MAINNET_RPC_URL=
+export AURORA_MAINNET_RPC_URL=
+export AURORA_TESTNET_RPC_URL=
 export NAYMS_SALT=
 export OWNER_ACCOUNT_KEY=
 export SYSTEM_ADMIN_1=

.github/workflows/lint.yml

@@ -5,6 +5,8 @@ on:
       - main
       - dev
   pull_request:
+    branches:
+      - dev
 
 jobs:
   run-linter:

.github/workflows/npm.yml

@@ -49,6 +49,8 @@ jobs:
           ETH_SEPOLIA_RPC_URL: ${{ secrets.ETH_SEPOLIA_RPC_URL }}
           BASE_MAINNET_RPC_URL: ${{ secrets.BASE_MAINNET_RPC_URL }}
           BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
+          AURORA_MAINNET_RPC_URL: ${{ secrets.AURORA_MAINNET_RPC_URL}}
+          AURORA_TESTNET_RPC_URL: ${{ secrets.AURORA_TESTNET_RPC_URL}}
 
       - name: Filter ABI
         run: make filter-abi

.github/workflows/test.yml

@@ -5,6 +5,8 @@ on:
       - main
       - dev
   pull_request:
+    branches:
+      - dev
 
 jobs:
   run-tests:
@@ -16,6 +18,14 @@ jobs:
       packages: read
       contents: read
       security-events: write
+    env:
+      SOLC_VERSION: 0.8.20
+      ETH_MAINNET_RPC_URL: ${{ secrets.ETH_MAINNET_RPC_URL }}
+      ETH_SEPOLIA_RPC_URL: ${{ secrets.ETH_SEPOLIA_RPC_URL }}
+      BASE_MAINNET_RPC_URL: ${{ secrets.BASE_MAINNET_RPC_URL }}
+      BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
+      AURORA_MAINNET_RPC_URL: ${{ secrets.AURORA_MAINNET_RPC_URL}}
+      AURORA_TESTNET_RPC_URL: ${{ secrets.AURORA_TESTNET_RPC_URL}}
     timeout-minutes: 15
     container:
       image: ghcr.io/nayms/contracts-builder:latest
@@ -30,7 +40,7 @@ jobs:
           cache: "yarn"
 
       - name: Install solc
-        run: svm install 0.7.6 && svm install 0.8.20 && svm use 0.8.20
+        run: svm install 0.7.6 && svm install ${SOLC_VERSION} && svm use ${SOLC_VERSION}
 
       - name: Fix ownership
         run: git config --global --add safe.directory /__w/contracts-v3/contracts-v3
@@ -41,42 +51,23 @@ jobs:
       - name: Install Node dependencies
         run: yarn
 
-      - name: Drop-in Test Wallet
-        run: echo "test test test test test test test test test test test junk" > ./nayms_mnemonic.txt && echo "test test test test test test test test test test test junk" > ./nayms_mnemonic_mainnet.txt
-
       - name: Build solidity contracts
         run: make build
-        env:
-          ETH_MAINNET_RPC_URL: ${{ secrets.ETH_MAINNET_RPC_URL }}
-          ETH_SEPOLIA_RPC_URL: ${{ secrets.ETH_SEPOLIA_RPC_URL }}
-          ETH_GOERLI_RPC_URL: ${{ secrets.ETH_GOERLI_RPC_URL }}
-          BASE_MAINNET_RPC_URL: ${{ secrets.BASE_MAINNET_RPC_URL }}
-          BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
 
       - name: Tests - local
         run: make test
-        env:
-          ETH_MAINNET_RPC_URL: ${{ secrets.ETH_MAINNET_RPC_URL }}
-          ETH_SEPOLIA_RPC_URL: ${{ secrets.ETH_SEPOLIA_RPC_URL }}
-          ETH_GOERLI_RPC_URL: ${{ secrets.ETH_GOERLI_RPC_URL }}
-          BASE_MAINNET_RPC_URL: ${{ secrets.BASE_MAINNET_RPC_URL }}
-          BASE_SEPOLIA_RPC_URL: ${{ secrets.BASE_SEPOLIA_RPC_URL }}
 
       - name: Coverage report
-        env:
-          ETH_MAINNET_RPC_URL: ${{ secrets.ETH_MAINNET_RPC_URL }}
         run: make coverage
 
       - name: Coveralls
-        uses: coverallsapp/github-action@master
+        uses: coverallsapp/github-action@v2
         with:
           github-token: ${{ secrets.GITHUB_TOKEN }}
           path-to-lcov: "./lcov-filtered.info"
 
       - name: Slither Static Analyser
         id: slither
-        env:
-          SOLC_VERSION: 0.8.20
         run: make slither
 
       - name: Upload Slither SARIF file

.gitignore

@@ -48,6 +48,7 @@ bin/
 .idea/runConfigurations.xml
 .idea/vcs.xml
 .metals
+.supermaven
 
 broadcast/**/31337/*
 
@@ -61,6 +62,7 @@ cov-html
 
 # Gemforge
 # gemforge.deployments.json
+.gemforge/*.json
 
 # Generated files
 script/deployment/S03UpgradeDiamond.s.sol

.gitmodules

@@ -6,7 +6,7 @@
 	url = https://github.com/brockelmore/forge-std
 [submodule "lib/solmate"]
 	path = lib/solmate
-	url = https://github.com/rari-capital/solmate
+	url = https://github.com/transmissions11/solmate
 [submodule "lib/solidity-lib"]
 	path = lib/solidity-lib
 	url = https://github.com/uniswap/solidity-lib
@@ -20,10 +20,9 @@
 	path = lib/oz
 	url = https://github.com/openzeppelin/openzeppelin-contracts
 	branch = merge/release-v5.0
-[submodule "lib/diamond-2-hardhat"]
-	path = lib/diamond-2-hardhat
-	url = https://github.com/gemstation/diamond-2-hardhat
-	branch = gemforge-2
 [submodule "lib/solady"]
 	path = lib/solady
 	url = https://github.com/Vectorized/solady
+[submodule "lib/diamond-2-hardhat"]
+	path = lib/diamond-2-hardhat
+	url = https://github.com/nayms/diamond-2-hardhat

.prettierrc

@@ -28,6 +28,12 @@
         "singleQuote": false,
         "bracketSpacing": true
       }
+    },
+    {
+      "files": "*.cjs",
+      "options": {
+        "printWidth": 180
+      }
     }
   ]
-}
+}

Makefile

@@ -36,7 +36,7 @@ bscript: ## build forge scripts
 	forge build --root . --contracts script/
 
 test: ## forge test local, alias t. Skip "one off" tests, For example a test created for a specific upgrade only. These tests are no longer relevant after the upgrade is complete.
-	forge test --no-match-test testReplaceDiamondCut
+	forge test --no-match-test testFork
 t: test
 
 tt: ## forge test local -vv
@@ -80,7 +80,7 @@ cov: ## coverage report -vvv
 	forge coverage -vvv
 
 coverage: ## coverage report (lcov), filtered for CI
-	forge coverage -vvv --report lcov --via-ir && node ./cli-tools/filter-lcov.js
+	forge coverage --no-match-test testFork -vvv --report lcov --via-ir && node ./cli-tools/filter-lcov.js
 
 lcov: ## coverage report (lcov)
 	forge coverage --report lcov --via-ir
@@ -94,9 +94,13 @@ gencovf: ## generate filtered html coverage report
 # solidity scripts
 erc20: ## deploy test ERC20
 	forge script DeployERC20 \
-		-s "deploy(string memory _name, string memory _symbol, uint8 _decimals)" \
-		${ERC20_NAME} ${ERC20_SYMBOL} ${ERC20_DECIMALS} \
-		-vvvv
+		-s "deploy(string memory _name, string memory _symbol, uint8 _decimals)" "Ether" "ETH" 18 \
+		-f ${AURORA_TESTNET_RPC_URL} \
+        --chain-id 1313161555 \
+        --sender 0x931c3aC09202650148Edb2316e97815f904CF4fa \
+        --mnemonic-paths ./nayms_mnemonic.txt \
+        --mnemonic-indexes 19 \
+		-vvvv --broadcast --legacy --verify --delay 30 --retries 10
 
 erc20-mainnet: ## deploy mock ERC20
 	forge script DeployERC20 \
@@ -124,20 +128,8 @@ erc20-mainnet-sim: ## simulate deploy mock ERC20
 		--ffi \
 		; node cli-tools/postproc-broadcasts.js
 
-erc20g: ## deploy test ERC20 to Goerli
-	@forge script DeployERC20 -s "deploy(string memory _name, string memory _symbol, uint8 _decimals)" \
-		${ERC20_NAME} ${ERC20_SYMBOL} ${ERC20_DECIMALS} \
-		-f ${ETH_GOERLI_RPC_URL} \
-		--etherscan-api-key ${ETHERSCAN_API_KEY} \
-		--sender ${ownerAddress} \
-		--mnemonic-paths ./nayms_mnemonic.txt \
-		--mnemonic-indexes 19 \
-		--broadcast \
-		--verify \
-		-vvvv
-
 anvil:	## run anvil with shared wallet
-	anvil --host 0.0.0.0 --chain-id 31337 --accounts 20 -m ./nayms_mnemonic.txt --state anvil.json
+	anvil --host 0.0.0.0 --chain-id 31337 --accounts 20 -m "${shell cat ./nayms_mnemonic.txt}" --state anvil.json
 
 anvil-docker:	## run anvil in a container
 	docker run --platform linux/amd64 -d \
@@ -148,7 +140,7 @@ anvil-docker:	## run anvil in a container
 		-c "cd nayms && make anvil"
 
 anvil-dbg:	## run anvil in debug mode with shared wallet
-	RUST_LOG=backend,api,node,rpc=warn anvil --host 0.0.0.0 --chain-id 31337 -m ./nayms_mnemonic.txt  --state anvil.json
+	RUST_LOG=backend,api,node,rpc=warn anvil --host 0.0.0.0 --chain-id 31337 -m "${shell cat ./nayms_mnemonic.txt}" --state anvil.json
 
 fork-mainnet: ## fork mainnet locally with anvil
 	anvil -f ${ETH_MAINNET_RPC_URL} --accounts 20 -m "${shell cat ./nayms_mnemonic.txt}"
@@ -168,7 +160,9 @@ fork-aurora: ## fork aurora locally with anvil
 fork-aurora-testnet: ## fork aurora testnet locally with anvil
 	anvil -f ${AURORA_TESTNET_RPC_URL} --accounts 20 -m "${shell cat ./nayms_mnemonic.txt}"
 
-
+otterscan: ## run otterscan locally. otterscan is a local block explorer
+	docker run --rm -p 5100:80 --name otterscan -d otterscan/otterscan:latest
+
 anvil-gtoken:	## deploy dummy erc20 token to local node
 	forge script DeployERC20 \
 		-s "deploy(string memory, string memory, uint8)" "GToken" "GTK" 18 \
@@ -301,4 +295,4 @@ tu: ## Toggle upgrading the diamond in the forked tests. true == upgrade, false
 filter-abi:
 	@jq '[.[] | select(.name !="facets")]' src/generated/abi.json | \
     jq '[.[] | select(.name !="calculateUpgradeId")]' | \
-    jq '[.[] | select(.name !="diamondCut")]' > src/generated/naymsDiamond.json
+    jq '[.[] | select(.name !="diamondCut")]' > src/generated/naymsDiamond.json

README.md

@@ -5,21 +5,33 @@
 
 This repository contains Nayms V3 smart contracts.
 
-This is a [Foundry](https://book.getfoundry.sh/) based project, so make sure you have it installed.
+## Contract Deployments
+
+| Network | Address |
+| --- | --- |
+| Ethereum | `0x39e2f550fef9ee15b459d16bD4B243b04b1f60e5` |
+| Base | `0x546Fb1621CF8C0e8e3ED8E3508b7c5100ADdBc03` |
+
 
 ### Set up your project configuration
 
+This is a [Foundry](https://book.getfoundry.sh/) based project, so make sure you have it installed.
+
 Check `.env.example` to see some of the environment variables you should have set in `.env` in order to run some of the commands.
 
 Create a `.env` and ensure it contains:
 
 ```
-LOCAL_RPC_URL=
-ETH_MAINNET_RPC_URL=
-ETH_SEPOLIA_RPC_URL=
-BASE_MAINNET_RPC_URL=
-BASE_SEPOLIA_RPC_URL=
-ETHERSCAN_API_KEY=
+ETHERSCAN_API_KEY=...
+BASESCAN_API_KEY=...
+BLOCKSCOUT_API_KEY=...
+ETH_MAINNET_RPC_URL=...
+ETH_SEPOLIA_RPC_URL=...
+ETH_LOCAL_RPC_URL=...
+BASE_SEPOLIA_RPC_URL=...
+BASE_MAINNET_RPC_URL=...
+AURORA_MAINNET_RPC_URL=...
+AURORA_TESTNET_RPC_URL=...
 ```
 
 Create a `nayms_mnemonic.txt` file and ensure it contains the team mnemonic.
@@ -48,12 +60,17 @@ Currently supported deployment targets are:
 - `local`: Local Anvil Node
 - `sepolia`: Sepolia
 - `sepoliaFork`: a local fork of Sepolia
-- `mainnet`: Mainnet
-- `mainnetFork`: a local for of Mainnet
-- `base`: Base
-- `baseFork`: Base Sepolia testnet
-- `baseSepolia`: Base Sepolia testnet
-- `baseSepoliaFork`: Base Sepolia testnet
+- `mainnet`: Ethereum Mainnet
+- `mainnetFork`: a local for of Ethereum Mainnet
+- `base`: Base Mainnet
+- `baseFork`: a local fork of Base Mainnet
+- `baseSepolia`: Base Sepolia
+- `baseSepoliaFork`: a local fork of Base Sepolia
+- `aurora`: Aurora Mainnet (NEAR)
+- `auroraFork`: a local fork of Aurora Mainnet (NEAR)
+- `auroraTestnet`: Aurora Testnet (NEAR)
+- `auroraTestnetFork`: a local fork of Aurora Testnet (NEAR)
+
 
 #### Querying
 
@@ -98,8 +115,10 @@ Following commands are provided for working with `anvil`, to make it more conven
 | `make anvil-add-supported-external-token` | Add `GToken` as supported external token |
 | `make fork-sepolia`| Fork `Sepolia` test net locally |
 | `make fork-base-sepolia`| Fork `Base Sepolia` test net locally |
-| `make fork-mainnet`| Fork `Mainnet` locally |
-| `make fork-base`| Fork `Base` locally |
+| `make fork-mainnet`| Fork `Ethereum Mainnet` locally |
+| `make fork-base`| Fork `Base Mainnet` locally |
+| `make fork-aurora`| Fork `Aurora Mainnet` locally |
+| `make fork-aurora-testnet`| Fork `Aurora Testnet` locally |
 
 > :warning: Anvil state is kept in `anvil.json` file 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.