feat(sc_keystore): initialize smart contract template

.gitattributes

@@ -0,0 +1,3 @@
+contracts/lib/** linguist-vendored
+
+* text=auto eol=lf

.github/workflows/ci.yml

@@ -0,0 +1,132 @@
+name: "CI"
+
+env:
+  FOUNDRY_PROFILE: "ci"
+
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - "main"
+
+concurrency:
+  cancel-in-progress: true
+  group: ${{github.workflow}}-${{github.ref}}
+
+jobs:
+  lint:
+    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: "Install Pnpm"
+        uses: "pnpm/action-setup@v2"
+        with:
+          version: "8"
+
+      - name: "Install Node.js"
+        uses: "actions/setup-node@v3"
+        with:
+          cache: "pnpm"
+          node-version: "lts/*"
+
+      - name: "Install the Node.js dependencies"
+        run: "pnpm install"
+        working-directory: "contracts"
+
+      - name: "Lint the contracts"
+        run: "pnpm lint"
+        working-directory: "contracts"
+
+      - name: "Add lint summary"
+        run: |
+          echo "## Lint result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Passed" >> $GITHUB_STEP_SUMMARY
+
+  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: "Build the contracts and print their size"
+        run: "forge build --sizes"
+        working-directory: "contracts"
+
+      - name: "Add build summary"
+        run: |
+          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: "Show the Foundry config"
+        run: "forge config"
+        working-directory: "contracts"
+
+      - name: "Generate a fuzz seed that changes weekly to avoid burning through RPC allowance"
+        run: >
+          echo "FOUNDRY_FUZZ_SEED=$(
+            echo $(($EPOCHSECONDS - $EPOCHSECONDS % 604800))
+          )" >> $GITHUB_ENV
+
+      - name: "Run the tests"
+        run: "forge test"
+        working-directory: "contracts"
+
+      - name: "Add test summary"
+        run: |
+          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 using the unit and the integration tests"
+        run: 'forge coverage --match-path "test/**/*.sol" --report lcov'
+        working-directory: "contracts"
+
+      - name: "Upload coverage report to Codecov"
+        uses: "codecov/codecov-action@v3"
+        with:
+          files: "./contracts/lcov.info"
+
+      - name: "Add coverage summary"
+        run: |
+          echo "## Coverage result" >> $GITHUB_STEP_SUMMARY
+          echo "✅ Uploaded to Codecov" >> $GITHUB_STEP_SUMMARY
+
+    strategy:
+      fail-fast: false
+      max-parallel: 16

.gitignore

@@ -15,3 +15,24 @@ Cargo.lock
 
 .DS_Store
 src/.DS_Store
+
+## contracts
+# directories
+cache
+node_modules
+out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+yarn.lock
+
+# broadcasts
+!broadcast
+broadcast/*
+broadcast/*/31337/
+
+.certora_internal

.gitmodules

@@ -0,0 +1,4 @@
+[submodule "lib/forge-std"]
+  branch = "v1"
+	path = contracts/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

contracts/.editorconfig

@@ -0,0 +1,19 @@
+# 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
+
+[*.tree]
+indent_size = 1

contracts/.env.example

@@ -0,0 +1,4 @@
+export API_KEY_INFURA="YOUR_API_KEY_INFURA"
+export API_KEY_ETHERSCAN="YOUR_API_KEY_ETHERSCAN"
+export MNEMONIC="YOUR_MNEMONIC"
+export FOUNDRY_PROFILE="default"

contracts/.gas-report

@@ -0,0 +1,18 @@
+| script/Deploy.s.sol:Deploy contract |                 |        |        |        |         |
+|-------------------------------------|-----------------|--------|--------|--------|---------|
+| Deployment Cost                     | Deployment Size |        |        |        |         |
+| 320782                              | 2729            |        |        |        |         |
+| Function Name                       | min             | avg    | median | max    | # calls |
+| run                                 | 221942          | 221942 | 221942 | 221942 | 1       |
+
+
+| src/Foo.sol:Foo contract |                 |     |        |     |         |
+|--------------------------|-----------------|-----|--------|-----|---------|
+| Deployment Cost          | Deployment Size |     |        |     |         |
+| 20275                    | 131             |     |        |     |         |
+| Function Name            | min             | avg | median | max | # calls |
+| id                       | 235             | 235 | 235    | 235 | 1       |
+
+
+
+

contracts/.gas-snapshot

@@ -0,0 +1 @@
+FooTest:test_Example() (gas: 8662)

contracts/.prettierignore

@@ -0,0 +1,18 @@
+# directories
+broadcast
+cache
+lib
+node_modules
+out
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+package-lock.json
+pnpm-lock.yaml
+yarn.lock
+
+slither.config.json

contracts/.prettierrc.yml

@@ -0,0 +1,7 @@
+bracketSpacing: true
+printWidth: 120
+proseWrap: "always"
+singleQuote: false
+tabWidth: 2
+trailingComma: "all"
+useTabs: false

contracts/.solhint.json

@@ -0,0 +1,13 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "code-complexity": ["error", 8],
+    "compiler-version": ["error", ">=0.8.19"],
+    "func-name-mixedcase": "off",
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "max-line-length": ["error", 120],
+    "named-parameters-mapping": "warn",
+    "no-console": "off",
+    "not-rely-on-time": "off"
+  }
+}

contracts/README.md

@@ -0,0 +1,123 @@
+# de-mls contracts
+
+[gha]: https://github.com/vacp2p/de-mls/actions
+[gha-badge]: https://github.com/vacp2p/de-mls/actions/workflows/ci.yml/badge.svg
+[foundry]: https://getfoundry.sh/
+[foundry-badge]: https://img.shields.io/badge/Built%20with-Foundry-FFDB1C.svg
+[license]: https://opensource.org/licenses/MIT
+[license-badge]: https://img.shields.io/badge/License-MIT-blue.svg
+
+
+## What's Inside
+
+- [Forge](https://github.com/foundry-rs/foundry/blob/master/forge): compile, test, fuzz, format, and deploy smart
+  contracts
+- [Forge Std](https://github.com/foundry-rs/forge-std): collection of helpful contracts and cheatcodes for testing
+- [Solhint Community](https://github.com/solhint-community/solhint-community): linter for Solidity code
+
+## Features
+
+This template builds upon the frameworks and libraries mentioned above, so for details about their specific features,
+please consult their respective documentation.
+
+For example, if you're interested in exploring Foundry in more detail, you should look at the
+[Foundry Book](https://book.getfoundry.sh/). In particular, you may be interested in reading the
+[Writing Tests](https://book.getfoundry.sh/forge/writing-tests.html) tutorial.
+
+## Usage
+
+This is a list of the most frequently needed commands.
+
+### Build
+
+Build the contracts:
+
+```sh
+$ forge build
+```
+
+### Clean
+
+Delete the build artifacts and cache directories:
+
+```sh
+$ forge clean
+```
+
+### Compile
+
+Compile the contracts:
+
+```sh
+$ forge build
+```
+
+### Coverage
+
+Get a test coverage report:
+
+```sh
+$ forge coverage
+```
+
+### Deploy
+
+Deploy to Anvil:
+
+```sh
+$ forge script script/Deploy.s.sol --broadcast --fork-url http://localhost:8545
+```
+
+For this script to work, you need to have a `MNEMONIC` environment variable set to a valid
+[BIP39 mnemonic](https://iancoleman.io/bip39/).
+
+For instructions on how to deploy to a testnet or mainnet, check out the
+[Solidity Scripting](https://book.getfoundry.sh/tutorials/solidity-scripting.html) tutorial.
+
+### Format
+
+Format the contracts:
+
+```sh
+$ forge fmt
+```
+
+### Gas Usage
+
+Get a gas report:
+
+```sh
+$ forge test --gas-report
+```
+
+### Lint
+
+Lint the contracts:
+
+```sh
+$ pnpm lint
+```
+
+#### Fixing linting issues
+
+For any errors in solidity files, run `forge fmt`. For errors in any other file type, run `pnpm prettier:write`.
+
+### Test
+
+Run the tests:
+
+```sh
+$ forge test
+```
+
+## Notes
+
+1. Foundry uses [git submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules) to manage dependencies. For
+   detailed instructions on working with dependencies, please refer to the
+   [guide](https://book.getfoundry.sh/projects/dependencies.html) in the book
+2. You don't have to create a `.env` file, but filling in the environment variables may be useful when debugging and
+   testing against a fork.
+
+## License
+
+This project is licensed under MIT.