Merge pull request #379 from primitivefinance/v1.2.0-beta

V1.2.0 beta

Author: Alexangelj

.github/workflows/ci.yaml

@@ -17,7 +17,4 @@ jobs:
           version: nightly
 
       - name: Run tests RMM01Portfolio
-        run: FOUNDRY_PROFILE=test forge test --gas-report --match-contract RMM01Portfolio
-
-      - name: Run tests RMM02Portfolio
-        run: FOUNDRY_PROFILE=test forge test --gas-report --match-contract RMM02Portfolio
+        run: FOUNDRY_PROFILE=test forge test --gas-report --match-contract TestRMM01

.github/workflows/default.yaml

@@ -20,7 +20,4 @@ jobs:
         run: FOUNDRY_PROFILE=default forge build --skip test
 
       - name: Run tests RMM01Portfolio
-        run: FOUNDRY_PROFILE=default forge test --gas-report --match-contract TestRMM01Portfolio -vvv
-
-      - name: Run tests RMM02Portfolio
-        run: FOUNDRY_PROFILE=default forge test --match-contract TestRMM02Portfolio
+        run: FOUNDRY_PROFILE=default forge test --gas-report --match-contract TestRMM01 -vvv

.github/workflows/optimized.yaml

@@ -20,10 +20,7 @@ jobs:
         run: FOUNDRY_PROFILE=optimized forge build --sizes --skip test
 
       - name: Run tests RMM01Portfolio
-        run: FOUNDRY_PROFILE=optimized forge test --match-contract TestRMM01Portfolio
-
-      - name: Run tests RMM02Portfolio
-        run: FOUNDRY_PROFILE=optimized forge test --match-contract TestRMM02Portfolio
+        run: FOUNDRY_PROFILE=optimized forge test --match-contract TestRMM01
 
       - name: Run invariant tests
         run: FOUNDRY_PROFILE=optimized forge test --gas-report --match-contract TestRMM01PortfolioInvariants -vvv

README.md

@@ -6,16 +6,17 @@ On-chain portfolio management. Optimized for managing risk and liquidity.
 
 [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/primitivefinance/portfolio#contributing) [![](https://dcbadge.vercel.app/api/server/primitive?style=flat)](https://discord.gg/primitive) [![Twitter Badge](https://badgen.net/badge/icon/twitter?icon=twitter&label)](https://twitter.com/primitivefi)
 
-## Yellow Paper
 
-A technical summary of Portfolio is detailed in the [Yellow Paper](https://www.primitive.xyz/papers/yellow.pdf).
+# Portfolio Security
+
+[Visit Primitive Security](https://www.primitive.xyz/security) to view a comprehensive overview of the security initiatives of Portfolio.
 
 ## System Invariants
 
 The system is designed around a single invariant:
 
 ```
-Balance >= Reserve
+Actual balance of tokens in contract >= virtually tracked token balance in `__account__.reserves`.
 ```
 
 Exposed via: `Portfolio.getNetBalance(token)`
@@ -63,7 +64,7 @@ forge test --match-contract TestRMM01
 
 ## Resources
 
-- [Portfolio Yellow Paper](https://www.primitive.xyz/papers/yellow.pdf)
+- [Portfolio Yellow Paper (Deprecated)](https://www.primitive.xyz/papers/yellow.pdf)
 - [RMM in desmos](https://www.desmos.com/calculator/8py0nzdgfp)
 - [Original codebase](https://github.com/primitivefinance/rmm-core)
 - [solstat](https://github.com/primitivefinance/solstat)
@@ -73,11 +74,12 @@ forge test --match-contract TestRMM01
 
 ## Audits
 
-| Security Firm | Review Time | Status    |
-| ------------- | ----------- | --------- |
-| ChainSecurity | 8-weeks     | Completed |
-| Trail of Bits | 8-weeks     | Completed |
-| Spearbit      | 5-weeks     | Completed |
+| Security Firm      | Review Time | Status    |
+| ------------------ | ----------- | --------- |
+| ChainSecurity      | 8-weeks     | Completed |
+| Trail of Bits      | 8-weeks     | Completed |
+| Spearbit           | 5-weeks     | Completed |
+| Spearbit Extension | 2-weeks     | Pending   |
 
 
 ## Contributing

contracts/Objective.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0-only
-pragma solidity 0.8.13;
+pragma solidity 0.8.19;
 
-import "./PortfolioLib.sol";
+import "./libraries/PortfolioLib.sol";
 import "./interfaces/IERC20.sol";
 import "./interfaces/IPortfolio.sol";
 import "./interfaces/IPortfolioRegistry.sol";
@@ -23,17 +23,6 @@ abstract contract Objective is IPortfolio {
         bool sellAsset
     ) internal virtual returns (bool success, int256 invariant);
 
-    /**
-     * @dev Conditional check made before changing `pool.liquidity` and `position.freeLiquidity`.
-     * @param delta Signed quantity of liquidity in WAD units to change liquidity by.
-     * @return True if position liquidity can be changed by `delta` amount.
-     */
-    function checkPosition(
-        uint64 poolId,
-        address owner,
-        int256 delta
-    ) public view virtual returns (bool);
-
     /**
      * @dev Conditional check before interacting with a pool.
      * @return True if pool exists and is ready to be interacted with.
@@ -74,14 +63,12 @@ abstract contract Objective is IPortfolio {
         uint256 price
     ) public view virtual returns (uint256 reserveX, uint256 reserveY);
 
-    /**
-     * @dev Computes an amount of tokens out given an amount in, units are in the token's decimals.
-     * @param amountIn Quantity to swap in, in native decimals.
-     */
+    /// @inheritdoc IPortfolioGetters
     function getAmountOut(
         uint64 poolId,
         bool sellAsset,
         uint256 amountIn,
+        int256 liquidityDelta,
         address swapper
     )
         public
@@ -90,13 +77,8 @@ abstract contract Objective is IPortfolio {
         override(IPortfolioGetters)
         returns (uint256 output);
 
-    /**
-     * @dev
-     * WARNING! Do not rely on this price value. This CAN be manipulated. It is also an estimate that has error.
-     * Estimates the `price` of a pool with `poolId` given the pool's reserves.
-     * @return price Estimated quantity of "Quote" tokens per "Asset" tokens in WAD units.
-     */
-    function getVirtualPrice(uint64 poolId)
+    /// @inheritdoc IPortfolioGetters
+    function getSpotPrice(uint64 poolId)
         public
         view
         virtual