style: enforce conventional commits, minor linting improvements (#21)

varunsrin · web-flow · commit d16916efaf86 · 2022-07-24T12:53:04.000-07:00
* style: enforce conventional commits, minor linting improvements imported a series of ideas from https://github.com/paulrberg/foundry-template including conventional commits, more detailed configuration for fuzzing runs and adding solhint * build((lint-staged)): upgrade to latest version * style: make constant names SNAKE_CASE * chore: clean and update gas snapshot
diff --git a/.commitlintrc.yml b/.commitlintrc.yml
@@ -0,0 +1,2 @@
+extends:
+  - "@commitlint/config-conventional"
diff --git a/.gas-snapshot b/.gas-snapshot
@@ -1,70 +1,70 @@
-AccountRegistryTest:testCancelRecoveryFromCustodyAddress() (gas: 135294)
-AccountRegistryTest:testCancelRecoveryFromRecoveryAddress() (gas: 135469)
-AccountRegistryTest:testCannotCancelRecoveryIfNotStarted() (gas: 93253)
-AccountRegistryTest:testCannotCancelRecoveryIfUnauthorized() (gas: 143722)
-AccountRegistryTest:testCannotCompleteRecoveryIfNotStarted() (gas: 104236)
-AccountRegistryTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 146409)
-AccountRegistryTest:testCannotCompleteRecoveryToAddressThatOwnsAnId() (gas: 170667)
-AccountRegistryTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 144212)
-AccountRegistryTest:testCannotRegisterTwice() (gas: 59413)
-AccountRegistryTest:testCannotRequestRecoveryToAddressThatOwnsAnId() (gas: 116341)
-AccountRegistryTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 69534)
-AccountRegistryTest:testCannotRequestRecoveryUnlessIssued() (gas: 17887)
-AccountRegistryTest:testCannotSetRecoveryAddressWithoutId() (gas: 19024)
-AccountRegistryTest:testCannotTransferIfNoId() (gas: 21856)
-AccountRegistryTest:testCannotTransferToAddressWithId() (gas: 90944)
-AccountRegistryTest:testRecoveryCompletion() (gas: 133409)
-AccountRegistryTest:testRegister() (gas: 90240)
-AccountRegistryTest:testRequestRecovery() (gas: 145181)
-AccountRegistryTest:testSetRecoveryAddress() (gas: 95738)
-AccountRegistryTest:testTransfer() (gas: 76111)
-NameSpaceTest:testBidAfterOneStep() (gas: 220251)
-NameSpaceTest:testBidAndOverpay() (gas: 215870)
-NameSpaceTest:testBidFlatRate() (gas: 218629)
-NameSpaceTest:testBidImmediately() (gas: 231922)
-NameSpaceTest:testBidOnHundredthStep() (gas: 218629)
-NameSpaceTest:testBidOnPenultimateStep() (gas: 218619)
-NameSpaceTest:testBidShouldClearRecovery() (gas: 262274)
-NameSpaceTest:testCancelRecoveryFromCustodyAddress() (gas: 224337)
-NameSpaceTest:testCancelRecoveryFromRecoveryAddress() (gas: 223953)
-NameSpaceTest:testCannotBidIfRegistrable() (gas: 30917)
-NameSpaceTest:testCannotBidUnlessBiddable() (gas: 175857)
-NameSpaceTest:testCannotCancelRecoveryIfNotStarted() (gas: 188379)
-NameSpaceTest:testCannotCancelRecoveryIfUnauthorized() (gas: 235048)
-NameSpaceTest:testCannotCommitWithInvalidName() (gas: 22838)
-NameSpaceTest:testCannotCompleteRecoveryIfExpired() (gas: 246950)
-NameSpaceTest:testCannotCompleteRecoveryIfNotStarted() (gas: 192631)
-NameSpaceTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 220397)
-NameSpaceTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 236645)
-NameSpaceTest:testCannotReclaimUnlessMinted() (gas: 17407)
-NameSpaceTest:testCannotRegisterBeforeDelay() (gas: 90808)
-NameSpaceTest:testCannotRegisterWithoutPayment() (gas: 85835)
-NameSpaceTest:testCannotRenewIfBiddable() (gas: 165501)
-NameSpaceTest:testCannotRenewIfRegistered() (gas: 165585)
-NameSpaceTest:testCannotRenewIfRegistrable() (gas: 31908)
-NameSpaceTest:testCannotRenewIfRegistrable2() (gas: 31950)
-NameSpaceTest:testCannotRenewWithoutPayment() (gas: 158644)
-NameSpaceTest:testCannotRequestRecoveryIfRegistrable() (gas: 26549)
-NameSpaceTest:testCannotRequestRecoveryToZeroAddr() (gas: 188122)
-NameSpaceTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 166552)
-NameSpaceTest:testCannotSetRecoveryIfExpired() (gas: 167808)
-NameSpaceTest:testCannotSetRecoveryIfRegistrable() (gas: 20986)
-NameSpaceTest:testCannotSetRecoveryUnlessOwner() (gas: 161314)
-NameSpaceTest:testCurrYear() (gas: 78247)
-NameSpaceTest:testCurrYearPayment() (gas: 45881)
-NameSpaceTest:testGenerateCommit() (gas: 40350)
-NameSpaceTest:testOwnerOfRevertsIfExpired() (gas: 155403)
-NameSpaceTest:testOwnerOfRevertsIfRegistrable() (gas: 12872)
-NameSpaceTest:testReclaimBiddableNames() (gas: 184160)
-NameSpaceTest:testReclaimRegisteredNames() (gas: 192312)
-NameSpaceTest:testReclaimRenewableNames() (gas: 184214)
-NameSpaceTest:testReclaimResetsRecoveryState() (gas: 228319)
-NameSpaceTest:testRecoveryCompletion() (gas: 247456)
-NameSpaceTest:testRegister() (gas: 259269)
-NameSpaceTest:testRenewOther() (gas: 177082)
-NameSpaceTest:testRenewSelf() (gas: 174499)
-NameSpaceTest:testRenewWithOverpayment() (gas: 180049)
-NameSpaceTest:testRequestRecovery() (gas: 244495)
-NameSpaceTest:testSetRecoveryAddress() (gas: 192523)
-NameSpaceTest:testTransferFromCannotTransferExpiredName() (gas: 174029)
-NameSpaceTest:testTransferFromResetsRecovery() (gas: 227661)
+AccountRegistryTest:testCancelRecoveryFromCustodyAddress() (gas: 134170)
+AccountRegistryTest:testCancelRecoveryFromRecoveryAddress() (gas: 134333)
+AccountRegistryTest:testCannotCancelRecoveryIfNotStarted() (gas: 92791)
+AccountRegistryTest:testCannotCancelRecoveryIfUnauthorized() (gas: 142930)
+AccountRegistryTest:testCannotCompleteRecoveryIfNotStarted() (gas: 103609)
+AccountRegistryTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 145586)
+AccountRegistryTest:testCannotCompleteRecoveryToAddressThatOwnsAnId() (gas: 169762)
+AccountRegistryTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 143386)
+AccountRegistryTest:testCannotRegisterTwice() (gas: 59192)
+AccountRegistryTest:testCannotRequestRecoveryToAddressThatOwnsAnId() (gas: 115720)
+AccountRegistryTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 69101)
+AccountRegistryTest:testCannotRequestRecoveryUnlessIssued() (gas: 17612)
+AccountRegistryTest:testCannotSetRecoveryAddressWithoutId() (gas: 18729)
+AccountRegistryTest:testCannotTransferIfNoId() (gas: 21540)
+AccountRegistryTest:testCannotTransferToAddressWithId() (gas: 90434)
+AccountRegistryTest:testRecoveryCompletion() (gas: 132729)
+AccountRegistryTest:testRegister() (gas: 89981)
+AccountRegistryTest:testRequestRecovery() (gas: 144520)
+AccountRegistryTest:testSetRecoveryAddress() (gas: 95217)
+AccountRegistryTest:testTransfer() (gas: 75710)
+NameSpaceTest:testBidAfterOneStep() (gas: 219011)
+NameSpaceTest:testBidAndOverpay() (gas: 215110)
+NameSpaceTest:testBidFlatRate() (gas: 217389)
+NameSpaceTest:testBidImmediately() (gas: 230289)
+NameSpaceTest:testBidOnHundredthStep() (gas: 217389)
+NameSpaceTest:testBidOnPenultimateStep() (gas: 217356)
+NameSpaceTest:testBidShouldClearRecovery() (gas: 261366)
+NameSpaceTest:testCancelRecoveryFromCustodyAddress() (gas: 223356)
+NameSpaceTest:testCancelRecoveryFromRecoveryAddress() (gas: 223027)
+NameSpaceTest:testCannotBidIfRegistrable() (gas: 30583)
+NameSpaceTest:testCannotBidUnlessBiddable() (gas: 174689)
+NameSpaceTest:testCannotCancelRecoveryIfNotStarted() (gas: 187551)
+NameSpaceTest:testCannotCancelRecoveryIfUnauthorized() (gas: 234090)
+NameSpaceTest:testCannotCommitWithInvalidName() (gas: 21940)
+NameSpaceTest:testCannotCompleteRecoveryIfExpired() (gas: 245740)
+NameSpaceTest:testCannotCompleteRecoveryIfNotStarted() (gas: 191835)
+NameSpaceTest:testCannotCompleteRecoveryIfUnauthorized() (gas: 219345)
+NameSpaceTest:testCannotCompleteRecoveryWhenInEscrow() (gas: 235797)
+NameSpaceTest:testCannotReclaimUnlessMinted() (gas: 17306)
+NameSpaceTest:testCannotRegisterBeforeDelay() (gas: 90261)
+NameSpaceTest:testCannotRegisterWithoutPayment() (gas: 85355)
+NameSpaceTest:testCannotRenewIfBiddable() (gas: 164768)
+NameSpaceTest:testCannotRenewIfRegistered() (gas: 164928)
+NameSpaceTest:testCannotRenewIfRegistrable() (gas: 31581)
+NameSpaceTest:testCannotRenewIfRegistrable2() (gas: 31578)
+NameSpaceTest:testCannotRenewWithoutPayment() (gas: 157897)
+NameSpaceTest:testCannotRequestRecoveryIfRegistrable() (gas: 26256)
+NameSpaceTest:testCannotRequestRecoveryToZeroAddr() (gas: 187226)
+NameSpaceTest:testCannotRequestRecoveryUnlessAuthorized() (gas: 165779)
+NameSpaceTest:testCannotSetRecoveryIfExpired() (gas: 166726)
+NameSpaceTest:testCannotSetRecoveryIfRegistrable() (gas: 20678)
+NameSpaceTest:testCannotSetRecoveryUnlessOwner() (gas: 160583)
+NameSpaceTest:testCurrYear() (gas: 78183)
+NameSpaceTest:testCurrYearPayment() (gas: 45694)
+NameSpaceTest:testGenerateCommit() (gas: 40003)
+NameSpaceTest:testOwnerOfRevertsIfExpired() (gas: 154835)
+NameSpaceTest:testOwnerOfRevertsIfRegistrable() (gas: 12799)
+NameSpaceTest:testReclaimBiddableNames() (gas: 183484)
+NameSpaceTest:testReclaimRegisteredNames() (gas: 191689)
+NameSpaceTest:testReclaimRenewableNames() (gas: 183516)
+NameSpaceTest:testReclaimResetsRecoveryState() (gas: 227596)
+NameSpaceTest:testRecoveryCompletion() (gas: 246644)
+NameSpaceTest:testRegister() (gas: 258116)
+NameSpaceTest:testRenewOther() (gas: 176426)
+NameSpaceTest:testRenewSelf() (gas: 173911)
+NameSpaceTest:testRenewWithOverpayment() (gas: 179467)
+NameSpaceTest:testRequestRecovery() (gas: 243434)
+NameSpaceTest:testSetRecoveryAddress() (gas: 191620)
+NameSpaceTest:testTransferFromCannotTransferExpiredName() (gas: 172891)
+NameSpaceTest:testTransferFromResetsRecovery() (gas: 226940)
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -15,16 +15,17 @@ jobs:
     strategy:
       fail-fast: true
 
-    name: Foundry project
+    name: Farcaster Contract Tests
     timeout-minutes: 10
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
         with:
           submodules: recursive
 
-      - uses: actions/setup-node@v2
+      - uses: actions/setup-node@v3
         with:
+          cache: "yarn"
           node-version: "18"
 
       - name: Restore cached dependencies for Node modules.
@@ -38,7 +39,7 @@ jobs:
         run: yarn install
 
       - name: Run linter
-        run: yarn lint:check
+        run: yarn lint
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
@@ -53,5 +54,10 @@ jobs:
       - name: Run Forge tests
         run: forge test -vvv
 
+      - name: Build the contracts
+        run: |
+          forge --version
+          forge build --sizes
+
       - name: Check Forge gas snapshot
         run: forge snapshot --check
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,18 @@
-cache/
-out/
-node_modules/
-.env
+# directories
+.yarn/*
+!.yarn/patches
+!.yarn/releases
+!.yarn/plugins
+!.yarn/sdks
+!.yarn/versions
+**/cache
+**/node_modules
+**/out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+yarn-debug.log*
+yarn-error.log*
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit $1
diff --git a/.husky/prepare-commit-msg b/.husky/prepare-commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+exec < /dev/tty && node_modules/.bin/cz --hook || true
diff --git a/.lintstagedrc b/.lintstagedrc
@@ -0,0 +1,5 @@
+{
+  "*.{json,md,sol,yml}": [
+    "prettier --config ./.prettierrc.yml --write"
+  ]
+}
diff --git a/.prettierignore b/.prettierignore
@@ -1,3 +1,13 @@
-cache
-node_modules
-lib
+# directories
+.yarn/
+**/broadcast
+**/cache
+**/lib
+**/out
+**/node_modules
+
+# files
+*.env
+*.log
+yarn-debug.log*
+yarn-error.log*
diff --git a/.prettierrc b/.prettierrc
diff --git a/.prettierrc.yml b/.prettierrc.yml
@@ -0,0 +1,17 @@
+arrowParens: "avoid"
+bracketSpacing: true
+endOfLine: "auto"
+printWidth: 120
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+
+overrides:
+  - files: ["*.sol"]
+    options:
+      compiler: "0.8.15"
+      tabWidth: 4
+      useTabs: false
+      singleQuote: false
+      bracketSpacing: false
+      explicitTypes: "always"
diff --git a/.solhint.json b/.solhint.json
@@ -0,0 +1,18 @@
+{
+  "extends": "solhint:recommended",
+  "plugins": ["prettier"],
+  "rules": {
+    "code-complexity": ["error", 8],
+    "compiler-version": ["error", ">=0.8.4"],
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "max-line-length": ["error", 120],
+    "not-rely-on-time": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ],
+    "reason-string": ["warn", { "maxLength": 64 }]
+  }
+}
diff --git a/.solhintignore b/.solhintignore
@@ -0,0 +1,3 @@
+# directories
+**/lib
+**/node_modules
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,15 +1,15 @@
 {
-    "search.exclude": {
-      ".git": true,
-      "out": true,
-      "cache": true,
-    },
-    "editor.formatOnSave": true,
-    "editor.rulers": [99],
-    "[json]": {
-      "editor.defaultFormatter": "dbaeumer.vscode-eslint"
-    },
-    "[solidity]": {
-        "editor.defaultFormatter": "JuanBlanco.solidity"
-    }
+  "search.exclude": {
+    ".git": true,
+    "out": true,
+    "cache": true
+  },
+  "editor.formatOnSave": true,
+  "editor.rulers": [99],
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[solidity]": {
+    "editor.defaultFormatter": "JuanBlanco.solidity"
+  }
 }
diff --git a/foundry.toml b/foundry.toml
@@ -1,7 +1,14 @@
 [profile.default]
-src = 'src'
-out = 'out'
+fuzz_runs = 256
 libs = ['lib']
+gas_reports = ["*"]
+optimizer = true
+optimizer_runs = 10_000
+out = 'out'
 solc_version = "0.8.15"
+src = 'src'
+test = "test"
 
-# See more config options https://github.com/foundry-rs/foundry/tree/master/config
+[profile.ci]
+fuzz_runs = 1_000
+verbosity = 4
diff --git a/package.json b/package.json
@@ -8,18 +8,29 @@
   "repository": "git@github.com:farcasterxyz/contracts.git",
   "author": "Varun Srinivasan <varunsrin@gmail.com>",
   "license": "None",
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
+  },
   "devDependencies": {
+    "@commitlint/cli": "^17.0.3",
+    "@commitlint/config-conventional": "^17.0.3",
+    "commitizen": "^4.2.5",
+    "cz-conventional-changelog": "^3.3.0",
     "husky": "^8.0.1",
     "lint-staged": "^13.0.2",
     "prettier": "^2.7.1",
-    "prettier-plugin-solidity": "^1.0.0-beta.19"
+    "prettier-plugin-solidity": "^1.0.0-beta.19",
+    "solhint": "^3.3.7",
+    "solhint-plugin-prettier": "^0.0.5"
   },
   "scripts": {
-    "lint": "prettier --write **.sol",
-    "lint:check": "prettier --check **.sol",
-    "prepare": "husky install"
-  },
-  "lint-staged": {
-    "*.sol": "prettier --check"
+    "lint": "yarn solhint && yarn prettier:check",
+    "lint:check": "yarn prettier:check && yarn solhint:check",
+    "prepare": "husky install",
+    "prettier": "prettier --config \"./.prettierrc.yml\" --write \"**/*.{json,md,sol,yml}\"",
+    "prettier:check": "prettier --config \"./.prettierrc.yml\" --check \"**/*.{json,md,sol,yml}\"",
+    "solhint": "solhint --config \"./.solhint.json\" \"{src,test}/**/*.sol\""
   }
 }
diff --git a/src/Namespace.sol b/src/Namespace.sol
diff --git a/test/Namespace.t.sol b/test/Namespace.t.sol
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+extends:`
	`2`	`+ - "@commitlint/config-conventional"`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "*.{json,md,sol,yml}": [
 +    "prettier --config ./.prettierrc.yml --write"
 +  ]
 +}