feat: v3.0.3 (#201)

* chore: updgrade ape

* build: allow max uint (#204)

* build: allow max uint

* fix: lint version

* forge install: openzeppelin-contracts

v4.9.5

* chore: oz sub module

* forge install: tokenized-strategy

v3.0.2

* test: fix foundry tests

* chore: bump version

* fix: workflow (#207)

* chore: update wf version

* chore: add statemind report

* feat: update name and symbol (#206)

* feat: set name and symbol

* chore: spech

* test: fix emergency

* fix: test workflow (#208)

* fix: config override

* chore: manual setup

* fix: requirements

* fix: ape version

* chore: rebase

* chore: dont double pull from storage (#212)

* feat: report on self (#205)

* feat: report on self

* chore: comment

* chore: add back

* build: auto allocate (#203)

* build: auto allocate

* build: dont revert debt increase

* chore: remove decrease revert

* chore: update spech

* chore: spech

* chore: comments

* fix: event

* fix: comments

Co-authored-by: spalen0 <[email protected]>

* feat: pack pf config (#211)

* feat: pack pf config

* chore: remove event

* chore: formatting

* test: interface updates

* chore: comments

* fix: deposit flow (#209)

* forge install: openzeppelin-contracts

v4.9.5

* chore: oz sub module

* test: fix foundry tests

* fix: deposit flow

* fix: zero total assets

* fix: flow

* test: full loss

* chore: comment

* test: add invariants

* fix: comments

* fix: user msg sender

* fix: comments

* fix: comment

* chore: add to interfaces

* fix: comments

* chore: match gov abi (#213)

* chore: deployment

* chore: deployed

---------

Co-authored-by: FP <[email protected]>
Co-authored-by: spalen0 <[email protected]>

.github/workflows/foundry.yaml

@@ -19,43 +19,16 @@ jobs:
           - ubuntu-latest
         architecture:
           - "x64"
-        python-version:
-          - "3.10"
-        node_version:
-          - 16
 
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           submodules: recursive
-
-      - name: Setup Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: ${{ matrix.python-version }}
-          architecture: ${{ matrix.architecture }}
-
-      - name: Install Ape
-        uses: ApeWorX/[email protected]
-        with:
-          python-version: '3.10'
-
-      - name: install vyper
-        run: pip install git+https://github.com/vyperlang/vyper
-
-      - name: Compile contracts
-        # Compile Ape contracts to get dependencies
-        run: ape compile --force --size
-
+
       - name: Install Vyper
         run: pip install vyper==0.3.7
 
-      - name: Use Node.js ${{ matrix.node_version }}
-        uses: actions/setup-node@v3
-        with:
-          node-version: ${{ matrix.node_version }}
-
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:

.github/workflows/lint.yaml

@@ -28,10 +28,10 @@ jobs:
         with:
           fetch-depth: 1
 
-      - name: Set up python 3.8
+      - name: Set up python 3.9
         uses: actions/setup-python@v2
         with:
-          python-version: 3.8
+          python-version: 3.9
 
       - name: Set pip cache directory path
         id: pip-cache-dir-path

.github/workflows/test.yaml

@@ -1,4 +1,4 @@
-name: Test
+name: Ape tests
 
 on:
   push:
@@ -20,12 +20,15 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - uses: ApeWorX/[email protected]
       with:
         python-version: '3.10'
 
-    - name: install vyper
-      run: pip install git+https://github.com/vyperlang/vyper
+    - name: install requirements
+      run: python3 -m pip install -r requirements.txt 
+
+    - name: install plugins
+      run: ape plugins install .
+
     - name: Compile contracts
       # TODO: Force recompiles until ape compile caching is fixed
       run: ape compile --force --size
@@ -34,7 +37,7 @@ jobs:
     - name: Setup node.js
       uses: actions/setup-node@v1
       with:
-        node-version: '16.x'
+        node-version: '18.x'
 
     - name: Install hardhat
       run: npm install hardhat

.gitignore

@@ -20,4 +20,5 @@ yarn.lock
 env
 cache/
 out/
-.gas-snapshot
+.gas-snapshot
+broadcast/

.gitmodules

@@ -4,3 +4,10 @@
 [submodule "lib/erc4626-tests"]
 	path = lib/erc4626-tests
 	url = https://github.com/a16z/erc4626-tests
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+	release = v4.9.5
+[submodule "lib/tokenized-strategy"]
+	path = lib/tokenized-strategy
+	url = https://github.com/yearn/tokenized-strategy

README.md

@@ -6,6 +6,8 @@ This repository contains the Smart Contracts for Yearns V3 vault implementation.
 
 [Vault.vy](contracts/VaultV3.vy) - The ERC4626 compliant Vault that will handle all logic associated with deposits, withdraws, strategy management, profit reporting etc.
 
+For the most updated deployment addresses see the [docs](https://docs.yearn.fi/developers/addresses/v3-contracts). And read more about V3 and how to manage your own multi strategy vault here https://docs.yearn.fi/developers/v3/overview
+
 For the V3 strategy implementation see the [Tokenized Strategy](https://github.com/yearn/tokenized-strategy) repo.
 
 ## Requirements
@@ -72,7 +74,7 @@ forge test
 
 Deployments of the Vault Factory are done using create2 to be at a deterministic address on any EVM chain.
 
-Check the [docs](https://docs.yearn.fi/developers/v3/overview) for the most updated deployment address.
+Check the [docs](https://docs.yearn.fi/developers/addresses/v3-contracts) for the most updated deployment address.
 
 Deployments on new chains can be done permissionlessly by anyone using the included script.
 ```

TECH_SPEC.md

@@ -27,9 +27,9 @@ This allows different players to deploy their own version and implement their ow
 
 ```
 Example periphery contracts: 
-- Emergency module: it receives deposits of Vault Shares and allows the contract to call the shutdown function after a certain % of total Vault Shares have been deposited
-- Debt Allocator: a smart contract that incentivize's APY / debt allocation optimization by rewarding the best debt allocation (see [yStarkDebtAllocator](https://github.com/jmonteer/ystarkdebtallocator))
-- Strategy Staking Module: a smart contract that allows players to sponsor specific strategies (so that they are added to the vault) by staking their YFI, making money if they do well and losing money if they don't.
+- Role Manager: Governance contract that holds the vaults `role_manager` position to codify vault setup and ownership guidelines. (see [RoleManager](https://github.com/yearn/vault-periphery/tree/master/contracts/Managers))
+- Debt Allocator: a smart contract that optimizes between multiple strategies based on the optimal return. (see [DebAllocators](https://github.com/yearn/vault-periphery/tree/master/contracts/debtAllocators))
+- Safety Staking Module: a smart contract that allows players to sponsor specific strategies (so that they are added to the vault) by staking their YFI, making money if they do well and losing money if they don't.
 - Deposit Limit Module: Will dynamically adjust the deposit limit based on the depositor and arbitrary conditions.
 - ...
 ```
@@ -45,6 +45,8 @@ When deploying a new vault, it requires the following parameters:
 - role_manager: account that can assign and revoke Roles
 - profit_max_unlock_time: max amount of time profit will be locked before being distributed
 
+All deployment variables besides the `asset` can be updated post deployment.
+
 ## Normal Operation
 
 ### Deposits / Mints
@@ -79,7 +81,7 @@ If totalAssets > currentDebt: the vault will record a profit
 Both loss and profit will impact strategy's debt, increasing the debt (current debt + profit) if there are profits, decreasing its debt (current debt - loss) if there are losses.
 
 #### Fees
-Fee assessment and distribution are handled by the Accountant module. 
+Fee assessment and distribution are handled by the `accountant` module. 
 
 It will report the amount of fees that need to be charged and the vault will issue shares for that amount of fees.
 
@@ -127,11 +129,9 @@ Every role can be filled by an EOA, multi-sig or other smart contracts. Each rol
 
 The account that manages roles is a single account, set in `role_manager`.
 
-This role_manager can be an EOA, a multi-sig or a Governance Module that relays calls. 
-
-The vault comes with the ability to "open" every role. Meaning that any function that requires the caller to hold that role would be come permsissionless.
+This role_manager can be an EOA, a multi-sig or a Governance contract that relays calls. 
 
-The vault imposes no restrictions on the role managers ability to open or close any role. **But this should be done with extreme care as most of the roles are not meant to be opened and can lead to loss of funds if done incorrectly**.
+The `role_manager` can also update the vaults name and symbol as well as give out the vaults Roles.
 
 ### Strategy Management
 This responsibility is taken by callers with ADD_STRATEGY_MANAGER, REVOKE_STRATEGY_MANAGER and FORCE_REVOKE_MANAGER roles
@@ -171,6 +171,13 @@ The vault checks that the `minimumTotalIdle` parameter is respected (i.e. there'
 
 If the strategy has more debt than the max_debt, the vault will request the funds back. These funds may be locked in the strategy, which will result in the strategy returning less funds than requested by the vault. 
 
+#### Auto Allocations
+The DEBT_MANAGER can set the vaults `auto_allocate` flag to `True`.
+
+This will cause every deposit or mint call to end by the vault pushing as much debt as possible to the first strategy in the queue.
+
+NOTE: Not having at least 1 strategy in the `default_queue` with the `auto_allocate` flag will cause all deposits to revert.
+
 #### Setting maximum debt for a specific strategy
 The MAX_DEBT_MANAGER can set the maximum amount of tokens the vault will allow a strategy to owe at any moment in time.
 

ape-config.yaml

@@ -13,14 +13,13 @@ dependencies:
   - name: tokenized-strategy
     github: yearn/tokenized-strategy
     ref: v3.0.2
-    contracts_folder: src
+    config_override:
+      contracts_folder: src
 
 solidity:
   version: 0.8.18
-  import_remapping:
-    - "@openzeppelin/contracts=openzeppelin/v4.9.5"
-    - "@tokenized-strategy=tokenized-strategy/v3.0.2"
 
 ethereum:
+  evm_version: paris
   local:
     default_provider: hardhat