Merge pull request #250 from sprintertech/feat/paxos-oracle

feat: paxos oracle

Author: mpetrunic

contracts/PaxosOracle.sol

@@ -0,0 +1,97 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity 0.8.28;
+
+import {AccessControl} from "@openzeppelin/contracts/access/AccessControl.sol";
+import {IERC20Metadata} from "@openzeppelin/contracts/token/ERC20/extensions/IERC20Metadata.sol";
+import {IOracle} from "./interfaces/IOracle.sol";
+
+/// @title Oracle valuing Paxos-issued stablecoins (USDG, PYUSD) at a hardcoded 1:1 ratio to USDC.
+/// @author Sprinter
+/// @notice Implements {IOracle} for an admin-managed set of Paxos stablecoins, each pegged exactly 1:1 to USDC.
+///         `getAssetValue` returns the USDC-denominated value of a given amount, adjusting only for any
+///         decimal mismatch between the stablecoin and USDC. The price ratio is immutable at 1:1.
+/// @dev `assetId` is the token address left-padded to bytes32 to allow non evm tokens in the future
+contract PaxosOracle is IOracle, AccessControl {
+    struct AssetConfig {
+        bool supported;
+        uint8 decimals;
+    }
+
+    struct AssetParams {
+        bytes32 assetId;
+        uint8 decimals;
+    }
+
+    /// @notice USDC token used as the value denomination.
+    IERC20Metadata public immutable USDC;
+    /// @notice Decimals of USDC, fetched once at deployment and used to scale returned values.
+    uint8 public immutable USDC_DECIMALS;
+
+    uint8 internal constant MAX_DECIMALS = 18;
+
+    mapping(bytes32 assetId => AssetConfig) public assetConfig;
+
+    event AssetAdded(bytes32 indexed assetId, uint8 decimals);
+    event AssetRemoved(bytes32 indexed assetId);
+
+    error ZeroAddress();
+    error AssetAlreadySupported(bytes32 assetId);
+    error AssetNotSupported(bytes32 assetId);
+    error DecimalsTooLarge(uint8 decimals);
+
+    /// @param admin Super-admin able to add/remove supported stablecoins.
+    /// @param usdc Address of the USDC token, used as the value denomination (its decimals).
+    /// @param initialAssets Initial set of stablecoins to support (e.g. USDG, PYUSD).
+    constructor(address admin, address usdc, AssetParams[] memory initialAssets) {
+        require(admin != address(0), ZeroAddress());
+        require(usdc != address(0), ZeroAddress());
+        _grantRole(DEFAULT_ADMIN_ROLE, admin);
+        USDC = IERC20Metadata(usdc);
+        USDC_DECIMALS = IERC20Metadata(usdc).decimals();
+        for (uint256 i = 0; i < initialAssets.length; ++i) {
+            _addAsset(initialAssets[i].assetId, initialAssets[i].decimals);
+        }
+    }
+
+    /// @notice Registers a stablecoin to be valued 1:1 against USDC.
+    /// @param assetId The asset identifier (an EVM token address left-padded to bytes32).
+    /// @param decimals The number of decimals the stablecoin uses. Provided explicitly so that
+    ///        non-EVM assets, whose `decimals()` cannot be queried on-chain, can also be supported.
+    function addAsset(bytes32 assetId, uint8 decimals) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        _addAsset(assetId, decimals);
+    }
+
+    /// @notice Removes a previously registered stablecoin.
+    /// @param assetId The asset identifier to remove.
+    function removeAsset(bytes32 assetId) external onlyRole(DEFAULT_ADMIN_ROLE) {
+        require(assetConfig[assetId].supported, AssetNotSupported(assetId));
+        delete assetConfig[assetId];
+        emit AssetRemoved(assetId);
+    }
+
+    /// @notice Returns the USDC-denominated value of `amount` units of the supported stablecoin `assetId`.
+    /// @dev Reverts for any asset that is not currently supported.
+    function getAssetValue(bytes32 assetId, uint256 amount) external view returns (uint256) {
+        AssetConfig memory config = assetConfig[assetId];
+        require(config.supported, AssetNotSupported(assetId));
+        if (config.decimals == USDC_DECIMALS) {
+            return amount;
+        }
+        if (config.decimals > USDC_DECIMALS) {
+            return amount / (10 ** (config.decimals - USDC_DECIMALS));
+        }
+        return amount * (10 ** (USDC_DECIMALS - config.decimals));
+    }
+
+    /// @notice Returns true if `assetId` is currently valued by this oracle.
+    function isSupported(bytes32 assetId) external view returns (bool) {
+        return assetConfig[assetId].supported;
+    }
+
+    function _addAsset(bytes32 assetId, uint8 decimals) internal {
+        require(!assetConfig[assetId].supported, AssetAlreadySupported(assetId));
+        require(decimals <= MAX_DECIMALS, DecimalsTooLarge(decimals));
+        assetConfig[assetId] = AssetConfig({supported: true, decimals: decimals});
+        emit AssetAdded(assetId, decimals);
+    }
+}

contracts/interfaces/IOracle.sol

@@ -0,0 +1,8 @@
+// SPDX-License-Identifier: LGPL-3.0-only
+pragma solidity 0.8.28;
+
+/// @title Price oracle interface.
+/// @author Oleksii Matiiasevych <oleksii@sprinter.tech>
+interface IOracle {
+    function getAssetValue(bytes32 assetId, uint256 amount) external view returns (uint256);
+}

network.config.ts

@@ -123,6 +123,8 @@ export enum Token {
   WETH = "WETH",
   WBTC = "WBTC",
   EURe = "EURe",
+  USDG = "USDG",
+  PYUSD = "PYUSD",
 }
 
 interface CCTPConfig {
@@ -230,6 +232,8 @@ export interface NetworkConfig {
     [Token.WETH]?: TokenInfo;
     [Token.WBTC]?: TokenInfo;
     [Token.EURe]?: TokenInfo;
+    [Token.USDG]?: TokenInfo;
+    [Token.PYUSD]?: TokenInfo;
   };
   WrappedNativeToken: string;
   RebalancerRoutes?: RebalancerRoutesConfig;
@@ -287,6 +291,8 @@ export const networkConfig: NetworksConfig = {
       DAI: tokenInfo("0x6B175474E89094C44Da98b954EedeAC495271d0F", 18),
       WETH: tokenInfo("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", 18),
       WBTC: tokenInfo("0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599", 8),
+      USDG: tokenInfo("0xe343167631d89B6Ffc58B88d6b7fB0228795491D", 6),
+      PYUSD: tokenInfo("0x6c3ea9036406852006290770BEdFcAbA0e23A0e8", 6),
     },
     WrappedNativeToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
     IsTest: false,
@@ -423,6 +429,8 @@ export const networkConfig: NetworksConfig = {
         DAI: tokenInfo("0x6B175474E89094C44Da98b954EedeAC495271d0F", 18),
         WETH: tokenInfo("0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2", 18),
         WBTC: tokenInfo("0x2260FAC5E5542a773Aa44fBCfeDf7C193bc2C599", 8),
+        USDG: tokenInfo("0xe343167631d89B6Ffc58B88d6b7fB0228795491D", 6),
+        PYUSD: tokenInfo("0x6c3ea9036406852006290770BEdFcAbA0e23A0e8", 6),
       },
       WrappedNativeToken: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
       IsTest: false,

package.json

@@ -71,6 +71,8 @@
     "deploy-spark-stage-repayer-opmainnet": "STANDALONE_REPAYER_ENV=SparkStage hardhat run ./scripts/deployStandaloneRepayer.ts --network OP_MAINNET",
     "deploy-usdc-processor-ethereum": "hardhat run ./scripts/deployUSDCProcessor.ts --network ETHEREUM",
     "deploy-usdc-processor-ethereum-stage": "DEPLOY_TYPE=STAGE hardhat run ./scripts/deployUSDCProcessor.ts --network ETHEREUM",
+    "deploy-paxosoracle-ethereum": "hardhat run ./scripts/deployPaxosOracle.ts --network ETHEREUM",
+    "deploy-paxosoracle-ethereum-stage": "DEPLOY_TYPE=STAGE hardhat run ./scripts/deployPaxosOracle.ts --network ETHEREUM",
     "upgrade-liquidityhub-basesepolia": "hardhat run ./scripts/upgradeLiquidityHub.ts --network BASE_SEPOLIA",
     "upgrade-liquidityhub-base": "hardhat run ./scripts/upgradeLiquidityHub.ts --network BASE",
     "upgrade-liquidityhub-base-stage": "DEPLOY_TYPE=STAGE hardhat run ./scripts/upgradeLiquidityHub.ts --network BASE",
@@ -213,6 +215,8 @@
     "dry:deploy-spark-stage-repayer-opmainnet": "DRY_RUN=OP_MAINNET STANDALONE_REPAYER_ENV=SparkStage VERIFY=false ts-node --files ./scripts/deployStandaloneRepayer.ts",
     "dry:deploy-usdc-processor-ethereum-stage": "DRY_RUN=ETHEREUM VERIFY=false DEPLOY_TYPE=STAGE ts-node --files ./scripts/deployUSDCProcessor.ts",
     "dry:deploy-usdc-processor-ethereum": "DRY_RUN=ETHEREUM VERIFY=false ts-node --files ./scripts/deployUSDCProcessor.ts",
+    "dry:deploy-paxosoracle-ethereum": "DRY_RUN=ETHEREUM VERIFY=false ts-node --files ./scripts/deployPaxosOracle.ts",
+    "dry:deploy-paxosoracle-ethereum-stage": "DRY_RUN=ETHEREUM DEPLOY_TYPE=STAGE VERIFY=false ts-node --files ./scripts/deployPaxosOracle.ts",
     "dry:upgrade-liquidityhub-basesepolia": "DRY_RUN=BASE_SEPOLIA VERIFY=false ts-node --files ./scripts/upgradeLiquidityHub.ts",
     "dry:upgrade-liquidityhub-base": "DRY_RUN=BASE VERIFY=false ts-node --files ./scripts/upgradeLiquidityHub.ts",
     "dry:upgrade-liquidityhub-base-stage": "DRY_RUN=BASE DEPLOY_TYPE=STAGE VERIFY=false ts-node --files ./scripts/upgradeLiquidityHub.ts",

scripts/deployPaxosOracle.ts

@@ -0,0 +1,59 @@
+import dotenv from "dotenv";
+dotenv.config();
+import hre from "hardhat";
+import {getVerifier, getHardhatNetworkConfig, getNetworkConfig, logDeployers} from "./helpers";
+import {isSet, assert, addressToBytes32} from "./common";
+import {PaxosOracle} from "../typechain-types";
+import {Network, NetworkConfig, TokenInfo} from "../network.config";
+
+export async function main() {
+  const [deployer] = await hre.ethers.getSigners();
+
+  assert(isSet(process.env.DEPLOY_ID), "DEPLOY_ID must be set");
+  const verifier = getVerifier(process.env.DEPLOY_ID);
+  console.log(`Deployment ID: ${process.env.DEPLOY_ID}`);
+  let id = "PaxosOracle";
+
+  let network: Network;
+  let config: NetworkConfig;
+  console.log("Deploying PaxosOracle");
+  ({network, config} = await getNetworkConfig());
+  if (!network) {
+    ({network, config} = await getHardhatNetworkConfig());
+    id += "-DeployTest";
+  }
+  await logDeployers();
+
+  const usdc = config.Tokens.USDC.Address;
+  // Only the Paxos stablecoins configured for this network are registered as initial assets.
+  const paxosStablecoins: TokenInfo[] = [config.Tokens.USDG, config.Tokens.PYUSD]
+    .filter((token): token is TokenInfo => Boolean(token));
+  console.log(`USDC: ${usdc}`);
+  console.log(
+    `Paxos stablecoins (1:1 to USDC): ${paxosStablecoins.map(t => t.Address).join(", ") || "none configured"}`
+  );
+
+  const initialAssets = paxosStablecoins.map(t => ({
+    assetId: addressToBytes32(t.Address),
+    decimals: t.Decimals,
+  }));
+
+  const paxosOracle: PaxosOracle = (await verifier.deployX(
+    "PaxosOracle",
+    deployer,
+    {},
+    [
+      config.Admin,
+      usdc,
+      initialAssets,
+    ],
+    id
+  )) as PaxosOracle;
+  console.log(`${id}: ${paxosOracle.target}`);
+
+  await verifier.verify(process.env.VERIFY === "true");
+}
+
+if (process.env.SCRIPT_ENV !== "CI") {
+  main();
+}

scripts/test.ts

@@ -17,6 +17,7 @@ import {main as deployUSDCPublicPool} from "./deployUSDCPublicPool";
 import {main as deployERC4626Adapter} from "./deployERC4626Adapter";
 import {main as deployUSDCProcessor} from "./deployUSDCProcessor";
 import {main as upgradeUSDCProcessor} from "./upgradeUSDCProcessor";
+import {main as deployPaxosOracle} from "./deployPaxosOracle";
 
 async function main() {
   console.log("Test deploy.");
@@ -47,6 +48,8 @@ async function main() {
   await deployUSDCProcessor();
   console.log("Test upgradeUSDCProcessor.");
   await upgradeUSDCProcessor();
+  console.log("Test deployPaxosOracle.");
+  await deployPaxosOracle();
   console.log("Test deployStandaloneRepayer.");
   process.env.STANDALONE_REPAYER_ENV = "SparkStage";
   await deployStandaloneRepayer();