refactor: maintenance (bump deps, polish CI, use new Solhint)

.github/workflows/multibuild.yml → .github/workflows/ci-multibuild.yml

@@ -1,4 +1,4 @@
-name: "Multibuild"
+name: "CI Multibuild"
 
 on:
   workflow_dispatch:
@@ -13,7 +13,7 @@ jobs:
         uses: "actions/checkout@v4"
 
       - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
+        uses: "oven-sh/setup-bun@v2"
 
       - name: "Install the Node.js dependencies"
         run: "bun install"
@@ -22,5 +22,5 @@ jobs:
         uses: "PaulRBerg/foundry-multibuild@v1"
         with:
           min: "0.8.19"
-          max: "0.8.26"
+          max: "0.8.30"
           skip-test: "true"

.github/workflows/ci.yml

@@ -16,7 +16,7 @@ on:
       - "staging"
 
 jobs:
-  lint:
+  check:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
@@ -26,17 +26,17 @@ jobs:
         uses: "foundry-rs/foundry-toolchain@v1"
 
       - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
+        uses: "oven-sh/setup-bun@v2"
 
       - name: "Install the Node.js dependencies"
         run: "bun install"
 
-      - name: "Lint the code"
-        run: "bun run lint"
+      - name: "Run the full checks"
+        run: "bun run full-check"
 
-      - name: "Add lint summary"
-        run: |
-          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+      - name: "Add check summary"
+        run: | # shell
+          echo "## Check result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
   build:
@@ -46,7 +46,7 @@ jobs:
         uses: "actions/checkout@v4"
 
       - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
+        uses: "oven-sh/setup-bun@v2"
 
       - name: "Install the Node.js dependencies"
         run: "bun install"
@@ -58,12 +58,12 @@ jobs:
         run: "forge build"
 
       - name: "Add build summary"
-        run: |
+        run: | # shell
           echo "## Build result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
   test:
-    needs: ["lint", "build"]
+    needs: ["check", "build"]
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
@@ -73,7 +73,7 @@ jobs:
         uses: "foundry-rs/foundry-toolchain@v1"
 
       - name: "Install Bun"
-        uses: "oven-sh/setup-bun@v1"
+        uses: "oven-sh/setup-bun@v2"
 
       - name: "Install the Node.js dependencies"
         run: "bun install"
@@ -82,6 +82,6 @@ jobs:
         run: "forge test"
 
       - name: "Add test summary"
-        run: |
+        run: | # shell
           echo "## Tests result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.github/workflows/sync.yml

@@ -8,7 +8,7 @@ on:
 jobs:
   sync-release-branch:
     runs-on: "ubuntu-latest"
-    if: "startsWith(github.ref, 'refs/tags/v4.')"
+    if: startsWith(github.ref, 'refs/tags/v4.') != false
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v4"

.solhint.json

@@ -1,18 +1,13 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "code-complexity": "off",
     "compiler-version": ["error", ">=0.8.19"],
-    "const-name-snakecase": "off",
-    "contract-name-camelcase": "off",
-    "func-name-mixedcase": "off",
-    "func-visibility": ["error", { "ignoreConstructors": true }],
-    "gas-custom-errors": "off",
+    "function-max-lines": "off",
+    "gas-strict-inequalities": "off",
     "max-line-length": ["error", 132],
-    "no-console": "off",
     "no-global-import": "off",
     "no-inline-assembly": "off",
-    "not-rely-on-time": "off",
+    "use-natspec": "off",
     "var-name-mixedcase": "off"
   }
 }

.vscode/settings.json

@@ -1,9 +1,6 @@
 {
-  "[solidity]": {
-    "editor.defaultFormatter": "NomicFoundation.hardhat-solidity"
-  },
-  "[toml]": {
-    "editor.defaultFormatter": "tamasfe.even-better-toml"
-  },
-  "solidity.formatter": "forge"
+  "solidity.formatter": "forge",
+  "[json][jsonc][yaml]": { "editor.defaultFormatter": "esbenp.prettier-vscode" },
+  "[solidity]": { "editor.defaultFormatter": "NomicFoundation.hardhat-solidity" },
+  "[toml]": { "editor.defaultFormatter": "tamasfe.even-better-toml" }
 }

foundry.toml

@@ -1,15 +1,15 @@
-# Full reference https://github.com/foundry-rs/foundry/tree/master/config
+# Full reference: https://github.com/foundry-rs/foundry/tree/master/crates/config
 
 [profile.default]
   allow_internal_expect_revert = true
   auto_detect_solc = false
-  bytecode_hash = "none"
-  evm_version = "shanghai"
+  bytecode_hash = "ipfs"
+  evm_version = "shanghai"            # needed for greater coverage of EVM chains
   fuzz = { runs = 256 }
   optimizer = true
   optimizer_runs = 10_000
   out = "out"
-  solc = "0.8.26"
+  solc = "0.8.30"
   src = "src"
   test = "test"
 

package.json

@@ -10,9 +10,9 @@
     "url": "https://github.com/PaulRBerg/prb-math/issues"
   },
   "devDependencies": {
-    "forge-std": "github:foundry-rs/forge-std#v1.8.2",
-    "prettier": "^3.3.2",
-    "solhint": "^5.0.1"
+    "forge-std": "github:foundry-rs/forge-std#v1.9.7",
+    "prettier": "^3.6.2",
+    "solhint": "^6.0.0"
   },
   "files": [
     "src",
@@ -35,14 +35,21 @@
   "publishConfig": {
     "access": "public"
   },
-  "repository": "github:PaulRBerg/prb-math",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PaulRBerg/prb-math.git"
+  },
   "scripts": {
     "build": "forge build",
-    "clean": "rm -rf cache out",
-    "lint": "bun run lint:sol && bun run prettier:check",
-    "lint:sol": "forge fmt --check && bun solhint \"{src,test}/**/*.sol\"",
-    "prettier:check": "prettier --check \"**/*.{json,md,yml}\"",
-    "prettier:write": "prettier --write \"**/*.{json,md,yml}\"",
+    "clean": "bunx del-cli cache out",
+    "forge-check": "forge fmt --check",
+    "forge-write": "forge fmt",
+    "full-check": "bun run prettier-check && bun run solhint-check && bun run forge-check",
+    "full-write": "bun run prettier-write && bun run solhint-write && bun run forge-write",
+    "prettier-check": "prettier --check \"**/*.{json,md,yml}\"",
+    "prettier-write": "prettier --write \"**/*.{json,md,yml}\"",
+    "solhint-check": "solhint \"{src,test}/**/*.sol\"",
+    "solhint-write": "solhint --fix \"{src,test}/**/*.sol\"",
     "test": "forge test"
   }
 }

src/sd59x18/Math.sol

@@ -522,12 +522,12 @@ function log2(SD59x18 x) pure returns (SD59x18 result) {
 
         // Calculate the fractional part via the iterative approximation.
         // The `delta >>= 1` part is equivalent to `delta /= 2`, but shifting bits is more gas efficient.
-        int256 DOUBLE_UNIT = 2e18;
+        int256 doubleUnit = 2e18;
         for (int256 delta = uHALF_UNIT; delta > 0; delta >>= 1) {
             y = (y * y) / uUNIT;
 
             // Is y^2 >= 2e18 and so in the range [2e18, 4e18)?
-            if (y >= DOUBLE_UNIT) {
+            if (y >= doubleUnit) {
                 // Add the 2^{-m} factor to the logarithm.
                 resultInt = resultInt + delta;