Emit amounts on hub (#386)

* chore: emit amounts on hub

* chore: snapshot

* chore: emit shares also, emit index tmp

* chore: 🎉 optimiser is smart, no gas penalty

* fix: ci

---------

Co-authored-by: Cheyenne Atapour <[email protected]>

Author: DhairyaSethi

.github/workflows/tests-merge.yml

@@ -1,27 +1,27 @@
 name: Tests
- 
- on:
-   push:
-     branches:
-       - main
- 
- jobs:
-   test:
-     name: Foundry build n test
-     runs-on: ubuntu-latest
-     steps:
-       - uses: actions/checkout@v4
-         with:
-           submodules: recursive
-           token: ${{ secrets.READ_ONLY_PAT || github.token }}
- 
-       - name: Run Foundry setup
-         uses: bgd-labs/github-workflows/.github/actions/foundry-setup@main
-         with:
-           FOUNDRY_VERSION: stable
- 
-       - name: Run Forge tests
-         id: test
-         uses: bgd-labs/github-workflows/.github/actions/foundry-test@main
-         with:
-           FOUNDRY_PROFILE: ci
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    name: Foundry build n test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+          token: ${{ secrets.READ_ONLY_PAT || github.token }}
+
+      - name: Run Foundry setup
+        uses: bgd-labs/github-workflows/.github/actions/foundry-setup@main
+        with:
+          FOUNDRY_VERSION: stable
+
+      - name: Run Forge tests
+        id: test
+        uses: bgd-labs/github-workflows/.github/actions/foundry-test@main
+        with:
+          FOUNDRY_PROFILE: ci

snapshots/Hub.Operations.json

@@ -1,8 +1,8 @@
 {
-  "add": "184993",
-  "draw": "121174",
-  "remove: full": "78409",
-  "remove: partial": "94695",
-  "restore: full": "92349",
-  "restore: partial": "101949"
+  "add": "186822",
+  "draw": "123006",
+  "remove: full": "80241",
+  "remove: partial": "96527",
+  "restore: full": "94178",
+  "restore: partial": "103778"
 }

snapshots/Spoke.Operations.json

@@ -1,13 +1,13 @@
 {
-  "borrow": "478986",
-  "repay: full": "219877",
-  "repay: partial": "287534",
-  "supply: 0 debt, collateralDisabled": "170307",
-  "supply: 0 debt, collateralEnabled": "170283",
-  "supply: 1 debt": "170331",
-  "supply: 2 debt": "170342",
-  "supply: 3 debt": "170295",
-  "usingAsCollateral": "50661",
-  "withdraw: full": "215505",
-  "withdraw: partial": "226456"
+  "borrow": "480818",
+  "repay: full": "221340",
+  "repay: partial": "289363",
+  "supply: 0 debt, collateralDisabled": "172136",
+  "supply: 0 debt, collateralEnabled": "172112",
+  "supply: 1 debt": "172160",
+  "supply: 2 debt": "172171",
+  "supply: 3 debt": "172124",
+  "usingAsCollateral": "50683",
+  "withdraw: full": "217337",
+  "withdraw: partial": "228288"
 }

src/contracts/LiquidityHub.sol

@@ -130,7 +130,7 @@ contract LiquidityHub is ILiquidityHub {
     // TODO: fee-on-transfer
     assetsList[assetId].safeTransferFrom(from, address(this), amount);
 
-    emit Add(assetId, msg.sender, suppliedShares);
+    emit Add(assetId, msg.sender, suppliedShares, amount);
 
     return suppliedShares;
   }
@@ -156,7 +156,7 @@ contract LiquidityHub is ILiquidityHub {
 
     assetsList[assetId].safeTransfer(to, amount);
 
-    emit Remove(assetId, msg.sender, withdrawnShares);
+    emit Remove(assetId, msg.sender, withdrawnShares, amount);
 
     return withdrawnShares;
   }
@@ -182,7 +182,7 @@ contract LiquidityHub is ILiquidityHub {
 
     assetsList[assetId].safeTransfer(to, amount);
 
-    emit Draw(assetId, msg.sender, drawnShares);
+    emit Draw(assetId, msg.sender, drawnShares, amount);
 
     return drawnShares;
   }
@@ -215,7 +215,7 @@ contract LiquidityHub is ILiquidityHub {
 
     assetsList[assetId].safeTransferFrom(from, address(this), totalRestoredAmount);
 
-    emit Restore(assetId, msg.sender, baseDrawnSharesRestored);
+    emit Restore(assetId, msg.sender, baseDrawnSharesRestored, totalRestoredAmount);
 
     return baseDrawnSharesRestored;
   }

src/interfaces/ILiquidityHub.sol

@@ -20,10 +20,31 @@ interface ILiquidityHub {
     uint256 supplyCap
   );
 
-  event Add(uint256 indexed assetId, address indexed spoke, uint256 suppliedShares);
-  event Remove(uint256 indexed assetId, address indexed spoke, uint256 suppliedShares);
-  event Draw(uint256 indexed assetId, address indexed spoke, uint256 drawnShares);
-  event Restore(uint256 indexed assetId, address indexed spoke, uint256 drawnShares);
+  event DrawnIndexUpdate(uint256 indexed assetId, uint256 drawnIndex);
+  event Add(
+    uint256 indexed assetId,
+    address indexed spoke,
+    uint256 suppliedShares,
+    uint256 suppliedAmount
+  );
+  event Remove(
+    uint256 indexed assetId,
+    address indexed spoke,
+    uint256 withdrawnShares,
+    uint256 withdrawnAmount
+  );
+  event Draw(
+    uint256 indexed assetId,
+    address indexed spoke,
+    uint256 drawnShares,
+    uint256 drawnAmount
+  );
+  event Restore(
+    uint256 indexed assetId,
+    address indexed spoke,
+    uint256 baseRestoredShares,
+    uint256 totalRestoredAmount
+  );
   event RefreshPremiumDebt(
     uint256 indexed assetId,
     address indexed spoke,
@@ -55,13 +76,17 @@ interface ILiquidityHub {
   error InvalidDebtChange();
 
   function addAsset(DataTypes.AssetConfig memory params, address asset) external;
+
   function updateAssetConfig(uint256 assetId, DataTypes.AssetConfig memory config) external;
+
   function addSpoke(uint256 assetId, DataTypes.SpokeConfig memory params, address spoke) external;
+
   function addSpokes(
     uint256[] calldata assetIds,
     DataTypes.SpokeConfig[] memory configs,
     address spoke
   ) external;
+
   function updateSpokeConfig(
     uint256 assetId,
     address spoke,
@@ -152,32 +177,52 @@ interface ILiquidityHub {
   ) external;
 
   function convertToDrawnAssets(uint256 assetId, uint256 shares) external view returns (uint256);
+
   function convertToDrawnShares(uint256 assetId, uint256 assets) external view returns (uint256);
+
   function convertToSuppliedAssets(uint256 assetId, uint256 shares) external view returns (uint256);
+
   function convertToSuppliedShares(uint256 assetId, uint256 assets) external view returns (uint256);
+
   function previewOffset(uint256 assetId, uint256 shares) external view returns (uint256);
+
   function getAsset(uint256 assetId) external view returns (DataTypes.Asset memory);
+
   function getAssetConfig(uint256 assetId) external view returns (DataTypes.AssetConfig memory);
+
   function getAssetDebt(uint256 assetId) external view returns (uint256, uint256);
+
   function getAssetSuppliedAmount(uint256 assetId) external view returns (uint256);
+
   function getAssetSuppliedShares(uint256 assetId) external view returns (uint256);
+
   function getAssetTotalDebt(uint256 assetId) external view returns (uint256);
+
   function getAvailableLiquidity(uint256 assetId) external view returns (uint256);
+
   function getBaseInterestRate(uint256 assetId) external view returns (uint256);
+
   function getSpoke(
     uint256 assetId,
     address spoke
   ) external view returns (DataTypes.SpokeData memory);
+
   function getSpokeConfig(
     uint256 assetId,
     address spoke
   ) external view returns (DataTypes.SpokeConfig memory);
+
   function getSpokeDebt(uint256 assetId, address spoke) external view returns (uint256, uint256);
+
   function getSpokeSuppliedAmount(uint256 assetId, address spoke) external view returns (uint256);
+
   function getSpokeSuppliedShares(uint256 assetId, address spoke) external view returns (uint256);
+
   function getSpokeTotalDebt(uint256 assetId, address spoke) external view returns (uint256);
 
   function assetCount() external view returns (uint256);
+
   function assetsList(uint256 assetId) external view returns (IERC20);
+
   function MAX_ALLOWED_ASSET_DECIMALS() external view returns (uint256);
 }

src/libraries/logic/AssetLogic.sol

@@ -1,6 +1,8 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.0;
 
+import {ILiquidityHub} from 'src/interfaces/ILiquidityHub.sol';
+
 import {WadRayMathExtended} from 'src/libraries/math/WadRayMathExtended.sol';
 import {DataTypes} from 'src/libraries/types/DataTypes.sol';
 import {MathUtils} from 'src/libraries/math/MathUtils.sol';
@@ -23,6 +25,7 @@ library AssetLogic {
   ) internal view returns (uint256) {
     return shares.rayMulUp(asset.previewIndex());
   }
+
   function toDrawnAssetsDown(
     DataTypes.Asset storage asset,
     uint256 shares
@@ -36,6 +39,7 @@ library AssetLogic {
   ) internal view returns (uint256) {
     return assets.rayDivUp(asset.previewIndex());
   }
+
   function toDrawnSharesDown(
     DataTypes.Asset storage asset,
     uint256 assets
@@ -75,6 +79,7 @@ library AssetLogic {
   ) internal view returns (uint256) {
     return shares.toAssetsUp(asset.totalSuppliedAssets(), asset.totalSuppliedShares());
   }
+
   function toSuppliedAssetsDown(
     DataTypes.Asset storage asset,
     uint256 shares
@@ -88,6 +93,7 @@ library AssetLogic {
   ) internal view returns (uint256) {
     return assets.toSharesUp(asset.totalSuppliedAssets(), asset.totalSuppliedShares());
   }
+
   function toSuppliedSharesDown(
     DataTypes.Asset storage asset,
     uint256 assets
@@ -120,8 +126,9 @@ library AssetLogic {
 
   // @dev Utilizes existing `asset.baseBorrowRate`
   function accrue(DataTypes.Asset storage asset) internal {
-    asset.baseDebtIndex = asset.previewIndex();
+    uint256 baseDebtIndex = asset.baseDebtIndex = asset.previewIndex();
     asset.lastUpdateTimestamp = block.timestamp;
+    emit ILiquidityHub.DrawnIndexUpdate(asset.id, baseDebtIndex);
   }
 
   function previewIndex(DataTypes.Asset storage asset) internal view returns (uint256) {

tests/unit/LiquidityHub/LiquidityHub.Draw.t.sol

@@ -36,7 +36,7 @@ contract LiquidityHubDrawTest is LiquidityHubBase {
 
     // spoke1 draw all dai reserve liquidity
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Draw(daiAssetId, address(spoke1), drawAmount);
+    emit ILiquidityHub.Draw(daiAssetId, address(spoke1), drawAmount, drawAmount);
     vm.prank(address(spoke1));
     hub.draw({assetId: daiAssetId, amount: drawAmount, to: alice});
 
@@ -90,7 +90,7 @@ contract LiquidityHubDrawTest is LiquidityHubBase {
 
     // spoke1 draw all dai reserve liquidity
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Draw(assetId, address(spoke1), drawAmount);
+    emit ILiquidityHub.Draw(assetId, address(spoke1), drawAmount, drawAmount);
     vm.prank(address(spoke1));
     hub.draw({assetId: assetId, amount: drawAmount, to: alice});
 

tests/unit/LiquidityHub/LiquidityHub.Supply.t.sol

@@ -179,7 +179,7 @@ contract LiquidityHubSupplyTest is LiquidityHubBase {
     assertEq(tokenList.dai.balanceOf(address(hub)), 0);
 
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Add(daiAssetId, address(spoke1), amount);
+    emit ILiquidityHub.Add(daiAssetId, address(spoke1), amount, amount);
     vm.prank(address(spoke1));
     hub.add(daiAssetId, amount, alice);
 
@@ -221,7 +221,7 @@ contract LiquidityHubSupplyTest is LiquidityHubBase {
     vm.expectEmit(address(asset));
     emit IERC20.Transfer(alice, address(hub), amount);
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Add(assetId, address(spoke1), amount);
+    emit ILiquidityHub.Add(assetId, address(spoke1), amount, amount);
 
     vm.prank(address(spoke1));
     hub.add(assetId, amount, alice);
@@ -269,15 +269,15 @@ contract LiquidityHubSupplyTest is LiquidityHubBase {
     vm.expectEmit(address(asset));
     emit IERC20.Transfer(alice, address(hub), amount);
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Add(assetId, address(spoke1), amount);
+    emit ILiquidityHub.Add(assetId, address(spoke1), amount, amount);
 
     vm.prank(address(spoke1));
     hub.add(assetId, amount, alice);
 
     vm.expectEmit(address(asset2));
     emit IERC20.Transfer(alice, address(hub), amount2);
     vm.expectEmit(address(hub));
-    emit ILiquidityHub.Add(assetId2, address(spoke2), amount2);
+    emit ILiquidityHub.Add(assetId2, address(spoke2), amount2, amount2);
 
     vm.prank(address(spoke2));
     hub.add(assetId2, amount2, alice);