ci: simplify syntax for "on:"

build: add "postpublish" and "prepublishOnly" hook scripts
build: add "rimraf" as Node.js dev dep
build: set "branch" to "v1" for "forge-std" submodule
build: set "branch" to "v5" for "prb-contracts" submodule
build: set "cbor_metadata" to "false"
build: upgrade to Solidity v0.8.18
chore: add Codecov config
ci: add "build", "clean" and "test" scripts in "package.json"
ci: add "workflow_syntax" in "on" for "main" branch
ci: separate jobs in workflow
ci: track coverage with Codecov
docs: capitalize username
docs: update link to "hardhat-template" repo
style: format Foundry config with Taplo
style: use spaces for indenting in ".gitmodules"

.github/FUNDING.yml

@@ -1 +1 @@
-custom: ["https://gitcoin.co/grants/1657/paulrberg-open-source-engineering"]
+custom: ["https://gitcoin.co/grants/1657/PaulRBerg-open-source-engineering"]

.github/workflows/ci.yml

@@ -4,28 +4,19 @@ env:
   FOUNDRY_PROFILE: "ci"
 
 on:
+  workflow_dispatch:
   pull_request:
-    branches:
-      - "main"
-      - "staging"
   push:
     branches:
       - "main"
       - "staging"
 
 jobs:
-  ci:
+  lint:
     runs-on: "ubuntu-latest"
     steps:
       - name: "Check out the repo"
         uses: "actions/checkout@v3"
-        with:
-          submodules: "recursive"
-
-      - name: "Install Foundry"
-        uses: "onbjerg/foundry-toolchain@v1"
-        with:
-          version: "nightly"
 
       - name: "Install Node.js"
         uses: "actions/setup-node@v3"
@@ -41,21 +32,70 @@ jobs:
 
       - name: "Add lint summary"
         run: |
-          echo "## Lint" >> $GITHUB_STEP_SUMMARY
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
 
-      - name: "Show the Foundry config"
-        run: "forge config"
+  build:
+    needs: "lint"
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
 
-      - name: "Run the tests"
-        run: "forge test"
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Build the contracts and print their size"
+        run: "forge build --sizes"
 
-      - name: "Build the contracts"
+      - name: "Add build summary"
         run: |
-          forge --version
-          forge build --sizes
+          echo "## Build result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  test:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Run the tests"
+        run: "forge test"
 
       - name: "Add test summary"
         run: |
-          echo "## Tests" >> $GITHUB_STEP_SUMMARY
+          echo "## Tests result" >> $GITHUB_STEP_SUMMARY
           echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  coverage:
+    needs: ["lint", "build"]
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v3"
+        with:
+          submodules: "recursive"
+
+      - name: "Install Foundry"
+        uses: "foundry-rs/foundry-toolchain@v1"
+
+      - name: "Generate the coverage report"
+        run: "forge coverage --report lcov"
+
+      - name: "Upload coverage report to Codecov"
+        uses: "codecov/codecov-action@v3"
+        with:
+          files: "./lcov.info"
+
+      - name: "Add coverage summary"
+        run: |
+          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY

.gitmodules

@@ -1,12 +1,12 @@
 [submodule "lib/forge-std"]
-  branch = "master"
-	path = "lib/forge-std"
-	url = "https://github.com/foundry-rs/forge-std"
+  branch = "v1"
+  path = "lib/forge-std"
+  url = "https://github.com/foundry-rs/forge-std"
 [submodule "lib/prb-contracts"]
-  branch = "main"
+  branch = "v5"
   path = "lib/prb-contracts"
-  url = "https://github.com/paulrberg/prb-contracts"
+  url = "https://github.com/PaulRBerg/prb-contracts"
 [submodule "lib/prb-test"]
   branch = "0.3.1"
   path = "lib/prb-test"
-  url = "https://github.com/paulrberg/prb-test"
+  url = "https://github.com/PaulRBerg/prb-test"

.prettierrc.yml

@@ -9,5 +9,5 @@ useTabs: false
 overrides:
   - files: "*.sol"
     options:
-      compiler: "0.8.17"
+      compiler: "0.8.18"
       tabWidth: 4

CHANGELOG.md

@@ -16,12 +16,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 - Change the extension for types from `.d.ts` to `.ts`.
 - Upgrade to latest versions of `ethers`.
 - Upgrade to Solidity v0.8.12.
-- Use modern Solidity `create2` instead of inline assembly (see [pull request #20](https://github.com/paulrberg/prb-proxy/pull/20)).
-- Use modern Solidity `target.code.length` instead of inline assembly (see pull request [pull request #19](https://github.com/paulrberg/prb-proxy/pull/19)).
+- Use modern Solidity `create2` instead of inline assembly (see [pull request #20](https://github.com/PaulRBerg/prb-proxy/pull/20)).
+- Use modern Solidity `target.code.length` instead of inline assembly (see pull request [pull request #19](https://github.com/PaulRBerg/prb-proxy/pull/19)).
 
 ### Fixed
 
-- Old owner address in `TransferOwnership` (see pull request [pull request #29](https://github.com/paulrberg/prb-proxy/pull/29).
+- Old owner address in `TransferOwnership` (see pull request [pull request #29](https://github.com/PaulRBerg/prb-proxy/pull/29).
 
 ### Removed
 
@@ -43,6 +43,6 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - First release.
 
-[2.0.0]: https://github.com/paulrberg/prb-proxy/compare/v1.0.1...v2.0.0
-[1.0.1]: https://github.com/paulrberg/prb-proxy/compare/v1.0.0...v1.0.1
-[1.0.0]: https://github.com/paulrberg/prb-proxy/releases/tag/v1.0.0
+[2.0.0]: https://github.com/PaulRBerg/prb-proxy/compare/v1.0.1...v2.0.0
+[1.0.1]: https://github.com/PaulRBerg/prb-proxy/compare/v1.0.0...v1.0.1
+[1.0.0]: https://github.com/PaulRBerg/prb-proxy/releases/tag/v1.0.0

README.md

@@ -1,7 +1,7 @@
 # PRBProxy [![Github Actions][gha-badge]][gha] [![Foundry][foundry-badge]][foundry] [![Styled with Prettier][prettier-badge]][prettier] [![License: MIT][license-badge]][license]
 
-[gha]: https://github.com/paulrberg/prb-proxy/actions
-[gha-badge]: https://github.com/paulrberg/prb-proxy/actions/workflows/ci.yml/badge.svg
+[gha]: https://github.com/PaulRBerg/prb-proxy/actions
+[gha-badge]: https://github.com/PaulRBerg/prb-proxy/actions/workflows/ci.yml/badge.svg
 [foundry]: https://getfoundry.sh/
 [foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
 [prettier]: https://prettier.io
@@ -110,7 +110,7 @@ All snippets are written in TypeScript. It is assumed that you run them in a loc
 Familiarity with [Ethers](https://github.com/ethers-io/ethers.js) and
 [TypeChain](https://github.com/ethereum-ts/TypeChain/tree/master/packages/hardhat) is also requisite.
 
-Check out my [solidity-template](https://github.com/paulrberg/solidity-template) for a boilerplate that combines
+Check out my [hardhat-template](https://github.com/PaulRBerg/hardhat-template) for a Hardhat-based boilerplate that combines
 Hardhat, Ethers and TypeChain.
 
 ### Target Contract
@@ -299,7 +299,7 @@ will not be liable for any loss, direct or indirect through continued use of thi
 
 ### Contact
 
-If you discover any security issues, you can report them via [Keybase](https://keybase.io/paulrberg).
+If you discover any security issues, you can report them via [Keybase](https://keybase.io/PaulRBerg).
 
 ## Related Efforts
 
@@ -309,8 +309,8 @@ If you discover any security issues, you can report them via [Keybase](https://k
 
 ## Contributing
 
-Feel free to dive in! [Open](https://github.com/paulrberg/prb-proxy/issues/new) an issue,
-[start](https://github.com/paulrberg/prb-proxy/discussions/new) a discussion or submit a PR.
+Feel free to dive in! [Open](https://github.com/PaulRBerg/prb-proxy/issues/new) an issue,
+[start](https://github.com/PaulRBerg/prb-proxy/discussions/new) a discussion or submit a PR.
 
 ### Pre Requisites
 

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - "test"

foundry.toml

@@ -1,25 +1,29 @@
 # Full reference https://github.com/foundry-rs/foundry/tree/master/config
 
-[etherscan]
-ethereum = { key = "${ETHERSCAN_API_KEY}" }
-goerli = { key = "${ETHERSCAN_API_KEY}" }
-
 [profile.default]
-auto_detect_solc = false
-bytecode_hash = "none"
-fuzz = { runs = 1_000 }
-gas_reports = ["*"]
-libs = ["lib"]
-optimizer = true
-optimizer_runs = 10_000
-out = "out"
-solc = "0.8.17"
-src = "src"
-test = "test"
+  auto_detect_solc = false
+  bytecode_hash = "none"
+  cbor_metadata = false
+  gas_reports = ["*"]
+  libs = ["lib"]
+  optimizer = true
+  optimizer_runs = 10_000
+  out = "out"
+  solc = "0.8.18"
+  src = "src"
+  test = "test"
+
+[profile.default.fuzz]
+  max_test_rejects = 100_000
+  runs = 1_000
 
 [profile.ci]
-fuzz = { runs = 10_000 }
+  fuzz = { runs = 10_000 }
+
+[etherscan]
+  ethereum = { key = "${ETHERSCAN_API_KEY}" }
+  goerli = { key = "${ETHERSCAN_API_KEY}" }
 
 [rpc_endpoints]
-localhost="http://localhost:8545"
-goerli="https://goerli.infura.io/v3/${INFURA_API_KEY}"
+  localhost = "http://localhost:8545"
+  goerli = "https://goerli.infura.io/v3/${INFURA_API_KEY}"

package.json

@@ -4,10 +4,10 @@
   "version": "2.0.0",
   "author": {
     "name": "Paul Razvan Berg",
-    "url": "https://github.com/paulrberg"
+    "url": "https://github.com/PaulRBerg"
   },
   "bugs": {
-    "url": "https://github.com/paulrberg/prb-proxy/issues"
+    "url": "https://github.com/PaulRBerg/prb-proxy/issues"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.3.0",
@@ -20,6 +20,7 @@
     "nyc": "^15.1.0",
     "prettier": "^2.8.0",
     "prettier-plugin-solidity": "^1.0.0",
+    "rimraf": "^4.1.2",
     "solhint": "^3.3.7",
     "solhint-plugin-prettier": "^0.0.5",
     "ts-node": "^10.9.1",
@@ -29,7 +30,7 @@
     "/src",
     "CHANGELOG.md"
   ],
-  "homepage": "https://github.com/paulrberg/prb-proxy#readme",
+  "homepage": "https://github.com/PaulRBerg/prb-proxy#readme",
   "keywords": [
     "blockchain",
     "delegatecall",
@@ -46,17 +47,21 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/paulrberg/prb-proxy"
+    "url": "https://github.com/PaulRBerg/prb-proxy"
   },
   "resolutions": {
     "solhint/@solidity-parser/parser": "^0.14.5"
   },
   "scripts": {
-    "lint": "yarn solhint && yarn prettier:check",
-    "lint:check": "yarn prettier:check && yarn solhint:check",
+    "build": "forge build",
+    "clean": "rimraf broadcast cache out",
+    "lint": "yarn lint:sol && yarn prettier:check",
+    "lint:sol": "solhint \"{src,test}/**/*.sol\"",
     "postinstall": "husky install",
+    "postpublish": "pinst --enable",
+    "prepublishOnly": "pinst --disable",
     "prettier:check": "prettier --check \"**/*.{json,md,sol,yml}\"",
     "prettier:write": "prettier --write \"**/*.{json,md,sol,yml}\"",
-    "solhint": "solhint \"{src,test}/**/*.sol\""
+    "test": "forge test --ignored-error-codes 5159"
   }
 }

yarn.lock

@@ -599,6 +599,7 @@ __metadata:
     nyc: ^15.1.0
     prettier: ^2.8.0
     prettier-plugin-solidity: ^1.0.0
+    rimraf: ^4.1.2
     solhint: ^3.3.7
     solhint-plugin-prettier: ^0.0.5
     ts-node: ^10.9.1
@@ -4509,6 +4510,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"rimraf@npm:^4.1.2":
+  version: 4.1.2
+  resolution: "rimraf@npm:4.1.2"
+  bin:
+    rimraf: dist/cjs/src/bin.js
+  checksum: 480b8147fd9bcbef3ac118f88a7b1169c3872977a3411a0c84df838bfc30e175a394c0db6f9619fc8b8a886a18c6d779d5e74f380a0075ecc710afaf81b3f50c
+  languageName: node
+  linkType: hard
+
 "run-async@npm:^2.2.0, run-async@npm:^2.4.0":
   version: 2.4.1
   resolution: "run-async@npm:2.4.1"