feat: add setSpread to BiPoolManager (#689)

Author: nvtaveras

.github/workflows/lint_test.yaml

@@ -27,6 +27,8 @@ jobs:
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: v1.3.5
 
       - name: Install Node.js
         uses: actions/setup-node@v3

contracts/interfaces/IBiPoolManager.sol

@@ -112,6 +112,13 @@ interface IBiPoolManager {
    */
   event PricingModulesUpdated(bytes32[] newIdentifiers, address[] newAddresses);
 
+  /**
+   * @notice Emitted when the spread for a specified exchange is updated.
+   * @param exchangeId The id of the exchange
+   * @param spread The new spread
+   */
+  event SpreadUpdated(bytes32 indexed exchangeId, uint256 spread);
+
   /**
    * @notice Retrieves the pool with the specified exchangeId.
    * @param exchangeId The id of the pool to be retrieved.
@@ -223,6 +230,8 @@ interface IBiPoolManager {
 
   function setBreakerBox(IBreakerBox newBreakerBox) external;
 
+  function setSpread(bytes32 exchangeId, uint256 spread) external;
+
   /// @notice IOwnable:
   function transferOwnership(address newOwner) external;
 

contracts/swap/BiPoolManager.sol

@@ -233,6 +233,16 @@ contract BiPoolManager is IExchangeProvider, IBiPoolManager, Initializable, Owna
     emit PricingModulesUpdated(identifiers, modules);
   }
 
+  function setSpread(bytes32 exchangeId, uint256 spread) external onlyOwner {
+    require(exchanges[exchangeId].asset0 != address(0), "invalid exchangeId");
+
+    FixidityLib.Fraction memory newSpread = FixidityLib.wrap(spread);
+    require(newSpread.lte(FixidityLib.fixed1()), "spread must be <= 1");
+
+    exchanges[exchangeId].config.spread = newSpread;
+    emit SpreadUpdated(exchangeId, spread);
+  }
+
   /**
    * @notice Creates a new exchange using the given parameters.
    * @param _exchange the PoolExchange to create.

foundry.lock

@@ -0,0 +1,29 @@
+{
+  "lib/forge-std": {
+    "rev": "035de35f5e366c8d6ed142aec4ccb57fe2dd87d4"
+  },
+  "lib/foundry-chainlink-toolkit": {
+    "rev": "d610ec9ef54c325de7de1a5622c19933b2ae26cf"
+  },
+  "lib/mento-std": {
+    "rev": "cae988de9b03b6ab4811900c3c781ccbf8b8beaf"
+  },
+  "lib/openzeppelin-contracts": {
+    "rev": "58a3368215581509d05bd3ec4d53cd381c9bb40e"
+  },
+  "lib/openzeppelin-contracts-next": {
+    "rev": "0a25c1940ca220686588c4af3ec526f725fe2582"
+  },
+  "lib/openzeppelin-contracts-upgradeable": {
+    "rev": "58fa0f81c4036f1a3b616fdffad2fd27e5d5ce21"
+  },
+  "lib/prb-math": {
+    "branch": {
+      "name": "\"release-v4\"",
+      "rev": "1edf08dd73eb1ace0042459ba719b8ea4a55c0e0"
+    }
+  },
+  "lib/safe-contracts": {
+    "rev": "186a21a74b327f17fc41217a927dea7064f74604"
+  }
+}

test/unit/swap/BiPoolManager.t.sol

@@ -44,6 +44,7 @@ contract BiPoolManagerTest is Test {
   event BucketsUpdated(bytes32 indexed exchangeId, uint256 bucket0, uint256 bucket1);
   event BreakerBoxUpdated(address newBreakerBox);
   event PricingModulesUpdated(bytes32[] newIdentifiers, address[] newAddresses);
+  event SpreadUpdated(bytes32 indexed exchangeId, uint256 spread);
 
   /* ------------------------------------------- */
 
@@ -357,6 +358,79 @@ contract BiPoolManagerTest_initilizerSettersGetters is BiPoolManagerTest {
     biPoolManager.setPricingModules(newIdentifiers, newPricingModules);
   }
 
+  function test_setSpread_whenSenderIsNotOwner_shouldRevert() public {
+    changePrank(notDeployer);
+    vm.expectRevert("Ownable: caller is not the owner");
+    biPoolManager.setSpread(0x0, 0);
+  }
+
+  function test_setSpread_whenExchangeDoesNotExist_shouldRevert() public {
+    vm.expectRevert("invalid exchangeId");
+    biPoolManager.setSpread(0x0, 0.1 * 1e24);
+  }
+
+  function test_setSpread_whenSpreadIsGreaterThanOne_shouldRevert() public {
+    mockOracleRate(address(cUSD), 1e24);
+    bytes32 exchangeId = createExchange(cUSD, bridgedUSDC);
+    vm.expectRevert("spread must be <= 1");
+    biPoolManager.setSpread(exchangeId, 1e24 + 1);
+  }
+
+  function test_setSpread_whenCallerIsOwner_shouldUpdateAndEmit() public {
+    mockOracleRate(address(cUSD), 1e24);
+    createExchange(cUSD, bridgedUSDC);
+
+    bytes32 exchangeId = keccak256(abi.encodePacked(cUSD.symbol(), bridgedUSDC.symbol(), constantProduct.name()));
+    FixidityLib.Fraction memory currentSpread = biPoolManager.getPoolExchange(exchangeId).config.spread;
+    require(FixidityLib.equals(currentSpread, FixidityLib.wrap(0.1 * 1e24)), "Current spread is not 0.1");
+
+    vm.expectEmit(true, true, true, true);
+    emit SpreadUpdated(exchangeId, 0.5 * 1e24);
+    biPoolManager.setSpread(exchangeId, 0.5 * 1e24);
+
+    FixidityLib.Fraction memory newSpread = biPoolManager.getPoolExchange(exchangeId).config.spread;
+    require(FixidityLib.equals(newSpread, FixidityLib.wrap(0.5 * 1e24)), "New spread is not 0.5");
+  }
+
+  function test_setSpread_whenSpreadIsZero_shouldUpdate() public {
+    mockOracleRate(address(cUSD), 1e24);
+    bytes32 exchangeId = createExchange(cUSD, bridgedUSDC);
+
+    vm.expectEmit(true, true, true, true);
+    emit SpreadUpdated(exchangeId, 0);
+    biPoolManager.setSpread(exchangeId, 0);
+
+    FixidityLib.Fraction memory newSpread = biPoolManager.getPoolExchange(exchangeId).config.spread;
+    require(FixidityLib.equals(newSpread, FixidityLib.wrap(0)), "Spread should be 0");
+  }
+
+  function test_setSpread_whenSpreadIsExactlyOne_shouldUpdate() public {
+    mockOracleRate(address(cUSD), 1e24);
+    bytes32 exchangeId = createExchange(cUSD, bridgedUSDC);
+
+    vm.expectEmit(true, true, true, true);
+    emit SpreadUpdated(exchangeId, 1e24);
+    biPoolManager.setSpread(exchangeId, 1e24);
+
+    FixidityLib.Fraction memory newSpread = biPoolManager.getPoolExchange(exchangeId).config.spread;
+    require(FixidityLib.equals(newSpread, FixidityLib.wrap(1e24)), "Spread should be 1");
+  }
+
+  function test_setSpread_whenSettingSameSpread_shouldEmitAndSucceed() public {
+    mockOracleRate(address(cUSD), 1e24);
+    bytes32 exchangeId = createExchange(cUSD, bridgedUSDC);
+
+    // Initial spread is 0.1 * 1e24 from createExchange
+    uint256 currentSpreadValue = 0.1 * 1e24;
+
+    vm.expectEmit(true, true, true, true);
+    emit SpreadUpdated(exchangeId, currentSpreadValue);
+    biPoolManager.setSpread(exchangeId, currentSpreadValue);
+
+    FixidityLib.Fraction memory newSpread = biPoolManager.getPoolExchange(exchangeId).config.spread;
+    require(FixidityLib.equals(newSpread, FixidityLib.wrap(currentSpreadValue)), "Spread should remain 0.1");
+  }
+
   /* ---------- Getters ---------- */
 
   function test_getPoolExchange_whenExchangeDoesNotExist_shouldRevert() public {