Feature/held fee unlocking

.example.env

@@ -1,2 +1,19 @@
 ETHERSCAN_API_KEY=
-INFURA_ID=
+
+# the deployer address, when using a ledger or a seed phrase
+SENDER_ETHEREUM_MAINNET=
+SENDER_ETHEREUM_GOERLI=
+SENDER_ETHEREUM_SEPOLIA=
+SENDER_OPTIMISM_MAINNET=
+SENDER_OPTIMISM_TESTNET=
+SENDER_POLYGON_MAINNET=
+SENDER_POLYGON_MUMBAI=
+
+# public rpc:
+RPC_ETHEREUM_MAINNET="https://rpc.ankr.com/eth"
+RPC_ETHEREUM_GOERLI="https://rpc.ankr.com/eth_goerli"
+RPC_ETHEREUM_SEPOLIA="https://rpc.ankr.com/eth_sepolia"
+RPC_OPTIMISM_MAINNET="https://rpc.ankr.com/optimism"
+RPC_OPTIMISM_TESTNET="https://sepolia.optimism.io"
+RPC_POLYGON_MAINNET="https://rpc.ankr.com/polygon"
+RPC_POLYGON_MUMBAI="https://rpc.ankr.com/polygon_mumbai"

.github/pull_request_template.md

@@ -0,0 +1,20 @@
+# Description
+
+*What does this PR: do, how, why?*
+
+## Limitations & risks
+
+*Are there any trade-off or new vulnarbility surface based on theses changes?*
+
+# Check-list
+- [ ] Tests are covering the new feature
+- [ ] Code is [natspec'd](https://docs.soliditylang.org/en/v0.8.17/natspec-format.html)
+- [ ] Code is [linted and formatted](https://docs.soliditylang.org/en/v0.8.17/style-guide.html)
+- [ ] I have run the test locally (and they pass)
+- [ ] I have rebased to the latest main commit (and tests still pass)
+
+# Interactions
+These changes will impact the following contracts:
+- Directly:
+
+- Indirectly:

.github/workflows/unit-test.yml → .github/workflows/lint.yml

@@ -1,4 +1,4 @@
-name: juice-contracts-tests
+name: juice-contracts-template-lint
 on:
   pull_request:
     branches:
@@ -7,10 +7,12 @@ on:
     branches:
       - main
 jobs:
-  unit-test:
+  forge-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v1
+      - uses: actions/checkout@v2
+        with:
+          submodules: recursive
       - uses: actions/setup-node@v1
         with:
           node-version: 14
@@ -35,10 +37,9 @@ jobs:
           key: ${{ runner.os }}-${{ steps.nvm.outputs.NVMRC }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
           restore-keys: |
             ${{ runner.os }}-${{ steps.nvm.outputs.NVMRC }}-nodemodules-
-      - name: Install JS dependencies
-        if: |
-          steps.cache-yarn-cache.outputs.cache-hit != 'true' ||
-          steps.cache-node-modules.outputs.cache-hit != 'true'
-        run: yarn install --frozen-lockfile --prefer-offline
-      - name: Run unit tests
-        run: node --max-old-space-size=4096 --require esm ./node_modules/.bin/hardhat test --network hardhat
+      - name: Install Foundry
+        uses: onbjerg/foundry-toolchain@v1
+        with:
+          version: nightly
+      - name: Check linting
+        run: forge fmt --check

.github/workflows/system-test.yml

@@ -1,56 +1,25 @@
-name: juice-contracts-system-tests
+name: juice-contracts-template-tests
 on:
   pull_request:
     branches:
       - main
-      - test/system-tests
   push:
     branches:
       - main
-      - test/system-tests
 jobs:
   forge-test:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
           submodules: recursive
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-      - name: Restore cached yarn cache
-        uses: actions/cache@v2
-        id: cache-yarn-cache
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-      - name: Restore cached node_modules
-        id: cache-node-modules
-        uses: actions/cache@v2
-        with:
-          path: |
-            ./node_modules
-            ./packages/hardhat/node_modules
-          key: ${{ runner.os }}-${{ steps.nvm.outputs.NVMRC }}-nodemodules-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-${{ steps.nvm.outputs.NVMRC }}-nodemodules-
       - name: Install Foundry
         uses: onbjerg/foundry-toolchain@v1
         with:
           version: nightly
-      - name: Install JS dependencies
-        if: |
-          steps.cache-yarn-cache.outputs.cache-hit != 'true' ||
-          steps.cache-node-modules.outputs.cache-hit != 'true'
-        run: yarn install --frozen-lockfile --prefer-offline
       - name: install libraries
         run: git submodule update --init
-      - name: Run system tests (JBControllerV3)
-        run: JBX_CONTROLLER_VERSION=3_0 forge build --sizes && forge test
-      - name: Run system tests (JBControllerV3_1)
-        run: JBX_CONTROLLER_VERSION=3_1 forge build --sizes && forge test
+      - name: Run tests
+        run: FOUNDRY_PROFILE=default forge snapshot # TODO: Change to fork once fork tests can be run
+      - name: Check contract sizes
+        run: forge build --sizes

.gitignore

@@ -17,7 +17,11 @@ deployments/localhost/**
 # Code coverage reports
 coverage/
 coverage.json
+lcov.info
 
 # VSCode
 workspace.code-workspace
 .vscode/
+
+backup/
+.secret

.gitmodules

@@ -3,11 +3,17 @@
 	url = https://github.com/smartcontractkit/chainlink
 [submodule "lib/prb-math"]
 	path = lib/prb-math
-	url = https://github.com/hifi-finance/prb-math
+	url = https://github.com/PaulRBerg/prb-math
 [submodule "lib/openzeppelin-contracts"]
 	path = lib/openzeppelin-contracts
 	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/permit2"]
+	path = lib/permit2
+	url = https://github.com/Uniswap/permit2
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
 	branch = v1.3.0
+[submodule "lib/ds-test"]
+	path = lib/ds-test
+	url = https://github.com/dapphub/ds-test

.npmignore

@@ -7,8 +7,7 @@
 !/deployments/sepolia/**
 
 # Allow everything in /contracts ...
-!/contracts/**
-# ... except tests
-/contracts/test/**
-/contracts/system_tests/**
-/foundry.toml
+!/src/**
+
+# Should we be ignoring this?
+/foundry.toml

.vscode/settings.json

@@ -1,7 +1,8 @@
 {
-  "solidity.compileUsingRemoteVersion": "v0.8.16+commit.07a7930e",
+  "solidity.compileUsingRemoteVersion": "v0.8.23",
   "editor.formatOnSave": true,
-  "[javascript]": {
-    "editor.tabSize": 2
-  }
+  "[solidity]": {
+    "editor.defaultFormatter": "JuanBlanco.solidity"
+  },
+  "solidity.formatter": "forge"
 }