Merge pull request #26 from trillion-network/minor/remove-yarn-fix-lcov

minor: remove yarn. fix lcov v2 changes. update to node LTS v22.11.0

.github/workflows/coverage.yml

@@ -1,10 +1,6 @@
 name: coverage
 
 on:
-  push:
-    branches: ["main"]
-    paths-ignore:
-      - README.md
   pull_request:
     branches: ["*"]
     paths-ignore:
@@ -43,7 +39,7 @@ jobs:
         # Filter out "script" contracts from coverage report
         run: |
           forge coverage --report lcov
-          lcov --remove ./lcov.info -o ./${{github.sha}}.lcov.info 'script'
+          lcov --remove ./lcov.info --rc derive_function_end_line=0 -o ./${{github.sha}}.lcov.info 'script'
         id: coverage-base
 
       - name: Archive base branch code coverage results
@@ -63,7 +59,7 @@ jobs:
         # Filter out "script" contracts from coverage report
         run: |
           forge coverage --report lcov
-          lcov --remove ./lcov.info -o ./${{github.event.pull_request.base.sha}}.lcov.info 'script'
+          lcov --remove ./lcov.info --rc derive_function_end_line=0 -o ./${{github.event.pull_request.base.sha}}.lcov.info 'script'
         id: coverage-head
 
       - name: Archive head branch code coverage results
@@ -79,9 +75,9 @@ jobs:
           name: ${{github.sha}}.lcov.info
 
       - name: Code Coverage Report
-        uses: romeovs/lcov-reporter-action@87a815f34ec27a5826abba44ce09bbc688da58fd
-        # The reason for using a hash rather than a version/tag, is the project
-        # failed in publishing this release: https://github.com/romeovs/lcov-reporter-action/issues/47
+        # use trillion-network/lcov-reporter-action
+        # to get fix for https://github.com/romeovs/lcov-reporter-action/pull/61
+        uses: trillion-network/lcov-reporter-action@v0.4.0
         with:
           lcov-file: ./${{github.event.pull_request.base.sha}}.lcov.info
           lcov-base: ./${{github.sha}}.lcov.info

.github/workflows/lint.yml

@@ -24,9 +24,9 @@ jobs:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
-          cache: "yarn"
+          node-version: 22
+          cache: "npm"
       - name: Install dependencies
-        run: yarn install --immutable
+        run: npm ci
       - name: Run solhint
-        run: yarn lint
+        run: npm run lint

.github/workflows/publish_npm.yml

@@ -27,16 +27,16 @@ jobs:
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
-          node-version: "20"
-          cache: "yarn"
+          node-version: 22
+          cache: "npm"
           registry-url: "https://registry.npmjs.org"
           scope: "@trillion-x"
 
       # Publish ABIs to NPM
       - name: Publish to NPM
         run: |
-          yarn config set version-git-tag false
-          yarn version --new-version $(git describe --tags)
-          yarn publish
+          npm config set version-git-tag false
+          npm version --new-version $(git describe --tags)
+          npm publish
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/slither.yml

@@ -26,8 +26,8 @@ jobs:
           submodules: recursive
       - uses: actions/setup-node@v4
         with:
-          node-version: "20"
-          cache: "yarn"
+          node-version: 22
+          cache: "npm"
       - name: Run Slither
         uses: crytic/[email protected]
         with:

.gitignore

@@ -15,6 +15,7 @@ docs/
 
 # Dotenv file
 .env
+.env.*
 
 # Node modules
 node_modules/
@@ -24,6 +25,7 @@ node_modules/
 !.yarn/releases
 !.yarn/plugins
 .pnp.*
+yarn.lock
 
 # DS Store files
 **/.DS_Store

.tool-versions

@@ -1 +1 @@
-nodejs 20.5.0
+nodejs 22.11.0

README.md

@@ -29,10 +29,10 @@ Install missing dependencies that are shown in the install output (ex: `brew ins
 foundryup
 ```
 
-Install the Solidity linter (`solhint`) we use, as a yarn dependency:
+Install the Solidity linter (`solhint`) we use, as a npm dependency:
 
 ```shell
-yarn install
+npm install
 ```
 
 Install the Slither static analysis tool (used to find vulnerabilities):
@@ -82,12 +82,12 @@ You can generate a quick coverage summary by running:
 forge coverage
 ```
 
-However, you likely may want to filter out "`*.s.sol`" script contracts and render a nice web UI to examine code coverage, which you can do using the `yarn` script I've written:
+However, you likely may want to filter out "`*.s.sol`" script contracts and render a nice web UI to examine code coverage, which you can do using the `npm` script I've written:
 
 > NOTE: This requires having `lcov` installed locally through homebrew.
 
 ```shell
-yarn coverage
+npm run coverage
 ```
 
 ### Code Formatting
@@ -103,7 +103,7 @@ forge fmt
 Solhint is a linter for our smart contracts. Run it like so:
 
 ```shell
-yarn lint
+npm run lint
 ```
 
 ### Static Analysis
@@ -128,7 +128,7 @@ forge snapshot
 
 Any smart contracts that need to be used as dependencies (for example, OpenZeppelin) - should be installed using `forge install`. This will install them as a `git submodule`.
 
-DO NOT use `yarn` to install smart contracts. The _only thing_ we use `yarn` for is to manage our Solidity linter `solhint`.
+DO NOT use `npm` to install smart contracts. The _only thing_ we use `npm` for is to manage our Solidity linter `solhint`.
 
 ```shell
 forge install

package.json

@@ -10,7 +10,7 @@
   "scripts": {
     "lint": "solhint 'src/**/*.sol' && solhint --config .solhint.test.json 'test/**/*.t.sol'",
     "test": "forge test",
-    "coverage": "forge coverage --report lcov && lcov --remove ./lcov.info -o ./lcov.info 'test/*' 'script/*' && genhtml lcov.info --branch-coverage --output-dir coverage && open coverage/index.html"
+    "coverage": "forge coverage --report lcov && lcov --remove ./lcov.info --rc derive_function_end_line=0 -o ./lcov.info 'test/*' 'script/*' && genhtml lcov.info --rc derive_function_end_line=0 --ignore-errors category --output-dir coverage && open coverage/index.html"
   },
   "devDependencies": {
     "solhint": "^5.0.3"