feat(sc_keystore): initialize smart contract template (#8)

* feat(sc_keystore): initialize smart contract template

* fix: submodule

* fix: gitignore and readme

.gitattributes

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

.github/workflows/ci.yml

@@ -0,0 +1,131 @@
+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:
+          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
+contracts/cache/**
+contracts/node_modules/**
+contracts/out/**
+
+# files
+*.env
+*.log
+.DS_Store
+.pnp.*
+lcov.info
+yarn.lock
+
+# broadcasts
+!broadcast
+broadcast/*
+broadcast/*/31337/
+
+.certora_internal

.gitmodules

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

Makefile

@@ -0,0 +1,3 @@
+deps:
+	# for the contracts
+	git submodule update --init --recursive

README.md

@@ -1,2 +1,7 @@
 # de-mls
 Decentralized MLS PoC using a smart contract for group coordination
+
+## Install deps
+
+1. `Foundry`
+2. `make deps`

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-snapshot

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

contracts/.gitmodules

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

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,122 @@
+# 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.

contracts/codecov.yml

@@ -0,0 +1,28 @@
+codecov:
+  require_ci_to_pass: false
+comment: false
+ignore:
+  - "script"
+  - "test"
+coverage:
+  status:
+    project:
+      default:
+        # advanced settings
+
+        # Prevents PR from being blocked with a reduction in coverage.
+        # Note, if we want to re-enable this, a `threshold` value can be used
+        # allow coverage to drop by x% while still posting a success status.
+        # `informational`: https://docs.codecov.com/docs/commit-status#informational
+        # `threshold`: https://docs.codecov.com/docs/commit-status#threshold
+        informational: true
+    patch:
+      default:
+        # advanced settings
+
+        # Prevents PR from being blocked with a reduction in coverage.
+        # Note, if we want to re-enable this, a `threshold` value can be used
+        # allow coverage to drop by x% while still posting a success status.
+        # `informational`: https://docs.codecov.com/docs/commit-status#informational
+        # `threshold`: https://docs.codecov.com/docs/commit-status#threshold
+        informational: true

contracts/foundry.toml

@@ -0,0 +1,38 @@
+# Full reference https://github.com/foundry-rs/foundry/tree/master/config
+
+[profile.default]
+  auto_detect_solc = false
+  block_timestamp = 1_680_220_800 # March 31, 2023 at 00:00 GMT
+  bytecode_hash = "none"
+  cbor_metadata = false
+  evm_version = "paris"
+  fuzz = { runs = 1_000 }
+  gas_reports = ["*"]
+  libs = ["lib"]
+  optimizer = true
+  optimizer_runs = 10_000
+  out = "out"
+  script = "script"
+  solc = "0.8.19"
+  src = "src"
+  test = "test"
+
+[profile.ci]
+  fuzz = { runs = 10_000 }
+  verbosity = 4
+
+[etherscan]
+  sepolia = { key = "${API_KEY_ETHERSCAN}" }
+
+[fmt]
+  bracket_spacing = true
+  int_types = "long"
+  line_length = 120
+  multiline_func_header = "all"
+  number_underscore = "thousands"
+  quote_style = "double"
+  tab_width = 4
+  wrap_comments = true
+
+[rpc_endpoints]
+  sepolia = "https://sepolia.infura.io/v3/${API_KEY_INFURA}"

contracts/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@vacp2p/de-mls-contracts",
+  "description": "Foundry-based contracts for de-mls",
+  "version": "1.0.0",
+  "devDependencies": {
+    "prettier": "^3.0.0",
+    "solhint-community": "^3.6.0",
+    "commit-and-tag-version": "^12.2.0"
+  },
+  "keywords": [
+    "blockchain",
+    "ethereum",
+    "forge",
+    "foundry",
+    "smart-contracts",
+    "solidity",
+    "template"
+  ],
+  "private": true,
+  "scripts": {
+    "clean": "rm -rf cache out",
+    "lint": "pnpm lint:sol && pnpm prettier:check",
+    "verify": "certoraRun certora/certora.conf",
+    "lint:sol": "forge fmt --check && pnpm solhint {script,src,test,certora}/**/*.sol",
+    "prettier:check": "prettier --check **/*.{json,md,yml} --ignore-path=.prettierignore",
+    "prettier:write": "prettier --write **/*.{json,md,yml} --ignore-path=.prettierignore",
+    "gas-report": "forge test --gas-report 2>&1 | (tee /dev/tty | awk '/Test result:/ {found=1; buffer=\"\"; next} found && !/Ran/ {buffer=buffer $0 ORS} /Ran/ {found=0} END {printf \"%s\", buffer}' > .gas-report)",
+    "release": "commit-and-tag-version",
+    "adorno": "pnpm prettier:write && forge fmt && forge snapshot && pnpm gas-report"
+  }
+}

contracts/remappings.txt

@@ -0,0 +1 @@
+forge-std/=lib/forge-std/src/

contracts/script/Base.s.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { Script } from "forge-std/Script.sol";
+
+abstract contract BaseScript is Script {
+    /// @dev Included to enable compilation of the script without a $MNEMONIC environment variable.
+    string internal constant TEST_MNEMONIC = "test test test test test test test test test test test junk";
+
+    /// @dev Needed for the deterministic deployments.
+    bytes32 internal constant ZERO_SALT = bytes32(0);
+
+    /// @dev The address of the transaction broadcaster.
+    address internal broadcaster;
+
+    /// @dev Used to derive the broadcaster's address if $ETH_FROM is not defined.
+    string internal mnemonic;
+
+    /// @dev Initializes the transaction broadcaster like this:
+    ///
+    /// - If $ETH_FROM is defined, use it.
+    /// - Otherwise, derive the broadcaster address from $MNEMONIC.
+    /// - If $MNEMONIC is not defined, default to a test mnemonic.
+    ///
+    /// The use case for $ETH_FROM is to specify the broadcaster key and its address via the command line.
+    constructor() {
+        address from = vm.envOr({ name: "ETH_FROM", defaultValue: address(0) });
+        if (from != address(0)) {
+            broadcaster = from;
+        } else {
+            mnemonic = vm.envOr({ name: "MNEMONIC", defaultValue: TEST_MNEMONIC });
+            (broadcaster,) = deriveRememberKey({ mnemonic: mnemonic, index: 0 });
+        }
+    }
+
+    modifier broadcast() {
+        vm.startBroadcast(broadcaster);
+        _;
+        vm.stopBroadcast();
+    }
+}

contracts/script/Deploy.s.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { Foo } from "../src/Foo.sol";
+import { BaseScript } from "./Base.s.sol";
+import { DeploymentConfig } from "./DeploymentConfig.s.sol";
+
+contract Deploy is BaseScript {
+    function run() public returns (Foo foo, DeploymentConfig deploymentConfig) {
+        deploymentConfig = new DeploymentConfig(broadcaster);
+        foo = new Foo();
+    }
+}

contracts/script/DeploymentConfig.s.sol

@@ -0,0 +1,39 @@
+//// SPDX-License-Identifier: UNLICENSED
+
+pragma solidity >=0.8.19 <=0.9.0;
+
+import { Script } from "forge-std/Script.sol";
+
+contract DeploymentConfig is Script {
+    error DeploymentConfig_InvalidDeployerAddress();
+    error DeploymentConfig_NoConfigForChain(uint256);
+
+    struct NetworkConfig {
+        address deployer;
+    }
+
+    NetworkConfig public activeNetworkConfig;
+
+    address private deployer;
+
+    constructor(address _broadcaster) {
+        if (_broadcaster == address(0)) revert DeploymentConfig_InvalidDeployerAddress();
+        deployer = _broadcaster;
+        if (block.chainid == 31_337) {
+            activeNetworkConfig = getOrCreateAnvilEthConfig();
+        } else {
+            revert DeploymentConfig_NoConfigForChain(block.chainid);
+        }
+    }
+
+    function getOrCreateAnvilEthConfig() public view returns (NetworkConfig memory) {
+        return NetworkConfig({ deployer: deployer });
+    }
+
+    // This function is a hack to have it excluded by `forge coverage` until
+    // https://github.com/foundry-rs/foundry/issues/2988 is fixed.
+    // See: https://github.com/foundry-rs/foundry/issues/2988#issuecomment-1437784542
+    // for more info.
+    // solhint-disable-next-line
+    function test() public { }
+}

contracts/slither.config.json

@@ -0,0 +1,8 @@
+{
+  "detectors_to_exclude": "naming-convention,reentrancy-events,solc-version,timestamp",
+  "filter_paths": "(lib|test)",
+  "solc_remaps": [
+    "@openzeppelin/contracts=lib/openzeppelin-contracts/contracts/",
+    "forge-std/=lib/forge-std/src/"
+  ]
+}

contracts/src/Foo.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.19;
+
+contract Foo {
+    function id(uint256 value) external pure returns (uint256) {
+        return value;
+    }
+}

contracts/test/Foo.t.sol

@@ -0,0 +1,26 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity >=0.8.19 <0.9.0;
+
+import { Test, console } from "forge-std/Test.sol";
+
+import { Deploy } from "../script/Deploy.s.sol";
+import { DeploymentConfig } from "../script/DeploymentConfig.s.sol";
+import { Foo } from "../src/Foo.sol";
+
+contract FooTest is Test {
+    Foo internal foo;
+    DeploymentConfig internal deploymentConfig;
+
+    address internal deployer;
+
+    function setUp() public virtual {
+        Deploy deployment = new Deploy();
+        (foo, deploymentConfig) = deployment.run();
+    }
+
+    function test_Example() external {
+        console.log("Hello World");
+        uint256 x = 42;
+        assertEq(foo.id(x), x, "value mismatch");
+    }
+}