chore: tidy up and clear boilerplate sample files (#4)

Author: 0xItadaki

.github/workflows/tests.yml

@@ -26,7 +26,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20.x
-          cache: 'yarn'
+          cache: "yarn"
 
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
@@ -53,7 +53,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20.x
-          cache: 'yarn'
+          cache: "yarn"
 
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
@@ -64,48 +64,48 @@ jobs:
       - name: Run tests
         run: yarn test:integration
 
-  medusa-tests:
-    name: Medusa Test
-    runs-on: ubuntu-latest
-    container: ghcr.io/trailofbits/eth-security-toolbox/ci:nightly-20241223
+  # medusa-tests:
+  #   name: Medusa Test
+  #   runs-on: ubuntu-latest
+  #   container: ghcr.io/trailofbits/eth-security-toolbox/ci:nightly-20241223
 
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          submodules: recursive
+  #   steps:
+  #     - name: Checkout repository
+  #       uses: actions/checkout@v4
+  #       with:
+  #         submodules: recursive
 
-      - name: Install dependencies
-        run: yarn --frozen-lockfile --network-concurrency 1
+  #     - name: Install dependencies
+  #       run: yarn --frozen-lockfile --network-concurrency 1
 
-      - name: Run Medusa
-        run: medusa fuzz --test-limit 200000
+  #     - name: Run Medusa
+  #       run: medusa fuzz --test-limit 200000
 
-  halmos-tests:
-    name: Run symbolic execution tests
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
+  # halmos-tests:
+  #   name: Run symbolic execution tests
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - uses: actions/checkout@v4
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: stable
+  #     - name: Install Foundry
+  #       uses: foundry-rs/foundry-toolchain@v1
+  #       with:
+  #         version: stable
 
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: 'yarn'
+  #     - name: Use Node.js
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: 20.x
+  #         cache: 'yarn'
 
-      - name: Install dependencies
-        run: yarn --frozen-lockfile --network-concurrency 1
+  #     - name: Install dependencies
+  #       run: yarn --frozen-lockfile --network-concurrency 1
 
-      - name: Precompile
-        run: yarn build
+  #     - name: Precompile
+  #       run: yarn build
 
-      - name: Run tests
-        run: yarn test:integration
+  #     - name: Run tests
+  #       run: yarn test:integration
 
   lint:
     name: Static Analysis
@@ -127,7 +127,7 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 20.x
-          cache: 'yarn'
+          cache: "yarn"
 
       - name: Install dependencies
         run: yarn --frozen-lockfile --network-concurrency 1
@@ -138,4 +138,4 @@ jobs:
       - name: Install and run Bulloak
         uses: smol-ninja/bulloak-toolchain@v1
         with:
-          test-dir: 'test/unit'
+          test-dir: "test/unit"

README.md

@@ -1,36 +1,8 @@
-<img src="https://raw.githubusercontent.com/defi-wonderland/brand/v1.0.0/external/solidity-foundry-boilerplate-banner.png" alt="wonderland banner" align="center" />
-<br />
+# L2Resolver
 
-<div align="center"><strong>Start your next Solidity project with Foundry in seconds</strong></div>
-<div align="center">A highly scalable foundation focused on DX and best practices</div>
+Minimal L2 Resolver system for ENS. It resolves ENS names to their corresponding [EIP-7930](https://eips.ethereum.org/EIPS/eip-7930)-formatted chain identifiers (as bytes) and maps these EIP-7930 chain identifiers back to their primary ENS names. The system is implemented as a single contract that manages storage, authorization, and resolution logic.
 
-<br />
-
-## Features
-
-<dl>
-  <dt>Sample contracts</dt>
-  <dd>Basic Greeter contract with an external interface.</dd>
-
-  <dt>Foundry setup</dt>
-  <dd>Foundry configuration with multiple custom profiles and remappings.</dd>
-
-  <dt>Deployment scripts</dt>
-  <dd>Sample scripts to deploy contracts on both mainnet and testnet.</dd>
-
-  <dt>Sample Integration, Unit, Property-based fuzzed and symbolic tests</dt>
-  <dd>Example tests showcasing mocking, assertions and configuration for mainnet forking. As well it includes everything needed in order to check code coverage.</dd>
-  <dd>Unit tests are built based on the <a href="https://twitter.com/PaulRBerg/status/1682346315806539776">Branched-Tree Technique</a>, using <a href="https://github.com/alexfertel/bulloak">Bulloak</a>.
-  <dd>Formal verification and property-based fuzzing are achieved with <a href="https://github.com/a16z/halmos">Halmos</a> and <a href="https://github.com/crytic/medusa">Medusa</a> (resp.).
-
-  <dt>Linter</dt>
-  <dd>Simple and fast solidity linting thanks to forge fmt.</dd>
-  <dd>Find missing natspec automatically.</dd>
-
-  <dt>Github workflows CI</dt>
-  <dd>Run all tests and see the coverage as you push your changes.</dd>
-  <dd>Export your Solidity interfaces and contracts as packages, and publish them to NPM.</dd>
-</dl>
+The complete technical specification can be found [here](https://github.com/ethereum/L2-interop/blob/main/specs/addresses/L2Resolver.md).
 
 ## Setup
 

foundry.toml

@@ -9,7 +9,7 @@ multiline_func_header = 'params_first_multi'
 sort_imports = true
 
 [profile.default]
-solc_version = '0.8.23'
+solc_version = '0.8.30'
 libs = ['node_modules', 'lib']
 optimizer_runs = 10_000
 

package.json

@@ -22,13 +22,13 @@
     "lint:sol": "solhint 'src/**/*.sol' 'script/**/*.sol' 'test/**/*.sol'",
     "prepare": "husky",
     "test": "forge test -vvv",
+    "test:bulloak:fix": "bulloak check --fix ./**/*.tree",
+    "test:bulloak:scaffold": "bulloak scaffold -wS ./**/*.tree",
     "test:fuzz": "medusa fuzz",
     "test:integration": "forge test --match-contract Integration -vvv",
     "test:symbolic": "halmos",
     "test:unit": "forge test --match-contract Unit -vvv",
-    "test:unit:deep": "FOUNDRY_FUZZ_RUNS=5000 yarn test:unit",
-    "test:bulloak:fix": "bulloak check --fix ./**/*.tree",
-    "test:bulloak:scaffold": "bulloak scaffold -wS ./**/*.tree"
+    "test:unit:deep": "FOUNDRY_FUZZ_RUNS=5000 yarn test:unit"
   },
   "lint-staged": {
     "*.{js,css,md,ts,sol}": "forge fmt",
@@ -43,7 +43,7 @@
     "forge-std": "github:foundry-rs/forge-std#1.9.2",
     "halmos-cheatcodes": "github:a16z/halmos-cheatcodes#c0d8655",
     "husky": ">=9",
-    "lint-staged": ">=10",
+    "lint-staged": ">=16",
     "solhint-community": "4.0.1",
     "solhint-config-wonderland": "0.0.1",
     "sort-package-json": "2.10.0"