Merge branch 'main' into release-v1

Author: heueristik

.github/workflows/ci.yml

@@ -2,13 +2,13 @@ name: CI
 
 on:
   push:
-  pull_request:
   workflow_dispatch:
 
 jobs:
   foundry:
     env:
       FOUNDRY_PROFILE: ci
+      NODE_OPTIONS: "--disable-warning=ExperimentalWarning"
 
     strategy:
       fail-fast: true
@@ -46,11 +46,8 @@ jobs:
       - name: Show Bun version
         run: bun --version
 
-      - name: Install Solhint
-        run: bun install solhint
-
-      - name: Show Solhint version
-        run: bunx --bun solhint --version
+      - name: Install Test-Tooling
+        run: bun install
 
       - name: Run Solhint in `src` dir
         run: bunx --bun solhint --config .solhint.json 'src/**/*.sol'
@@ -64,6 +61,10 @@ jobs:
         run: bunx --bun solhint --config .solhint.other.json 'script/**/*.sol'
         id: solhint-script
 
+      - name: Run Forge clean
+        run: forge clean
+        id: clean
+
       - name: Run Forge build
         run: forge build --sizes --ast
         id: build
@@ -72,26 +73,6 @@ jobs:
         run: forge test -vvv --gas-report
         id: test
 
-  juvix:
-    strategy:
-      fail-fast: true
-
-    name: Juvix project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-
-      - name: Download latest nightly Juvix binary
-        uses: jaxxstorm/[email protected]
-        with:
-          repo: anoma/juvix-nightly-builds
-          tag: nightly-2025-02-13-0.6.9-8b06157
-          cache: enable
-
-      - name: Run Juvix typecheck
-        run: juvix dependencies update
-        working-directory: ./juvix
-
-      - name: Run Juvix typecheck
-        run: juvix typecheck
-        working-directory: ./juvix
+      - name: Run Forge coverage
+        run: forge coverage --ir-minimum
+        id: coverage

.gitignore

@@ -7,8 +7,14 @@ out/
 /broadcast/*/31337/
 /broadcast/**/dry-run/
 
+# Node modules
+node_modules/
+
 # Docs
 docs/
 
 # Dotenv file
 .env
+
+# Coverage report
+lcov.info

.gitmodules

@@ -4,7 +4,6 @@
 [submodule "lib/openzeppelin-contracts-upgradeable"]
 	path = lib/openzeppelin-contracts-upgradeable
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
-	branch = v5.3.0
 [submodule "lib/openzeppelin-foundry-upgrades"]
 	path = lib/openzeppelin-foundry-upgrades
 	url = https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades

.solhint.json

@@ -34,13 +34,14 @@
 
     "imports-on-top": "warn",
     "imports-order": "warn",
+    "import-path-check": "off",
     "ordering": "warn",
     "visibility-modifier-order": "error",
     "constructor-syntax": "error",
     "gas-calldata-parameters": "warn",
     "gas-custom-errors": "warn",
     "gas-increment-by-one": "warn",
-    "gas-indexed-events": "warn",
+    "gas-indexed-events": "off",
     "gas-length-in-loops": "warn",
     "gas-multitoken1155": "warn",
     "gas-named-return-values": "warn",

.solhint.other.json

@@ -27,16 +27,17 @@
 
     "imports-on-top": "warn",
     "imports-order": "warn",
+    "import-path-check": "off",
     "ordering": "warn",
     "visibility-modifier-order": "error",
     "constructor-syntax": "error",
     "gas-calldata-parameters": "warn",
-    "gas-custom-errors": "warn",
+    "gas-custom-errors": "off",
     "gas-increment-by-one": "warn",
     "gas-indexed-events": "warn",
     "gas-multitoken1155": "warn",
     "gas-named-return-values": "warn",
-    "gas-small-strings": "warn",
+    "gas-small-strings": "off",
     "gas-struct-packing": "warn",
 
     "quotes": "error",
@@ -48,13 +49,13 @@
     "avoid-tx-origin": "error",
     "check-send-result": "error",
     "compiler-version": ["error", "^0.8.24"],
-    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "func-visibility": ["error", {"ignoreConstructors": true}],
 
     "multiple-sends": "error",
     "no-complex-fallback": "error",
     "no-inline-assembly": "error",
     "not-rely-on-block-hash": "error",
-    "not-rely-on-time": "error",
+    "not-rely-on-time": "off",
     "reentrancy": "error",
     "state-visibility": "error"
   }

.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+  "[solidity]": {
+    "editor.formatOnSave": true
+  },
+  "[toml]": {
+    "editor.defaultFormatter": "tamasfe.even-better-toml"
+  },
+  "solidity.formatter": "forge"
+}

README.md

@@ -1,9 +1,5 @@
 # Token
 
-> [!WARNING]  
-> This repo features a prototype and is work in progress. Do NOT use in
-> production.
-
 ## Installation
 
 1. Get an up-to-date version of [Foundry](https://github.com/foundry-rs/foundry)
@@ -26,34 +22,25 @@
 Run
 
 ```sh
-forge test
+forge test --force --gas-report
 ```
 
-### Deployment
+> [!NOTE]  
+> The `--force` flag is required for the [openzeppelin-foundry-upgrades](https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades) package to work.
+> The `--gas-report` flag prints selected gas reports.
+
+### Coverage
 
-To simulate deployment on sepolia, run
+Run
 
 ```sh
-forge script script/Deploy.s.sol:Deploy \
-   --rpc-url sepolia
+forge coverage
 ```
 
-Append the
-
-- `--broadcast` flag to deploy on sepolia
-- `--verify` flag for subsequent contract verification on Etherscan
-- `--account <ACCOUNT_NAME>` flag to use a previously imported keystore (see
-  `cast wallet --help` for more info)
+### Documentation
 
-#### Block Explorer Verification
-
-For post-deployment verification on Etherscan run
+Run
 
 ```sh
-forge verify-contract \
-   <ADDRESS> \
-   src/MerkleDistributor.sol:MerkleDistributor \
-   --chain sepolia
+forge doc
 ```
-
-after replacing `<ADDRESS>` with the respective contract address.