@venusprotocol/liquidity-hub 2.1.0-dev.6 → 2.1.0-dev.7

package/contracts/interfaces/IYieldGroupBase.sol

@@ -138,6 +138,16 @@ interface IYieldGroupBase {
      */
     event Swept(address indexed token, address indexed to, uint256 amount);
 
+    /**
+     * @notice Governance synced the tracked receipt balance of `resource` with what it holds, so
+     *         receipt tokens that arrived outside the deposit path now count toward the Hub's share
+     *         price, up to the cap the sync was given.
+     * @param resource Resource whose tracked balance was synced.
+     * @param oldShares Tracked receipt balance before the sync.
+     * @param newShares Tracked receipt balance after the sync.
+     */
+    event ReceiptSynced(address indexed resource, uint256 oldShares, uint256 newShares);
+
     // -------------------------------- Errors ----------------------------------
 
     /// @notice Caller of an `onlyHub` function was not the registered Hub.
@@ -188,9 +198,10 @@ interface IYieldGroupBase {
     error ResourceNotRegistered(address resource);
 
     /**
-     * @notice `removeResource()` called while the resource still holds a non-zero balance.
+     * @notice `removeResource()` called while the YieldGroup still accounts for receipts of the
+     *         resource (the tracked ledger for a tracking family, the wallet balance otherwise).
      * @param resource Resource attempted to be removed.
-     * @param balance Current resource balance preventing removal.
+     * @param balance Accounted receipt balance preventing removal, in the resource's share units.
      */
     error ResourceHasBalance(address resource, uint256 balance);
 
@@ -246,8 +257,8 @@ interface IYieldGroupBase {
     error InvalidQueue();
 
     /**
-     * @notice Withdraw queue omits a resource still holding receipt tokens, which the cascade would
-     *         then not visit.
+     * @notice Withdraw queue omits a resource whose accounted receipts are non-zero (the tracked
+     *         ledger for a tracking family, the wallet otherwise), which the cascade would then not visit.
      * @param resource The funded resource missing from the queue.
      */
     error WithdrawQueueOmitsFundedResource(address resource);
@@ -266,6 +277,10 @@ interface IYieldGroupBase {
     ///         `totalAssets` and must never be sweepable.
     error SweepProtectedAsset();
 
+    /// @notice `syncReceipt` was called on a family that values positions by holder, not by tracked
+    ///         receipts (Centrifuge), where the sync would write a slot nothing reads.
+    error ReceiptTrackingOff();
+
     /**
      * @notice `sweep()` targeted a registered resource. In every family the resource address is the
      *         receipt token backing `totalAssets`, so sweeping it would drain the YieldGroup.
@@ -361,7 +376,9 @@ interface IYieldGroupBase {
     function addResource(address resource, address adapter) external;
 
     /**
-     * @notice Remove a registered resource. Requires zero balance held in that resource.
+     * @notice Remove a registered resource. Requires the YieldGroup to account for no receipts of it:
+     *         the tracked ledger for a tracking family, the wallet balance otherwise. Receipts that
+     *         arrived outside the deposit path do not block removal and are sweepable afterwards.
      * @dev ACM role `"removeResource(address)"` (VIP). Also removes the resource from both
      *      inner queues via swap-and-pop. Emits {ResourceRemoved}.
      * @param resource Resource to remove.
@@ -433,6 +450,27 @@ interface IYieldGroupBase {
      */
     function sweep(address token, address to) external;
 
+    /**
+     * @notice Set the tracked receipt balance of `resource` to what it holds, adding at most
+     *         `maxAdded`. This admits receipt tokens that arrived outside the deposit path (a
+     *         donation, a mistransfer) into the Hub's share price; until then they sit on the
+     *         YieldGroup uncounted.
+     * @dev ACM role `"syncReceipt(address,uint256)"` (VIP). Emits {ReceiptSynced}. Reverts
+     *      {ReceiptTrackingOff} on a family that does not track receipts.
+     *
+     *      `maxAdded` caps the sync at the amount governance reviewed. A VIP executes days after it
+     *      is proposed, and anything sent in meanwhile, including over-priced receipts from a market
+     *      carrying bad debt, stays uncounted above the cap. It is a cap rather than an exact match,
+     *      so a single extra wei sent in before execution cannot make the sync revert.
+     *
+     *      `type(uint256).max` syncs the whole wallet. The upgrade that introduced tracking needs it:
+     *      every tracked balance starts at 0 there, and the wallet at execution cannot be known when
+     *      the VIP is proposed. The old code already priced the whole wallet, so it admits nothing new.
+     * @param resource Registered resource to sync.
+     * @param maxAdded Most receipts this sync may add to the tracked balance.
+     */
+    function syncReceipt(address resource, uint256 maxAdded) external;
+
     // ---------------------------------- Views --------------------------------
 
     /**
@@ -442,9 +480,11 @@ interface IYieldGroupBase {
     function asset() external view returns (address underlying);
 
     /**
-     * @notice Sum of `asset` held across all of this YieldGroup's underlying vaults.
+     * @notice Underlying value of the receipts this YieldGroup accounts for across its resources,
+     *         plus its idle `asset` balance. A tracking family prices only the receipts its own
+     *         deposits minted; Centrifuge prices its whole wallet.
      * @dev Hub sums `totalAssets()` over its registered YieldGroups to compute its own totalAssets().
-     * @return total Asset units currently held by the YieldGroup.
+     * @return total Asset units the YieldGroup accounts for.
      */
     function totalAssets() external view returns (uint256 total);
 
@@ -502,6 +542,15 @@ interface IYieldGroupBase {
      */
     function resourceConfig(address resource) external view returns (bool registered, bool paused, address adapter);
 
+    /**
+     * @notice Receipt tokens of `resource` that count toward `totalAssets()`: those this YieldGroup
+     *         minted through its own deposits, net of what it redeemed. Always 0 for a family that
+     *         does not track receipts (Centrifuge), which prices its wallet instead.
+     * @param resource Resource to look up.
+     * @return shares Tracked receipt balance, in the resource's own share units.
+     */
+    function trackedReceipt(address resource) external view returns (uint256 shares);
+
     /// @notice Current inner deposit-routing order.
     /// @return queue Storage copy of the inner deposit queue.
     function innerDepositQueue() external view returns (address[] memory queue);

package/contracts/interfaces/external/IVToken.sol

@@ -104,6 +104,15 @@ interface IVToken {
      */
     function getCash() external view returns (uint256 cash);
 
+    /**
+     * @notice Protocol reserves held inside `getCash()`.
+     * @dev `accrueInterest` sends them out of cash to the ProtocolShareReserve once
+     *      `reduceReservesBlockDelta` blocks have elapsed, so a redeem can only count on
+     *      `getCash() - totalReserves()`.
+     * @return reserves Underlying units reserved for the protocol.
+     */
+    function totalReserves() external view returns (uint256 reserves);
+
     /**
      * @notice The ERC-20 underlying token. Reverts for vBNB (which has no `underlying`
      *         accessor); the Core Yield Group v1 uses this revert as a guard against vBNB

package/deployments/bscmainnet/AdapterCoreV1.json

@@ -1,6 +1,6 @@
 {
-  "address": "0xa061cC2F62BDa2D6bA53Fb98847aD9822DA085dd",
-  "block": 123325056,
+  "address": "0x0f62927d18Fd35712622C2c6C3F730EB8a18b71B",
+  "block": 132740470,
   "chainId": 56,
   "contract": "AdapterCoreV1",
   "abi": [
@@ -158,6 +158,30 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "receiptValue",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "vBal",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "resourceName",

package/deployments/bscmainnet/AdapterFRV.json

@@ -1,6 +1,6 @@
 {
-  "address": "0x1824caA965Ac05ae5C9C2819e045337e2cF5657c",
-  "block": 123325056,
+  "address": "0x40fDc0fef94D607EE4341230afb09bcDB0B949E2",
+  "block": 132740470,
   "chainId": 56,
   "contract": "AdapterFRV",
   "abi": [
@@ -132,6 +132,30 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "receiptValue",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "shares",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "resourceName",

package/deployments/bscmainnet/AdapterFlux.json

@@ -1,6 +1,6 @@
 {
-  "address": "0x9a1a7F6aebA4a1A3e85Ae1Dba90a7A2A52803404",
-  "block": 123325056,
+  "address": "0x4Afb747ce8dDef689d5484FFdfB69Ac8bC7cAc8B",
+  "block": 132740470,
   "chainId": 56,
   "contract": "AdapterFlux",
   "abi": [
@@ -151,6 +151,30 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "receiptValue",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "shares",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "resourceName",

package/deployments/bscmainnet/AdapterSpokeV1.json

@@ -1,6 +1,6 @@
 {
-  "address": "0x231915FfE3e3A6Be09B0E5c73EFA2F1a4FF8Aa69",
-  "block": 127748551,
+  "address": "0xD08596E58325724C824100bA87f2470493Fe342d",
+  "block": 132740470,
   "chainId": 56,
   "contract": "AdapterSpokeV1",
   "abi": [
@@ -158,6 +158,30 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "receiptValue",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "vBal",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "resourceName",

package/deployments/bscmainnet/YieldGroupCoreImpl.json

@@ -1,6 +1,6 @@
 {
-  "address": "0x3BccED778CAaf97AE8ff8Bedc16d2165aA15771b",
-  "block": 112779813,
+  "address": "0xedB1c751Eb03274e9D15D0609B4593CC113fB09F",
+  "block": 132740470,
   "chainId": 56,
   "contract": "YieldGroup",
   "abi": [
@@ -460,6 +460,24 @@
       "outputs": [],
       "stateMutability": "nonpayable"
     },
+    {
+      "type": "function",
+      "name": "syncReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "maxAdded",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "nonpayable"
+    },
     {
       "type": "function",
       "name": "totalAssets",
@@ -473,6 +491,25 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "trackedReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "unpauseResource",
@@ -622,6 +659,31 @@
       ],
       "anonymous": false
     },
+    {
+      "type": "event",
+      "name": "ReceiptSynced",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "indexed": true,
+          "internalType": "address"
+        },
+        {
+          "name": "oldShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        },
+        {
+          "name": "newShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        }
+      ],
+      "anonymous": false
+    },
     {
       "type": "event",
       "name": "ResourceAccrualFailed",
@@ -897,6 +959,11 @@
       "name": "OnlySelf",
       "inputs": []
     },
+    {
+      "type": "error",
+      "name": "ReceiptTrackingOff",
+      "inputs": []
+    },
     {
       "type": "error",
       "name": "ResourceAlreadyRegistered",

package/deployments/bscmainnet/YieldGroupFRVImpl.json

@@ -1,6 +1,6 @@
 {
-  "address": "0x72D115b1Be69a2065fED0B0574F95B3E46BD4502",
-  "block": 112780032,
+  "address": "0xcffcDBCfEDBf33FB22bdd5FadB3916b871711A06",
+  "block": 132740470,
   "chainId": 56,
   "contract": "YieldGroupFRV",
   "abi": [
@@ -387,6 +387,24 @@
       "outputs": [],
       "stateMutability": "nonpayable"
     },
+    {
+      "type": "function",
+      "name": "syncReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "maxAdded",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "nonpayable"
+    },
     {
       "type": "function",
       "name": "totalAssets",
@@ -400,6 +418,25 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "trackedReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "unpauseResource",
@@ -530,6 +567,31 @@
       ],
       "anonymous": false
     },
+    {
+      "type": "event",
+      "name": "ReceiptSynced",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "indexed": true,
+          "internalType": "address"
+        },
+        {
+          "name": "oldShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        },
+        {
+          "name": "newShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        }
+      ],
+      "anonymous": false
+    },
     {
       "type": "event",
       "name": "ResourceAccrualFailed",
@@ -776,6 +838,11 @@
       "name": "OnlySelf",
       "inputs": []
     },
+    {
+      "type": "error",
+      "name": "ReceiptTrackingOff",
+      "inputs": []
+    },
     {
       "type": "error",
       "name": "ResourceAlreadyRegistered",

package/deployments/bscmainnet/YieldGroupFluxImpl.json

@@ -1,6 +1,6 @@
 {
-  "address": "0xFD49a719E0bF7f588F77bBEdf10dd8E843774499",
-  "block": 112780252,
+  "address": "0xedB1c751Eb03274e9D15D0609B4593CC113fB09F",
+  "block": 132740470,
   "chainId": 56,
   "contract": "YieldGroup",
   "abi": [
@@ -460,6 +460,24 @@
       "outputs": [],
       "stateMutability": "nonpayable"
     },
+    {
+      "type": "function",
+      "name": "syncReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "maxAdded",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "nonpayable"
+    },
     {
       "type": "function",
       "name": "totalAssets",
@@ -473,6 +491,25 @@
       ],
       "stateMutability": "view"
     },
+    {
+      "type": "function",
+      "name": "trackedReceipt",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
     {
       "type": "function",
       "name": "unpauseResource",
@@ -622,6 +659,31 @@
       ],
       "anonymous": false
     },
+    {
+      "type": "event",
+      "name": "ReceiptSynced",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "indexed": true,
+          "internalType": "address"
+        },
+        {
+          "name": "oldShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        },
+        {
+          "name": "newShares",
+          "type": "uint256",
+          "indexed": false,
+          "internalType": "uint256"
+        }
+      ],
+      "anonymous": false
+    },
     {
       "type": "event",
       "name": "ResourceAccrualFailed",
@@ -897,6 +959,11 @@
       "name": "OnlySelf",
       "inputs": []
     },
+    {
+      "type": "error",
+      "name": "ReceiptTrackingOff",
+      "inputs": []
+    },
     {
       "type": "error",
       "name": "ResourceAlreadyRegistered",