BLO-131: Contracts & SDK v3

.github/workflows/publish.yaml

@@ -14,7 +14,7 @@ jobs:
       attestations: write # ! Required for GitHub Attestations, removing will create a Sev 0 incident !
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
@@ -39,7 +39,7 @@ jobs:
         run: echo "package.json version - ${{ steps.clean-tag.outputs.TAG }}"
 
       - name: Setup node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
           registry-url: https://registry.npmjs.org/

.github/workflows/test.yml

@@ -12,7 +12,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
       - name: Show Forge Version
@@ -27,11 +27,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version-file: ".nvmrc"
           cache: 'yarn'
       - name: Install dependencies
         run: yarn install --frozen-lockfile --network-concurrency 1
@@ -43,43 +43,27 @@ jobs:
         run: forge install
       - name: Run Tests
         run: yarn test
-  eslint:
-    name: Run eslint
-    continue-on-error: true
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Setup Node
-        uses: actions/setup-node@v3
-        with:
-          node-version: lts/*
-          cache: 'yarn'
-      - name: Install dependencies
-        run: yarn install --frozen-lockfile --network-concurrency 1
-      - name: Run eslint
-        run: yarn run eslint
   solhint:
     name: Run solhint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: lts/*
+          node-version-file: ".nvmrc"
           cache: 'yarn'
       - name: Install dependencies
         run: yarn install --frozen-lockfile --network-concurrency 1
       - name: Run solhint
-        run: yarn run solhint contracts/**/*.sol
+        run: yarn lint
   slither:
     name: Run slither
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Uninstall Debian package that slither needs to uninstall
         run: sudo apt remove python3-typing-extensions
       - name: Install Slither
@@ -92,14 +76,6 @@ jobs:
         run: forge --version
       - name: Run slither
         run: slither --compile-force-framework forge  --foundry-out-directory foundry-out .
-  readme:
-    name: Check README.md is contained in each contracts directory
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Code
-        uses: actions/checkout@v3
-      - name: Run check script
-        run: sh readmecheck.sh
   dependency-review:
     runs-on: ubuntu-latest
     steps:
@@ -119,9 +95,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version-file: ".nvmrc"
           registry-url: https://registry.npmjs.org/

.gitmodules

@@ -1,12 +1,6 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
-[submodule "lib/solidity-bits"]
-	path = lib/solidity-bits
-	url = https://github.com/estarriolvetch/solidity-bits
-[submodule "lib/solidity-bytes-utils"]
-	path = lib/solidity-bytes-utils
-	url = https://github.com/GNSPS/solidity-bytes-utils
 [submodule "lib/openzeppelin-contracts-4.9.3"]
 	path = lib/openzeppelin-contracts-4.9.3
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
@@ -33,6 +27,3 @@
 [submodule "lib/immutable-seaport-1.6.0+im4"]
 	path = lib/immutable-seaport-1.6.0+im4
 	url = https://github.com/immutable/seaport
-[submodule "lib/creator-token-standards"]
-	path = lib/creator-token-standards
-	url = https://github.com/limitbreakinc/creator-token-standards

.npmignore

@@ -1,3 +1,23 @@
+# Build and config files
 hardhat.config.ts
+tsconfig.json
+tsup.config.ts
+wagmi.config.ts
+foundry.toml
+foundry.lock
+remappings.txt
+slither.config.json
+
+# Development directories
 scripts
 test
+perfTest
+lib
+audits
+deploy
+abi
+
+# Documentation (available on GitHub)
+*.md
+!README.md
+!LICENSE.md

.nvmrc

@@ -1 +1 @@
-v18.17.1
+22.12.0

.solhint.json

@@ -1,6 +1,4 @@
 {
-  "plugins": ["prettier"],
-
   "rules": {
     "code-complexity": ["warn", 7],
     "custom-errors": "error",
@@ -48,9 +46,6 @@
     "not-rely-on-block-hash": "warn",
     "not-rely-on-time": "warn",
     "reentrancy": "warn",
-    "state-visibility": "warn",
-
-    "prettier/prettier": "error"
+    "state-visibility": "warn"
   }
 }
-

DEPS.md

@@ -5,9 +5,7 @@ This repo uses the Foundry tool chain to build and test Solidity code.
 The instructions below were used to install the dependencies.
 
 ```
-forge install https://github.com/estarriolvetch/solidity-bits --no-commit
-forge install https://github.com/GNSPS/solidity-bytes-utils --co-commit
-forge install https://github.com/axelarnetwork/axelar-gmp-sdk-solidity --co-commit
+forge install https://github.com/axelarnetwork/axelar-gmp-sdk-solidity --no-commit
 
 forge install openzeppelin-contracts-4.9.3=OpenZeppelin/openzeppelin-contracts@4.9.3 --no-commit
 forge install openzeppelin-contracts-upgradeable-4.9.3=OpenZeppelin/openzeppelin-contracts-upgradeable@4.9.3 --no-commit

README.md

@@ -18,8 +18,6 @@ Immutable Contracts is a library of smart contracts targeted at developers who w
 
 - Smart Contract Wallets
 
-- Random Number Generation
-
 These contracts are feature-rich and are the recommended standard on Immutable zkEVM intended for all users and partners within the ecosystem.
 
 ## Setup