sector-fi · 0x0scion · Nov 8, 2021 · Nov 8, 2021 · Nov 8, 2021 · Nov 9, 2021
diff --git a/.dapprc b/.dapprc
@@ -1,12 +1,16 @@
 # Basic build/test configuration.
-export DAPP_SOLC_VERSION=0.8.9
+export DAPP_SOLC_VERSION=0.8.10
 export DAPP_BUILD_OPTIMIZE=1
-export DAPP_BUILD_OPTIMIZE_RUNS=1000000
+export DAPP_BUILD_OPTIMIZE_RUNS=8000
 export DAPP_LINK_TEST_LIBRARIES=0
 export DAPP_TEST_VERBOSITY=1
 export DAPP_TEST_SMTTIMEOUT=500000
 
-if [ "$DEEP_FUZZ" == "true" ]
+# These normally default to 0 which breaks some tests.
+export DAPP_TEST_TIMESTAMP=1000000000
+export DAPP_TEST_NUMBER=10000000
+
+if [ "$DEEP_FUZZ" = "true" ]
 then 
   export DAPP_TEST_FUZZ_RUNS=10000 # Fuzz for a long time if DEEP_FUZZ is set to true.
 else

diff --git a/.gas-snapshot b/.gas-snapshot
@@ -1,37 +1,72 @@
-testFailWithdrawFromStrategyWithNotEnoughBalance() (gas: 300443)
-testAtomicDepositRedeem() (gas: 208401)
-testAtomicEnterExitSinglePool() (gas: 387115)
-testFailDepositIntoStrategyZero() (gas: 28111)
-testFailWithdrawFromStrategyZero() (gas: 28156)
-testAtomicDepositWithdraw() (gas: 208445)
-testPushingToWithdrawalQueue() (gas: 129874)
-testFailDepositIntoStrategyWithNoBalance() (gas: 130185)
-testFailRedeemWithNotEnoughBalance() (gas: 153411)
-testUnprofitableHarvest() (gas: 522343)
-testFailDepositWithNotEnoughApproval() (gas: 121418)
-testFailDepositIntoStrategyWithNotEnoughBalance() (gas: 274096)
-testFailWithdrawFromStrategyWithNoBalance() (gas: 28413)
-testFailRedeemZero() (gas: 1184)
-testFailWithdrawWithNotEnoughBalance() (gas: 153401)
-testReplaceWithdrawalQueueIndex() (gas: 124837)
-testFailWithdrawWithIncompleteQueue() (gas: 521082)
-testProfitableHarvest() (gas: 585931)
-testFailDepositZero() (gas: 1208)
-testFailWithdrawWithNoBalance() (gas: 3564)
-testPoppingFromWithdrawalQueue() (gas: 143346)
-testFailWithdrawZero() (gas: 1163)
-testFailWithdrawFromStrategyWithoutTrust() (gas: 302863)
-testFailDepositWithNoApproval() (gas: 51113)
-testFailRedeemWithNoBalance() (gas: 3638)
-testAtomicEnterExitMultiPool() (gas: 531020)
-testReplaceWithdrawalQueueIndexWithTip() (gas: 126949)
-testFailTrustStrategyWithWrongUnderlying() (gas: 2002337)
-testSwapWithdrawalQueueIndexes() (gas: 127230)
-testFailWithdrawWithEmptyQueue() (gas: 313058)
-testFailDepositIntoNotWETHVault() (gas: 10760)
-testFailRedeemFromNotWETHVault() (gas: 245181)
-testAtomicDepositRedeemETH() (gas: 329700)
-testFailWithdrawFromNotWETHVault() (gas: 245115)
-testAtomicDepositWithdrawETH() (gas: 331361)
-testFailNoDuplicateVaults() (gas: 272747603310794)
-testDeployVault() (gas: 4749517)
+testIntegration() (gas: 5105473)
+testFailDeposit() (gas: 80992)
+testInitializeAndDeposit() (gas: 173385)
+testTrustStrategyWithWETHUnderlying() (gas: 28084)
+testTrustStrategyWithETHUnderlying() (gas: 27502)
+testAtomicDepositWithdrawIntoETHStrategies() (gas: 618638)
+testDestroyVaultReturnsETH() (gas: 13378)
+testFailWithdrawFromStrategyWithNotEnoughBalance() (gas: 298484)
+testAtomicDepositRedeem() (gas: 203256)
+testFailPushStackFull() (gas: 118311)
+testUpdatingHarvestDelay() (gas: 78825)
+testFailPopStackEmpty() (gas: 3568)
+testAtomicEnterExitSinglePool() (gas: 378899)
+testFailHarvestUntrustedStrategy() (gas: 324767)
+testAtomicDepositWithdraw() (gas: 203300)
+testFailSetStackTooBig() (gas: 5493)
+testDestroyVault() (gas: 6316)
+testFailDepositIntoStrategyWithNoBalance() (gas: 129069)
+testWithdrawingWithUntrustedStrategyInStack() (gas: 1759083)
+testFailRedeemWithNotEnoughBalance() (gas: 152131)
+testUnprofitableHarvest() (gas: 541816)
+testPoppingFromWithdrawalStack() (gas: 147691)
+testPushingToWithdrawalStack() (gas: 132102)
+testFailDepositWithNotEnoughApproval() (gas: 120370)
+testFailDepositIntoStrategyWithNotEnoughBalance() (gas: 271975)
+testSeizeStrategyWithBalanceGreaterThanTotalAssets() (gas: 482498)
+testWithdrawingWithDuplicateStrategiesInStack() (gas: 667651)
+testFailWithdrawFromStrategyWithNoBalance() (gas: 28736)
+testFailWithdrawWithEmptyStack() (gas: 310196)
+testClaimFees() (gas: 200865)
+testFailWithdrawWithNotEnoughBalance() (gas: 152145)
+testSeizeStrategy() (gas: 436037)
+testFailTrustStrategyWithETHUnderlying() (gas: 933256)
+testProfitableHarvest() (gas: 577935)
+testFailWithdrawWithIncompleteStack() (gas: 517606)
+testFailWithdrawWithNoBalance() (gas: 3628)
+testReplaceWithdrawalStackIndexWithTip() (gas: 128330)
+testReplaceWithdrawalStackIndex() (gas: 126510)
+testFailHarvestAfterWindowBeforeDelay() (gas: 471999)
+testFailInitializeTwice() (gas: 1542)
+testMultipleHarvestsInWindow() (gas: 525917)
+testFailWithdrawFromStrategyWithoutTrust() (gas: 301422)
+testFailDepositWithNoApproval() (gas: 50047)
+testFailRedeemWithNoBalance() (gas: 3635)
+testAtomicEnterExitMultiPool() (gas: 520005)
+testFailTrustStrategyWithWrongUnderlying() (gas: 1889496)
+testSwapWithdrawalStackIndexes() (gas: 128780)
+testSetDefaultTargetFloatPercent() (gas: 55620)
+testDefaultHarvestDelayOverridesCustomOfZero() (gas: 58529)
+testDefaultTargetFloatPercentOverridesCustomOfZero() (gas: 57765)
+testCustomHarvestDelayOverridesDefault() (gas: 78322)
+testSetCustomHarvestDelay() (gas: 55230)
+testCustomHarvestWindowOverridesDefault() (gas: 88769)
+testSetCustomFeePercent() (gas: 54616)
+testSetDefaultFeePercent() (gas: 55683)
+testSetCustomHarvestWindow() (gas: 86131)
+testCustomTargetFloatPercentOverridesDefault() (gas: 77607)
+testDefaultFeePercentOverridesCustomOfZero() (gas: 57860)
+testSetDefaultHarvestWindow() (gas: 66772)
+testDefaultHarvestWindowOverridesCustomOfZero() (gas: 68987)
+testSetCustomTargetFloatPercent() (gas: 54473)
+testSetDefaultHarvestDelay() (gas: 56390)
+testIsVaultDeployed() (gas: 3690)
+testFailNoDuplicateVaults() (gas: 272747603290173)
+testDeployVault() (gas: 4074195)
+testVaultCreation() (gas: 4232391)
+testSetConfigurationModule() (gas: 3498)
+testFailDepositIntoNotWETHVault() (gas: 10656)
+testFailRedeemFromNotWETHVault() (gas: 243420)
+testAtomicDepositRedeemETH() (gas: 325421)
+testFailWithdrawFromNotWETHVault() (gas: 243320)
+testAtomicDepositWithdrawETH() (gas: 326998)
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -17,6 +17,9 @@ jobs:
       - name: Install dependencies
         run: nix-shell --run 'make'
 
+      - name: Check gas snapshots
+        run: nix-shell --run 'dapp check-snapshot'
+
       - name: Run tests
         run: nix-shell --run 'dapp test'
         env:

diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,3 @@
 /out
+/cache
 /node_modules
diff --git a/.gitmodules b/.gitmodules
@@ -4,3 +4,6 @@
 [submodule "lib/solmate"]
 	path = lib/solmate
 	url = https://github.com/rari-capital/solmate
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/brockelmore/forge-std
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,9 +1,10 @@
 {
   "solidity.packageDefaultDependenciesContractsDirectory": "src",
   "solidity.packageDefaultDependenciesDirectory": "lib",
-  "solidity.compileUsingRemoteVersion": "v0.8.9",
+  "solidity.compileUsingRemoteVersion": "v0.8.10+commit.fc410830",
   "search.exclude": { "lib": true },
   "files.associations": {
-    ".dapprc": "shellscript"
+    ".dapprc": "shellscript",
+    ".gas-snapshot": "julia"
   }
 }
diff --git a/Makefile b/Makefile
@@ -1,6 +1,6 @@
 all: solc install update
 # Install proper solc version.
-solc:; nix-env -f https://github.com/dapphub/dapptools/archive/master.tar.gz -iA solc-static-versions.solc_0_8_9
+solc:; nix-env -f https://github.com/dapphub/dapptools/archive/master.tar.gz -iA solc-static-versions.solc_0_8_10
 # Install npm dependencies.
 install:; npm install
 # Install dapp dependencies.

diff --git a/README.md b/README.md
@@ -1,11 +1,51 @@
-# vaults
+# Vaults • [![Tests](https://github.com/Rari-Capital/vaults/actions/workflows/tests.yml/badge.svg)](https://github.com/Rari-Capital/vaults/actions/workflows/tests.yml) [![License](https://img.shields.io/badge/License-AGPL--3.0-blue)](LICENSE.md)
 
-Flexible, minimalist, and gas-optimized yield aggregator protocol for earning interest on any ERC20 token.
+Flexible, minimalist, and **gas-optimized yield aggregator protocol** for earning interest on any ERC20 token.
 
-## Getting Started
+- [Documentation](https://docs.rari.capital/vaults)
+- [Deployments](https://github.com/Rari-Capital/vaults/releases)
+- [Whitepaper](whitepaper/Whitepaper.pdf)
+- [Audits](audits)
+
+## Architecture
+
+- [`Vault.sol`](src/Vault.sol): Flexible, minimalist, and gas-optimized yield aggregator for earning interest on any ERC20 token.
+- [`VaultFactory.sol`](src/VaultFactory.sol): Factory which enables deploying a Vault contract for any ERC20 token.
+- [`modules/`](src/modules): Contracts used for managing and/or simplifying interaction with Vaults and the Vault Factory.
+  - [`VaultRouterModule.sol`](src/modules/VaultRouterModule.sol): Module that enables depositing ETH and approval-free deposits via permit.
+  - [`VaultConfigurationModule.sol`](src/modules/VaultConfigurationModule.sol): Module for configuring Vault parameters.
+  - [`VaultInitializationModule.sol`](src/modules/VaultInitializationModule.sol): Module for initializing newly created Vaults.
+- [`interfaces/`](src/interfaces): Interfaces of external contracts Vaults and modules interact with.
+  - [`Strategy.sol`](src/interfaces/Strategy.sol): Minimal interfaces for ERC20 and ETH compatible strategies.
+
+![Diagram](https://lucid.app/publicSegments/view/8069beaa-d2fc-48de-8f38-9e30edcb5f08/image.png)
+
+## Contributing
+
+You will need a copy of [DappTools](https://dapp.tools) installed before proceeding. See the [installation guide](https://github.com/dapphub/dapptools#installation) for details.
+
+### Setup
 
 ```sh
 git clone https://github.com/Rari-Capital/vaults.git
 cd vaults
 make
 ```
+
+### Run Tests
+
+```sh
+dapp test
+```
+
+### Measure Coverage
+
+```sh
+dapp test --coverage
+```
+
+### Update Gas Snapshots
+
+```sh
+dapp snapshot
+```
diff --git a/audits/Fixed-Point-Solutions/Vault.pdf b/audits/Fixed-Point-Solutions/Vault.pdf
diff --git a/audits/Fixed-Point-Solutions/VaultAuthorityModule.pdf b/audits/Fixed-Point-Solutions/VaultAuthorityModule.pdf
diff --git a/audits/Fixed-Point-Solutions/VaultConfigurationModule.pdf b/audits/Fixed-Point-Solutions/VaultConfigurationModule.pdf
diff --git a/audits/Fixed-Point-Solutions/VaultInitializationModule.pdf b/audits/Fixed-Point-Solutions/VaultInitializationModule.pdf
diff --git a/audits/Fixed-Point-Solutions/VaultRouterModule.pdf b/audits/Fixed-Point-Solutions/VaultRouterModule.pdf
diff --git a/audits/Quantstamp/Rari Vaults - Final Report.pdf b/audits/Quantstamp/Rari Vaults - Final Report.pdf
diff --git a/audits/yAcademy/Dhurv.Kat.Amanusk.pdf b/audits/yAcademy/Dhurv.Kat.Amanusk.pdf
diff --git a/audits/yAcademy/Nibbler.Bebis.Zokunei.Carl.pdf b/audits/yAcademy/Nibbler.Bebis.Zokunei.Carl.pdf
diff --git a/foundry.toml b/foundry.toml
@@ -0,0 +1,2 @@
+[default]
+fuzz_runs = 1000
diff --git a/lib/forge-std b/lib/forge-std
diff --git a/lib/solmate b/lib/solmate
diff --git a/scripts/contract-size.sh b/scripts/contract-size.sh
@@ -0,0 +1,32 @@
+#!/usr/bin/env bash
+
+set -eo pipefail
+
+contract_size() {
+	NAME=$1
+	ARGS=${@:2}
+	# select the filename and the contract in it
+	PATTERN=".contracts[\"src/$NAME.sol\"].$NAME"
+
+  dapp build # first, build the contract
+
+	# get the bytecode from the compiled file
+	BYTECODE=0x$(jq -r "$PATTERN.evm.bytecode.object" out/dapp.sol.json)
+	length=$(echo "$BYTECODE" | wc -m)
+	echo $(($length / 2))
+}
+
+if [[ -z $contract ]]; then
+  if [[ -z ${1} ]];then
+    echo '"$contract" env variable is not set. Set it to the name of the contract you want to estimate size for.'
+    exit 1
+  else
+    contract=${1}
+  fi
+fi
+
+contract_size=$(contract_size ${contract})
+echo "Contract Name: ${contract}"
+echo "Contract Size: ${contract_size} bytes"
+echo
+echo "$(( 24576 - ${contract_size} )) bytes left to reach the smart contract size limit of 24576 bytes."
diff --git a/shell.nix b/shell.nix
@@ -2,7 +2,7 @@ let
   pkgs = import (builtins.fetchGit rec {
     name = "dapptools-${rev}";
     url = https://github.com/dapphub/dapptools;
-    rev = "d7a23096d8ae8391e740f6bdc4e8b9b703ca4764";
+    rev = "fb9476ded759da44c449eb391cc67bfb0df61112";
   }) {};
 
 in
@@ -12,4 +12,4 @@ in
     buildInputs = with pkgs; [
       pkgs.dapp
     ];
-  }
+  }