initial implementation sketch

.czrc

@@ -0,0 +1,3 @@
+{
+  "path": "cz-conventional-changelog"
+}

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig  http://EditorConfig.org
+
+# top-most EditorConfig file
+root = true
+
+# All files
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.sol]
+indent_size = 4

.env.example

@@ -0,0 +1,4 @@
+MNEMONIC=
+INFURA_KEY=
+ETHERSCAN_API_KEY=
+ARBISCAN_API_KEY=

.eslintignore

@@ -0,0 +1,22 @@
+# directories
+.coverage_artifacts
+.coverage_cache
+.coverage_contracts
+artifacts
+build
+cache
+coverage
+dist
+node_modules
+types
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+bun.lockb
+coverage.json
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

.eslintrc.yml

@@ -0,0 +1,21 @@
+extends:
+  - "eslint:recommended"
+  - "plugin:@typescript-eslint/eslint-recommended"
+  - "plugin:@typescript-eslint/recommended"
+  - "prettier"
+parser: "@typescript-eslint/parser"
+parserOptions:
+  project: "tsconfig.json"
+plugins:
+  - "@typescript-eslint"
+root: true
+rules:
+  "@typescript-eslint/no-floating-promises":
+    - error
+    - ignoreIIFE: true
+      ignoreVoid: true
+  "@typescript-eslint/no-inferrable-types": "off"
+  "@typescript-eslint/no-unused-vars":
+    - error
+    - argsIgnorePattern: "_"
+      varsIgnorePattern: "_"

.github/workflows/ci.yml

@@ -0,0 +1,55 @@
+name: "CI"
+
+env:
+  HARDHAT_VAR_MNEMONIC: "test test test test test test test test test test test junk"
+  HARDHAT_VAR_INFURA_API_KEY: "zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz"
+  # Uncomment the following lines to set your configuration variables using
+  # GitHub secrets (https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions)
+  #
+  # HARDHAT_VAR_MNEMONIC: ${{ secrets.Mnemonic }}
+  # HARDHAT_VAR_INFURA_API_KEY: ${{ secrets.InfuraApiKey }}
+  # HARDHAT_VAR_ARBISCAN_API_KEY: ${{ secrets.ArbiscanApiKey }}
+  # HARDHAT_VAR_BSCSCAN_API_KEY: ${{ secrets.BscscanApiKey }}
+  # HARDHAT_VAR_ETHERSCAN_API_KEY: ${{ secrets.EtherscanApiKey }}
+  # HARDHAT_VAR_OPTIMISM_API_KEY: ${{ secrets.OptimismApiKey }}
+  # HARDHAT_VAR_POLYGONSCAN_API_KEY: ${{ secrets.PolygonscanApiKey }}
+  # HARDHAT_VAR_SNOWTRACE_API_KEY: ${{ secrets.SnowtraceApiKey }}
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: "ubuntu-latest"
+    steps:
+      - name: "Check out the repo"
+        uses: "actions/checkout@v4"
+
+      - name: "Install Bun"
+        uses: "oven-sh/setup-bun@v1"
+
+      - name: "Install the dependencies"
+        run: "bun install"
+
+      # - name: "Lint the code"
+      #   run: "bun run lint"
+
+      # - name: "Add lint summary"
+      #   run: |
+      #     echo "## Lint results" >> $GITHUB_STEP_SUMMARY
+      #     echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+      - name: "Compile the contracts and generate the TypeChain bindings"
+        run: "bun run typechain"
+
+      - name: "Test the contracts and generate the coverage report"
+        run: "bun run coverage"
+
+      - name: "Add test summary"
+        run: |
+          echo "## Test results" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -0,0 +1,22 @@
+# directories
+.coverage_artifacts
+.coverage_cache
+.coverage_contracts
+artifacts
+build
+cache
+coverage
+dist
+node_modules
+types
+deployments
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+coverage.json
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

.prettierignore

@@ -0,0 +1,22 @@
+# directories
+.coverage_artifacts
+.coverage_cache
+.coverage_contracts
+artifacts
+build
+cache
+coverage
+dist
+node_modules
+types
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+bun.lockb
+coverage.json
+package-lock.json
+pnpm-lock.yaml
+yarn.lock

.prettierrc.yml

@@ -0,0 +1,23 @@
+bracketSpacing: true
+plugins:
+  - "@trivago/prettier-plugin-sort-imports"
+  - "prettier-plugin-solidity"
+printWidth: 120
+proseWrap: "always"
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+
+overrides:
+  - files: "*.sol"
+    options:
+      compiler: "0.8.17"
+      parser: "solidity-parse"
+      tabWidth: 4
+  - files: "*.ts"
+    options:
+      importOrder: ["<THIRD_PARTY_MODULES>", "^[./]"]
+      importOrderParserPlugins: ["typescript"]
+      importOrderSeparation: true
+      importOrderSortSpecifiers: true
+      parser: "typescript"

.solcover.js

@@ -0,0 +1,4 @@
+module.exports = {
+  istanbulReporter: ["html", "lcov"],
+  skipFiles: ["test"],
+};

.solhint.json

@@ -0,0 +1,19 @@
+{
+  "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],
+    "named-parameters-mapping": "warn",
+    "no-console": "off",
+    "not-rely-on-time": "off",
+    "prettier/prettier": [
+      "error",
+      {
+        "endOfLine": "auto"
+      }
+    ]
+  }
+}

.solhintignore

@@ -0,0 +1,3 @@
+# directories
+**/artifacts
+**/node_modules

.vscode/extensions.json

@@ -0,0 +1,3 @@
+{
+  "recommendations": ["esbenp.prettier-vscode", "NomicFoundation.hardhat-solidity"]
+}

.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+  "editor.defaultFormatter": "esbenp.prettier-vscode",
+  "editor.formatOnSave": true,
+  "prettier.documentSelectors": ["**/*.sol"],
+  "solidity.formatter": "prettier",
+  "typescript.tsdk": "node_modules/typescript/lib"
+}

LICENSE.md

@@ -0,0 +1,16 @@
+MIT License
+
+Copyright (c) 2024 Gnosis Guild
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the
+Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,126 @@
+# Eip712Signer [![Open in Gitpod][gitpod-badge]][gitpod] [![Github Actions][gha-badge]][gha] [![Hardhat][hardhat-badge]][hardhat] [![License: MIT][license-badge]][license]
+
+[gitpod]: https://gitpod.io/#https://github.com/gnosisguild/eip712-signer
+[gitpod-badge]: https://img.shields.io/badge/Gitpod-Open%20in%20Gitpod-FFB45B?logo=gitpod
+[gha]: https://github.com/gnosisguild/eip712-signer/actions
+[gha-badge]: https://github.com/gnosisguild/eip712-signer/actions/workflows/ci.yml/badge.svg
+[hardhat]: https://hardhat.org/
+[hardhat-badge]: https://img.shields.io/badge/Built%20with-Hardhat-FFDB1C.svg
+[license]: https://opensource.org/licenses/MIT
+[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
+
+An adapter contract to plug in front of the Safe SignMessageLib, producing EIP-712 signatures for Snapshot votes
+
+## Audits
+
+⚠️ This project is unaudited.
+
+## Security and Liability
+
+All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+PURPOSE.
+
+## Deployments
+
+Address: `0x`
+
+- [Sepolia](https://sepolia.etherscan.io/address/0xa58Cf66d0f14AEFb2389c6998f6ad219dd4885c1#code)
+- [Arbitrum](https://arbiscan.io/address/0xa58Cf66d0f14AEFb2389c6998f6ad219dd4885c1#code)
+
+(forwarding to `SignMessageLib` at `0xd53cd0aB83D845Ac265BE939c57F53AD838012c9`)
+
+## Usage
+
+### Pre Requisites
+
+First, you need to install the dependencies:
+
+```sh
+$ bun install
+```
+
+Then, you need to set up all the required env variable. Create a `.env` file based on `.env.example`.
+
+### Compile
+
+Compile the smart contracts with Hardhat:
+
+```sh
+$ bun run compile
+```
+
+### TypeChain
+
+Compile the smart contracts and generate TypeChain bindings:
+
+```sh
+$ bun run typechain
+```
+
+### Test
+
+Run the tests with Hardhat:
+
+```sh
+$ bun run test
+```
+
+### Lint Solidity
+
+Lint the Solidity code:
+
+```sh
+$ bun run lint:sol
+```
+
+### Lint TypeScript
+
+Lint the TypeScript code:
+
+```sh
+$ bun run lint:ts
+```
+
+### Coverage
+
+Generate the code coverage report:
+
+```sh
+$ bun run coverage
+```
+
+### Report Gas
+
+See the gas usage per unit test and average gas per method call:
+
+```sh
+$ REPORT_GAS=true bun run test
+```
+
+### Clean
+
+Delete the smart contract artifacts, the coverage reports and the Hardhat cache:
+
+```sh
+$ bun run clean
+```
+
+### Deploy
+
+Deploy the contract:
+
+```sh
+$ bun run deploy <network>
+```
+
+Currently the following values for `<network>` are supported:
+
+- `hardhat`
+- `mainnet`
+- `sepolia`
+- `gnosis`
+- `arbitrum`
+
+## License
+
+This project is licensed under MIT.