@venusprotocol/liquidity-hub 0.0.0

package/contracts/registry/HubRegistry.sol

@@ -0,0 +1,179 @@
+// SPDX-License-Identifier: BUSL-1.1
+pragma solidity 0.8.25;
+
+import { AccessControlledV8 } from "@venusprotocol/governance-contracts/contracts/Governance/AccessControlledV8.sol";
+
+import { IHub } from "../interfaces/IHub.sol";
+import { IHubRegistry } from "../interfaces/IHubRegistry.sol";
+
+/**
+ * @title HubRegistry
+ * @author Venus
+ * @notice Chain-level directory of Hubs, keyed by underlying asset — the single on-chain
+ *         discovery root for the Liquidity Hub topology. Hubs are deployed outside the
+ *         registry (the `deploy/06_DeployAssetVault` bootstrap script) and registered via
+ *         `addHub`; the onboarding VIP orders `addHub` before the Hub's `addYieldGroup`
+ *         calls in one atomic transaction, so {IHubRegistry-HubAdded} lands at a lower log
+ *         index than every `YieldGroupAdded`. That ordering is a latency optimization only —
+ *         indexers MUST seed each Hub's YieldGroup set from state on {IHubRegistry-HubAdded}
+ *         (see the normative indexer contract in {IHubRegistry}). The registry holds no funds
+ *         and never routes assets.
+ * @dev Upgradeable singleton behind a TransparentUpgradeableProxy (unlike the per-asset Hubs,
+ *      which share a beacon). Mutating functions are ACM-gated with their literal
+ *      function-signature strings; the gate is the first statement of every gated function.
+ *      No reentrancy guard: the only external call (`IHub.asset()`) is a STATICCALL — a
+ *      state-mutating callback reverts at the EVM level — and the registry moves no assets.
+ *
+ *      Storage: the inherited chain (Initializable → Context → Ownable → Ownable2Step →
+ *      AccessControlledV8) occupies slots 0..200, so the registry's own fields start at
+ *      absolute slot 201 (verified via `forge inspect` and pinned by the storage-layout test):
+ *
+ *          Slot      Field
+ *          ----      -----
+ *           201      _hubForAsset
+ *           202      _assetForHub
+ *           203      _hubs
+ *           204      _hubIndex
+ *        205..250    __gap (32 × 46)
+ *
+ *      Order is append-only: new fields go after `_hubIndex`, shrinking `__gap` by the same
+ *      number of slots; never reorder, never prepend.
+ */
+contract HubRegistry is AccessControlledV8, IHubRegistry {
+    // ============================== State =====================================
+
+    /// @dev Active Hub for each asset (0 = none). Exactly one Hub per asset.
+    mapping(address asset => address hub) internal _hubForAsset;
+
+    /// @dev Reverse lookup: the asset a Hub is registered under (0 = not registered).
+    ///      Doubles as the `isHub` flag and lets `removeHub` clean `_hubForAsset` without
+    ///      an external call back into the Hub.
+    mapping(address hub => address asset) internal _assetForHub;
+
+    /// @dev Canonical enumeration of registered Hubs.
+    address[] internal _hubs;
+
+    /// @dev 1-indexed position in `_hubs` (0 = not registered). Enables O(1) swap-and-pop removal.
+    mapping(address hub => uint256 indexPlusOne) internal _hubIndex;
+
+    /// @dev Reserved slots for upgrades. Shrink by the number of slots a new field consumes.
+    uint256[46] private __gap;
+
+    // ============================== Constructor ==============================
+
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        _disableInitializers();
+    }
+
+    /**
+     * @notice Initialise the registry
+     * @param accessControlManager_ AccessControlManagerV8 instance gating the mutating functions
+     * @custom:access Permissionless once (OZ `initializer` modifier prevents re-init)
+     * @custom:error Throws ZeroAddress if accessControlManager_ is the zero address
+     */
+    function initialize(address accessControlManager_) external initializer {
+        if (accessControlManager_ == address(0)) revert ZeroAddress();
+        __AccessControlled_init(accessControlManager_);
+    }
+
+    // ============================== External — mutating =======================
+
+    /**
+     * @notice Register an externally-deployed Hub under its underlying asset
+     * @dev ACM role `"addHub(address)"` (VIP). The asset key is read from `IHub(hub).asset()`;
+     *      an address that does not implement `asset()` reverts naturally (governance-vetted
+     *      input). In an onboarding VIP, order this call BEFORE the Hub's `addYieldGroup`
+     *      calls so {HubAdded} precedes every `YieldGroupAdded` in the same transaction; for
+     *      Hubs configured before registration, indexers seed the YieldGroup set from state
+     *      (`registeredYieldGroups()`). Replacing an asset's Hub is an explicit {removeHub}
+     *      then {addHub} — two events, so indexers never observe an implicit swap.
+     * @param hub Hub contract address
+     * @custom:event HubAdded Emitted with the derived asset and the hub
+     * @custom:error Throws ZeroAddress if hub is the zero address
+     * @custom:error Throws HubAlreadyRegistered if hub is already in the registry
+     * @custom:error Throws AssetAlreadyHasHub if the hub's asset already has a registered Hub
+     */
+    function addHub(address hub) external {
+        _checkAccessAllowed("addHub(address)");
+        if (hub == address(0)) revert ZeroAddress();
+        if (_assetForHub[hub] != address(0)) revert HubAlreadyRegistered(hub);
+
+        address asset = IHub(hub).asset();
+        // A real Hub can never report a zero asset (its initializer rejects it); the check keeps
+        // the `_assetForHub[hub] != 0 ⟺ registered` invariant safe against a broken input.
+        if (asset == address(0)) revert ZeroAddress();
+        address existingHub = _hubForAsset[asset];
+        if (existingHub != address(0)) revert AssetAlreadyHasHub(asset, existingHub);
+
+        _hubForAsset[asset] = hub;
+        _assetForHub[hub] = asset;
+        _hubs.push(hub);
+        _hubIndex[hub] = _hubs.length;
+
+        emit HubAdded(asset, hub);
+    }
+
+    /**
+     * @notice Remove a Hub from the registry
+     * @dev ACM role `"removeHub(address)"` (VIP). Swap-and-pop keeps enumeration O(1); the
+     *      asset mapping is cleaned via the stored reverse lookup, so removal never calls
+     *      back into the Hub (a bricked Hub can always be evicted).
+     * @param hub Hub to remove
+     * @custom:event HubRemoved Emitted with the asset the hub was registered under and the hub
+     * @custom:error Throws HubNotRegistered if hub is not in the registry
+     */
+    function removeHub(address hub) external {
+        _checkAccessAllowed("removeHub(address)");
+        address asset = _assetForHub[hub];
+        if (asset == address(0)) revert HubNotRegistered(hub);
+
+        uint256 idxPlusOne = _hubIndex[hub];
+        uint256 idx;
+        uint256 lastIdx;
+        unchecked {
+            // Safe: the `asset == 0` guard above proves `hub` is registered, so
+            // `idxPlusOne >= 1` and `_hubs.length >= 1`.
+            idx = idxPlusOne - 1;
+            lastIdx = _hubs.length - 1;
+        }
+        if (idx != lastIdx) {
+            address last = _hubs[lastIdx];
+            _hubs[idx] = last;
+            _hubIndex[last] = idxPlusOne;
+        }
+        _hubs.pop();
+        delete _hubIndex[hub];
+        delete _assetForHub[hub];
+        delete _hubForAsset[asset];
+
+        emit HubRemoved(asset, hub);
+    }
+
+    // ============================== External — views ==========================
+
+    /// @inheritdoc IHubRegistry
+    function hubForAsset(address asset) external view returns (address hub) {
+        hub = _hubForAsset[asset];
+    }
+
+    /// @inheritdoc IHubRegistry
+    function assetForHub(address hub) external view returns (address asset) {
+        asset = _assetForHub[hub];
+    }
+
+    /// @inheritdoc IHubRegistry
+    function getHubs() external view returns (address[] memory hubs) {
+        hubs = _hubs;
+    }
+
+    /// @inheritdoc IHubRegistry
+    function getHubsCount() external view returns (uint256 count) {
+        count = _hubs.length;
+    }
+
+    /// @inheritdoc IHubRegistry
+    function isHub(address hub) external view returns (bool registered) {
+        registered = _assetForHub[hub] != address(0);
+    }
+}

package/deployments/bscmainnet/AdapterCoreV1.json

@@ -0,0 +1,336 @@
+{
+  "address": "0x4E514a0C7aB9d140eE204dfA0017574270D92944",
+  "block": 112779813,
+  "chainId": 56,
+  "contract": "AdapterCoreV1",
+  "abi": [
+    {
+      "type": "constructor",
+      "inputs": [],
+      "stateMutability": "nonpayable"
+    },
+    {
+      "type": "function",
+      "name": "EXP_SCALE",
+      "inputs": [],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "MANTISSA_ONE",
+      "inputs": [],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "accrue",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "nonpayable"
+    },
+    {
+      "type": "function",
+      "name": "asset",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "deposit",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "amount",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "deposited",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "nonpayable"
+    },
+    {
+      "type": "function",
+      "name": "maxDeposit",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "maxWithdraw",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "holder",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "receiptBalance",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "holder",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "spotAPYBps",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "blocksPerYear",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint64",
+          "internalType": "uint64"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "totalAssets",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "holder",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [
+        {
+          "name": "",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "validateRegistration",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "view"
+    },
+    {
+      "type": "function",
+      "name": "withdraw",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "amount",
+          "type": "uint256",
+          "internalType": "uint256"
+        },
+        {
+          "name": "to",
+          "type": "address",
+          "internalType": "address"
+        }
+      ],
+      "outputs": [],
+      "stateMutability": "nonpayable"
+    },
+    {
+      "type": "error",
+      "name": "NotDelegateCall",
+      "inputs": []
+    },
+    {
+      "type": "error",
+      "name": "TreasuryFeeUnsupported",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "treasuryPercent",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ]
+    },
+    {
+      "type": "error",
+      "name": "VTokenAccrueFailed",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "errorCode",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ]
+    },
+    {
+      "type": "error",
+      "name": "VTokenMintFailed",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "errorCode",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ]
+    },
+    {
+      "type": "error",
+      "name": "VTokenRedeemFailed",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "errorCode",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ]
+    },
+    {
+      "type": "error",
+      "name": "VTokenUnderfilled",
+      "inputs": [
+        {
+          "name": "resource",
+          "type": "address",
+          "internalType": "address"
+        },
+        {
+          "name": "requested",
+          "type": "uint256",
+          "internalType": "uint256"
+        },
+        {
+          "name": "actual",
+          "type": "uint256",
+          "internalType": "uint256"
+        }
+      ]
+    }
+  ]
+}