feat: init qw-contracts with foundry

.env.example

@@ -0,0 +1,7 @@
+MAINNET_RPC=
+MAINNET_DEPLOYER_PK=
+
+SEPOLIA_RPC=
+SEPOLIA_DEPLOYER_PK=
+
+ETHERSCAN_API_KEY=

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.github/workflows/canary.yml

@@ -0,0 +1,54 @@
+name: Canary Release
+
+on: workflow_dispatch
+
+jobs:
+  export:
+    name: Generate Interfaces And Contracts
+    # Remove the following line if you wish to export your Solidity contracts and interfaces and publish them to NPM
+    if: false
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        export_type: ['interfaces', 'contracts']
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          registry-url: 'https://registry.npmjs.org'
+          node-version: 18.x
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Build project and generate out directory
+        run: yarn build
+
+      - name: Update version
+        run: yarn version --new-version "0.0.0-${GITHUB_SHA::8}" --no-git-tag-version
+
+      - name: Export Solidity - ${{ matrix.export_type }}
+        uses: defi-wonderland/[email protected]
+        with:
+          # Update package_name with your package name
+          package_name: 'my-cool-project'
+          out: 'out'
+          interfaces: 'src/interfaces'
+          contracts: 'src/contracts'
+          export_type: '${{ matrix.export_type }}'
+
+      - name: Publish to NPM - ${{ matrix.export_type }}
+        # Update `my-cool-project` with your package name
+        run: cd export/my-cool-project-${{ matrix.export_type }} && npm publish --access public --tag canary
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/ci.yml

@@ -0,0 +1,92 @@
+name: CI
+
+on: [push]
+
+concurrency:
+  group: ${{github.workflow}}-${{github.ref}}
+  cancel-in-progress: true
+
+env:
+  MAINNET_RPC: ${{ secrets.MAINNET_RPC }}
+  SEPOLIA_RPC: ${{ secrets.SEPOLIA_RPC }}
+
+jobs:
+  unit-tests:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --network-concurrency 1
+
+      - name: Precompile using 0.8.14 and via-ir=false
+        run: yarn build
+
+      - name: Run tests
+        shell: bash
+        run: yarn test:unit
+
+  integration-tests:
+    name: Run Integration Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --network-concurrency 1
+
+      - name: Precompile using 0.8.14 and via-ir=false
+        run: yarn build
+
+      - name: Run tests
+        run: yarn test:integration
+
+  lint:
+    name: Lint Commit Messages
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - uses: wagoid/commitlint-github-action@v5
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.x
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile --network-concurrency 1
+
+      - run: yarn lint:check

.github/workflows/release.yml

@@ -0,0 +1,53 @@
+name: Production Release
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  release:
+    name: Release
+    # Remove the following line if you wish to export your Solidity contracts and interfaces and publish them to NPM
+    if: false
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        export_type: ['interfaces', 'contracts']
+
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install Node
+        uses: actions/setup-node@v4
+        with:
+          registry-url: 'https://registry.npmjs.org'
+          node-version: 18.x
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn --frozen-lockfile
+
+      - name: Build project and generate out directory
+        run: yarn build
+
+      - name: Export Solidity - ${{ matrix.export_type }}
+        uses: defi-wonderland/[email protected]
+        with:
+          # Update package_name with your package name
+          package_name: 'my-cool-project'
+          out: 'out'
+          interfaces: 'src/interfaces'
+          contracts: 'src/contracts'
+          export_type: '${{ matrix.export_type }}'
+
+      - name: Publish to NPM - ${{ matrix.export_type }}
+        # Update `my-cool-project` with your package name
+        run: cd export/my-cool-project-${{ matrix.export_type }} && npm publish --access public --tag latest
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -0,0 +1,21 @@
+# General
+yarn-error.log
+node_modules
+.DS_STORE
+.vscode
+
+# Foundry files
+cache
+out-via-ir
+
+# Config files
+.env
+
+# Avoid ignoring gitkeep
+!/**/.gitkeep
+
+# Keep the latest deployment only
+broadcast/*/*/*
+
+# Out dir
+out

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/commit-msg

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

.husky/pre-commit

@@ -0,0 +1,7 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# 1. Build the contracts
+# 2. Stage build output 
+# 2. Lint and stage style improvements 
+yarn build && npx lint-staged

.solhint.json

@@ -0,0 +1,18 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["off"],
+    "constructor-syntax": "warn",
+    "quotes": ["error", "single"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "not-rely-on-time": "off",
+    "no-inline-assembly": "off",
+    "no-empty-blocks": "off",
+    "private-vars-leading-underscore": ["warn", { "strict": false }],
+    "ordering": "warn",
+    "immutable-name-snakecase": "warn",
+    "avoid-low-level-calls": "off",
+    "no-console": "off",
+    "max-line-length": ["warn", 120]
+  }
+}

.solhint.tests.json

@@ -0,0 +1,25 @@
+{
+  "extends": "solhint:recommended",
+  "rules": {
+    "compiler-version": ["off"],
+    "constructor-syntax": "warn",
+    "quotes": ["error", "single"],
+    "func-visibility": ["warn", { "ignoreConstructors": true }],
+    "not-rely-on-time": "off",
+    "func-name-mixedcase": "off",
+    "var-name-mixedcase": "off",
+    "const-name-snakecase": "off",
+    "no-inline-assembly": "off",
+    "no-empty-blocks": "off",
+    "definition-name-capwords": "off",
+    "named-parameters-function": "off",
+    "no-global-import": "off",
+    "max-states-count": "off",
+    "private-vars-leading-underscore": ["warn", { "strict": false }],
+    "ordering": "warn",
+    "immutable-name-snakecase": "warn",
+    "avoid-low-level-calls": "off",
+    "one-contract-per-file": "off",
+    "max-line-length": ["warn", 120]
+  }
+}