Initial commit

.commitlintrc

@@ -0,0 +1,29 @@
+{
+  "extends": [
+    "@commitlint/config-conventional"
+  ],
+  "rules": {
+    "subject-case": [
+      2,
+      "always",
+      "sentence-case"
+    ],
+    "type-enum": [
+      2,
+      "always",
+      [
+        "build",
+        "ci",
+        "chore",
+        "docs",
+        "feat",
+        "fix",
+        "perf",
+        "refactor",
+        "revert",
+        "style",
+        "test"
+      ]
+    ]
+  }
+}

.eslintignore

@@ -0,0 +1,7 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
+typechain
+lib/ds-test

.eslintrc

@@ -0,0 +1,27 @@
+{
+  "env": {
+    "browser": false,
+    "es2021": true,
+    "mocha": true,
+    "node": true
+  },
+  "plugins": ["@typescript-eslint"],
+  "extends": [
+    "standard",
+    "plugin:@typescript-eslint/recommended",
+    "plugin:prettier/recommended",
+    "plugin:node/recommended"
+  ],
+  "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "ecmaVersion": 12
+  },
+  "rules": {
+    "node/no-unsupported-features/es-syntax": ["error", { "ignores": ["modules"] }]
+  },
+  "settings": {
+    "node": {
+      "tryExtensions": [".js", ".json", ".ts", ".d.ts"]
+    }
+  }
+}

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Create a report to help improve this repo
+title: ""
+labels: ""
+assignees: ""
+---
+
+- **Describe the bug**
+  A clear and concise description of what the bug is.
+
+- **To reproduce**
+  Steps to reproduce the behavior:
+
+  1. Go to '...'
+  2. Click on '....'
+  3. Scroll down to '....'
+  4. See error
+
+- **Expected behavior**
+  A clear and concise description of what you expected to happen.
+
+- **Additional context**
+  Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,19 @@
+---
+name: Feature request
+about: Suggest an idea for this repo
+title: ""
+labels: ""
+assignees: ""
+---
+
+- **Is your feature request related to a problem? Please describe.**
+  A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+- **Describe the solution you'd like**
+  A clear and concise description of what you want to happen.
+
+- **Describe alternatives you've considered**
+  A clear and concise description of any alternative solutions or features you've considered.
+
+- **Additional context**
+  Add any other context or screenshots about the feature request here.

.github/workflows/checks.yaml

@@ -0,0 +1,36 @@
+name: Format and lint checks
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  format:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14.x
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Run format checks
+        run: yarn format:check
+      - name: Run lint
+        run: yarn lint

.github/workflows/tests.yaml

@@ -0,0 +1,42 @@
+name: Tests
+
+on:
+  pull_request:
+  push:
+    branches:
+      - master
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          submodules: recursive
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 14.x
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - uses: actions/cache@v2
+        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
+          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-yarn-
+      - name: Install dev dependencies
+        run: yarn install --frozen-lockfile
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+      - name: Compile code (Hardhat)
+        run: yarn compile:force
+      - name: Run TypeScript/Waffle tests
+        run: yarn test
+      - name: Run Solidity/Forge tests
+        run: forge test

.gitignore

@@ -0,0 +1,15 @@
+node_modules
+.env
+.env*
+coverage
+coverage.json
+typechain
+.DS_Store
+
+# Hardhat files
+cache
+artifacts
+abis/
+
+# Others 
+lib

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "lib/ds-test"]
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint
+yarn format:check

.npmignore

@@ -0,0 +1,18 @@
+node_modules
+.env
+.env*
+coverage
+coverage.json
+typechain
+
+# Hardhat files
+cache
+artifacts
+
+hardhat.config.ts
+contracts/test
+test/
+
+# Others 
+lib
+.DS_Store

.prettierignore

@@ -0,0 +1,7 @@
+node_modules
+artifacts
+cache
+coverage*
+gasReporterOutput.json
+typechain
+lib/ds-test

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 120
+}

.solcover.js

@@ -0,0 +1,7 @@
+module.exports = {
+  silent: true,
+  measureStatementCoverage: true,
+  measureFunctionCoverage: true,
+  skipFiles: ["interfaces", "test"],
+  configureYulOptimizer: true,
+};

.solhint.json

@@ -0,0 +1,10 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["error", "^0.8.0"],
+    "func-visibility": [{ "ignoreConstructors": true }],
+    "func-name-mixedcase": "off",
+    "reason-string": "off",
+    "var-name-mixedcase": "off"
+  }
+}

.solhintignore

@@ -0,0 +1,4 @@
+node_modules
+test
+demo.sol 
+*.t.sol

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "editor.formatOnSave": true
+}

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 LooksRare
+
+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,46 @@
+# Solidity template
+
+This is a template for GitHub repos with Solidity smart contracts using Forge and Hardhat. This template is used by the LooksRare team for Solidity-based repos. Feel free to use or get inspired to build your own templates!
+
+## About this repo
+
+### Structure
+
+It is a hybrid [Hardhat](https://hardhat.org/) repo that also requires [Foundry](https://book.getfoundry.sh/index.html) to run Solidity tests powered by the [ds-test library](https://github.com/dapphub/ds-test/).
+
+> To install Foundry, please follow the instructions [here](https://book.getfoundry.sh/getting-started/installation.html).
+
+### Run tests
+
+- TypeScript tests are included in the `test` folder at the root of this repo.
+- Solidity tests are included in the `test` folder in the `contracts` folder.
+
+### Example of Foundry/Forge commands
+
+```shell
+forge build
+forge test
+forge test -vv
+forge tree
+```
+
+### Example of Hardhat commands
+
+```shell
+npx hardhat accounts
+npx hardhat compile
+npx hardhat clean
+npx hardhat test
+npx hardhat node
+npx hardhat help
+REPORT_GAS=true npx hardhat test
+npx hardhat coverage
+npx hardhat run scripts/deploy.ts
+TS_NODE_FILES=true npx ts-node scripts/deploy.ts
+npx eslint '**/*.{js,ts}'
+npx eslint '**/*.{js,ts}' --fix
+npx prettier '**/*.{json,sol,md}' --check
+npx prettier '**/*.{json,sol,md}' --write
+npx solhint 'contracts/**/*.sol'
+npx solhint 'contracts/**/*.sol' --fix
+```

contracts/Greeter.sol

@@ -0,0 +1,18 @@
+//SPDX-License-Identifier: Unlicense
+pragma solidity ^0.8.0;
+
+contract Greeter {
+    string private greeting;
+
+    constructor(string memory _greeting) {
+        greeting = _greeting;
+    }
+
+    function greet() public view returns (string memory) {
+        return greeting;
+    }
+
+    function setGreeting(string memory _greeting) public {
+        greeting = _greeting;
+    }
+}