@raac/rpc 2.0.0-beta.22 → 2.0.0-beta.23

package/dist/configs/chains/1.json

@@ -133,6 +133,7 @@
     "psm": {
         "rpsm-susds": {
             "id": "rpsm-sUSDS",
+            "version": "1.0.0",
             "name": "RAAC Peg Stability Module sUSDS",
             "contract": "0xB2102B4d8802648EC6A9e89ACD46b4B799833469",
             "rateProvider": "0x9a6b5BDA2128e6341175c79E43Cd2A7E0C5F5b21"

package/dist/configs/chains/11155111.json

@@ -188,9 +188,10 @@
     "psm": {
         "rpsm-susds": {
             "id": "rpsm-sUSDS",
+            "version": "1.0.0",
             "name": "RAAC Peg Stability Module sUSDS",
-            "contract": "0xbcA54A6E7BeD62Ad3aA5660c0e51FeA1F6A47289",
-            "rateProvider": "0xB3b47F65dFeca20991148BAfe8dc34e1aDb6939b"
+            "contract": "0x1c7Dfbc9bea1d8b6eb33ce8C715dC5313DC3d8B8",
+            "rateProvider": "0xC0508Cf612C507E22E75C89501E7A1F64D634bd9"
         }
     },
     "pools": {
@@ -317,6 +318,20 @@
             "decimals": 6,
             "contract": "0xBBfc1B017954e2F65378b189735dd7be279AbC2A"
         },
+        "usds": {
+            "id": "usds",
+            "name": "USDS",
+            "symbol": "USDS",
+            "decimals": 18,
+            "contract": "0x169e984ec1F8111fA0fe570dD2630621688e82F4"
+        },
+        "susds": {
+            "id": "susds",
+            "name": "Savings USDS",
+            "symbol": "sUSDS",
+            "decimals": 18,
+            "contract": "0xAADD480013475e416cAC2F511697060c920bEE67"
+        },
         "rtoken": {
             "id": "rtoken",
             "name": "RToken",

package/dist/contracts/psm/_helpers.js

@@ -4,7 +4,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePsmVault = resolvePsmVault;
+exports.getPsmVaultMajor = getPsmVaultMajor;
 exports.getPsmVaultContract = getPsmVaultContract;
+exports.getPairingToken = getPairingToken;
+exports.getPairingTokenDecimals = getPairingTokenDecimals;
 exports.getPsmRateProviderContract = getPsmRateProviderContract;
 exports.getDefaultProvider = getDefaultProvider;
 exports.getTokenReaderContract = getTokenReaderContract;
@@ -29,11 +32,38 @@ function resolvePsmVault(chainId, vaultKeyOrAddress) {
         throw new Error(`PSM vault "${vaultKeyOrAddress}" not configured for chain ${chainId}`);
     return { key, entry: psm[key] };
 }
+/** The first PSMVault major that calls the pairing token `pairingToken` instead of `savingsToken`. */
+const PAIRING_TOKEN_RENAME_MAJOR = 3;
+/**
+ * Major version of the vault's implementation, from the config entry's `version`.
+ * @throws When the version is missing, malformed, or has no ABI in this library.
+ */
+function getPsmVaultMajor(entry) {
+    const major = Number(entry.version?.split(".")[0]);
+    if (!Number.isInteger(major) || !(major in artifacts_1.PSM_VAULT_ABIS)) {
+        throw new Error(`PSM vault ${entry.contract} has unsupported version "${entry.version}"`);
+    }
+    return major;
+}
+/**
+ * The vault contract with the ABI of its configured version. Typed as the V1 surface, which every version shares
+ * except the pairing token getters; read those through `getPairingToken` and `getPairingTokenDecimals`.
+ */
 function getPsmVaultContract(chainId, vaultKeyOrAddress, providerOrSigner) {
-    const { key, entry } = resolvePsmVault(chainId, vaultKeyOrAddress);
-    const abi = (0, artifacts_1.getABI)(key);
+    const { entry } = resolvePsmVault(chainId, vaultKeyOrAddress);
+    const abi = artifacts_1.PSM_VAULT_ABIS[getPsmVaultMajor(entry)];
     return new ethers_1.ethers.Contract(entry.contract, abi, providerOrSigner);
 }
+/** The vault's pairing token address: `pairingToken()` from V3 on, `savingsToken()` before. */
+function getPairingToken(vault, major) {
+    return major >= PAIRING_TOKEN_RENAME_MAJOR ? vault.pairingToken() : vault.savingsToken();
+}
+/** The vault's cached pairing token decimals: `pairingTokenDecimals()` from V3 on, `savingsTokenDecimals()` before. */
+function getPairingTokenDecimals(vault, major) {
+    return major >= PAIRING_TOKEN_RENAME_MAJOR
+        ? vault.pairingTokenDecimals()
+        : vault.savingsTokenDecimals();
+}
 function getPsmRateProviderContract(chainId, vaultKeyOrAddress, providerOrSigner) {
     const { entry } = resolvePsmVault(chainId, vaultKeyOrAddress);
     const abi = (0, artifacts_1.getABI)("rateprovider");

package/dist/contracts/psm/getVaultInfo.js

@@ -19,6 +19,7 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
     const contractAddress = entry.contract;
     try {
         const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        const major = (0, _helpers_1.getPsmVaultMajor)(entry);
         const [totalAssets, totalSupply, vaultDecimals, depositCap, swapFee, computeWithdrawFee, withdrawTime, withdrawTimeLimit, dripRate, dripEnd, pendingRewards, vaultComposition, minWithdrawFee, maxWithdrawFee, rebalancer, baseAssetModule, reserveRatioFloor, rebalanceThreshold, dripDuration, paused, circuitBreakerEnabled, navFloor, savingsToken, baseAsset,] = await Promise.all([
             vault.totalAssets(),
             vault.totalSupply(),
@@ -42,7 +43,7 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
             vault.paused(),
             vault.circuitBreakerEnabled(),
             vault.navFloor(),
-            vault.savingsToken(),
+            (0, _helpers_1.getPairingToken)(vault, major),
             vault.asset(),
         ]);
         const savingsTokenContract = (0, _helpers_1.getTokenReaderContract)(savingsToken, provider);
@@ -80,6 +81,7 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
             };
         }
         return {
+            version: entry.version,
             totalAssets: (0, amount_1.toTokenAmount)(chainId, "pmusd", totalAssets),
             totalSupply: (0, amount_1.toAmount)(totalSupply, Number(vaultDecimals), entry.id),
             depositCap: (0, amount_1.toTokenAmount)(chainId, "susds", depositCap),

package/dist/contracts/psm/getVaultSettings.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVaultSettings = getVaultSettings;
+const ethers_1 = require("ethers");
 const _helpers_1 = require("./_helpers");
 const rpcError_1 = require("../../utils/rpcError");
+const EIP1967_ADMIN_SLOT = "0xb53127684a568b3173ae13b9f8a6016e243e63b6e8ee1178d6a717850b5d6103";
 /**
  * Reads a PSM vault's settings from its storage getters only. Unlike `getVaultInfo`, nothing here touches the rate
  * provider, so it still answers when the savings token price is stale (`StalePrice`), which is when an operator
@@ -14,8 +16,10 @@ const rpcError_1 = require("../../utils/rpcError");
 async function getVaultSettings(chainId, vaultKeyOrAddress, provider) {
     const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
     try {
-        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider ?? (0, _helpers_1.getDefaultProvider)(chainId));
-        const [paused, swapFee, minWithdrawFee, maxWithdrawFee, withdrawTime, withdrawTimeLimit, circuitBreakerEnabled, navFloor, reserveRatioFloor, rebalanceThreshold, depositCap, savingsTokenDecimals, baseAsset, savingsToken, rateProvider, rebalancer, baseAssetModule,] = await Promise.all([
+        const reader = provider ?? (0, _helpers_1.getDefaultProvider)(chainId);
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, reader);
+        const major = (0, _helpers_1.getPsmVaultMajor)(entry);
+        const [paused, swapFee, minWithdrawFee, maxWithdrawFee, withdrawTime, withdrawTimeLimit, circuitBreakerEnabled, navFloor, reserveRatioFloor, rebalanceThreshold, depositCap, savingsTokenDecimals, baseAsset, savingsToken, rateProvider, rebalancer, baseAssetModule, adminSlot,] = await Promise.all([
             vault.paused(),
             vault.swapFee(),
             vault.minWithdrawFee(),
@@ -27,14 +31,19 @@ async function getVaultSettings(chainId, vaultKeyOrAddress, provider) {
             vault.reserveRatioFloor(),
             vault.rebalanceThreshold(),
             vault.depositCap(),
-            vault.savingsTokenDecimals(),
+            (0, _helpers_1.getPairingTokenDecimals)(vault, major),
             vault.baseAsset(),
-            vault.savingsToken(),
+            (0, _helpers_1.getPairingToken)(vault, major),
             vault.rateProvider(),
             vault.rebalancer(),
             vault.baseAssetModule(),
+            reader.getStorage(entry.contract, EIP1967_ADMIN_SLOT),
         ]);
+        const admin = ethers_1.ethers.getAddress(ethers_1.ethers.dataSlice(adminSlot, 12));
+        const proxyAdmin = admin === ethers_1.ethers.ZeroAddress ? null : admin;
+        const proxyAdminOwner = proxyAdmin && (await new ethers_1.ethers.Contract(proxyAdmin, ["function owner() view returns (address)"], reader).owner());
         return {
+            version: entry.version,
             paused,
             swapFee,
             minWithdrawFee,
@@ -52,6 +61,8 @@ async function getVaultSettings(chainId, vaultKeyOrAddress, provider) {
             rateProvider,
             rebalancer,
             baseAssetModule,
+            proxyAdmin,
+            proxyAdminOwner,
         };
     }
     catch (error) {

package/dist/types/configs/chains/index.d.ts

@@ -131,6 +131,7 @@ declare const chains: {
         psm: {
             "rpsm-susds": {
                 id: string;
+                version: string;
                 name: string;
                 contract: string;
                 rateProvider: string;
@@ -398,6 +399,7 @@ export declare const configs: {
         psm: {
             "rpsm-susds": {
                 id: string;
+                version: string;
                 name: string;
                 contract: string;
                 rateProvider: string;

package/dist/types/configs/index.d.ts

@@ -131,6 +131,7 @@ declare function getChainsConfig(): {
         psm: {
             "rpsm-susds": {
                 id: string;
+                version: string;
                 name: string;
                 contract: string;
                 rateProvider: string;

package/dist/types/contracts/psm/_helpers.d.ts

@@ -11,7 +11,20 @@ export declare function resolvePsmVault(chainId: ChainId, vaultKeyOrAddress: str
     key: string;
     entry: PsmVaultEntry;
 };
+/**
+ * Major version of the vault's implementation, from the config entry's `version`.
+ * @throws When the version is missing, malformed, or has no ABI in this library.
+ */
+export declare function getPsmVaultMajor(entry: PsmVaultEntry): number;
+/**
+ * The vault contract with the ABI of its configured version. Typed as the V1 surface, which every version shares
+ * except the pairing token getters; read those through `getPairingToken` and `getPairingTokenDecimals`.
+ */
 export declare function getPsmVaultContract(chainId: ChainId, vaultKeyOrAddress: string, providerOrSigner?: Provider | Signer): PSMVault;
+/** The vault's pairing token address: `pairingToken()` from V3 on, `savingsToken()` before. */
+export declare function getPairingToken(vault: PSMVault, major: number): Promise<string>;
+/** The vault's cached pairing token decimals: `pairingTokenDecimals()` from V3 on, `savingsTokenDecimals()` before. */
+export declare function getPairingTokenDecimals(vault: PSMVault, major: number): Promise<bigint>;
 export declare function getPsmRateProviderContract(chainId: ChainId, vaultKeyOrAddress: string, providerOrSigner?: Provider | Signer): RateProvider;
 export declare function getDefaultProvider(chainId: ChainId): Provider;
 export declare function getTokenReaderContract(address: string, providerOrSigner?: Provider | Signer): ethers.Contract;

package/dist/types/contracts/psm/getVaultInfo.d.ts

@@ -11,6 +11,8 @@ export interface PsmVaultUserInfo {
     baseAssetAllowance: TokenAmount;
 }
 export interface PsmVaultInfo {
+    /** Implementation semver from the chain config; its major decides which getters were called. */
+    version: string;
     totalAssets: TokenAmount;
     totalSupply: TokenAmount;
     depositCap: TokenAmount;

package/dist/types/contracts/psm/getVaultSettings.d.ts

@@ -2,6 +2,8 @@ import { Provider } from "ethers";
 import { ChainId } from "../../configs/chains";
 /** The governance-controlled settings of a PSM vault, as stored. */
 export interface PsmVaultSettings {
+    /** Implementation semver from the chain config; its major decides which getters were called. */
+    version: string;
     paused: boolean;
     /** Basis points (of 10_000). */
     swapFee: bigint;
@@ -26,6 +28,10 @@ export interface PsmVaultSettings {
     rateProvider: string;
     rebalancer: string;
     baseAssetModule: string;
+    /** The ProxyAdmin that can upgrade the vault, read from the EIP-1967 admin slot; null when the vault is not a proxy. */
+    proxyAdmin: string | null;
+    /** Who owns the ProxyAdmin, i.e. who can upgrade the vault; null when the vault is not a proxy. */
+    proxyAdminOwner: string | null;
 }
 /**
  * Reads a PSM vault's settings from its storage getters only. Unlike `getVaultInfo`, nothing here touches the rate

package/dist/types/utils/artifacts.d.ts

@@ -1,3 +1,6 @@
+import PSMVaultArtifact from "../artifacts/core/psm/PSMVault.sol/PSMVault.json";
+import PSMVaultV2Artifact from "../artifacts/core/psm/v2/PSMVaultV2.sol/PSMVaultV2.json";
+import PSMVaultV3Artifact from "../artifacts/core/psm/v3/PSMVaultV3.sol/PSMVaultV3.json";
 declare const ABIS: {
     crvusd: ({
         inputs: {
@@ -5588,4 +5591,6 @@ declare const getABI: (name: keyof typeof ABIS) => any[] | ({
     type: string;
     anonymous?: undefined;
 })[];
-export { getABI, ABIS };
+/** PSMVault ABI per implementation major version, matched against the `version` of a chain config `psm` entry. */
+declare const PSM_VAULT_ABIS: Record<number, typeof PSMVaultArtifact.abi | typeof PSMVaultV2Artifact.abi | typeof PSMVaultV3Artifact.abi>;
+export { getABI, ABIS, PSM_VAULT_ABIS };

package/dist/types/utils/contracts.d.ts

@@ -133,6 +133,7 @@ export declare const getConfigs: () => {
         psm: {
             "rpsm-susds": {
                 id: string;
+                version: string;
                 name: string;
                 contract: string;
                 rateProvider: string;
@@ -408,6 +409,7 @@ declare const _default: {
             psm: {
                 "rpsm-susds": {
                     id: string;
+                    version: string;
                     name: string;
                     contract: string;
                     rateProvider: string;

package/dist/utils/artifacts.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ABIS = exports.getABI = void 0;
+exports.PSM_VAULT_ABIS = exports.ABIS = exports.getABI = void 0;
 const crvUSDToken_json_1 = __importDefault(require("../artifacts/mocks/core/tokens/crvUSDToken.sol/crvUSDToken.json")); // assert { type: "json" };
 const pmUSD_json_1 = __importDefault(require("../artifacts/mocks/core/tokens/pmUSD.sol/pmUSD.json")); // assert { type: "json" };
 const xPM_json_1 = __importDefault(require("../artifacts/mocks/core/tokens/xPM.sol/xPM.json")); // assert { type: "json" };
@@ -64,6 +64,8 @@ const AladdinZap_json_1 = __importDefault(require("../artifacts/zap/AladdinZap.s
 // Testnet faucet (hand-written ABI, Sepolia only)
 const Faucet_json_1 = __importDefault(require("../artifacts/faucet/Faucet.json"));
 const PSMVault_json_1 = __importDefault(require("../artifacts/core/psm/PSMVault.sol/PSMVault.json"));
+const PSMVaultV2_json_1 = __importDefault(require("../artifacts/core/psm/v2/PSMVaultV2.sol/PSMVaultV2.json"));
+const PSMVaultV3_json_1 = __importDefault(require("../artifacts/core/psm/v3/PSMVaultV3.sol/PSMVaultV3.json"));
 const RateProvider_json_1 = __importDefault(require("../artifacts/core/psm/RateProvider.sol/RateProvider.json"));
 const CRVUSD_ABI = crvUSDToken_json_1.default.abi;
 const PMUSD_ABI = pmUSD_json_1.default.abi;
@@ -174,3 +176,10 @@ const getABI = (name) => {
     return ABIS[name];
 };
 exports.getABI = getABI;
+/** PSMVault ABI per implementation major version, matched against the `version` of a chain config `psm` entry. */
+const PSM_VAULT_ABIS = {
+    1: PSMVault_json_1.default.abi,
+    2: PSMVaultV2_json_1.default.abi,
+    3: PSMVaultV3_json_1.default.abi,
+};
+exports.PSM_VAULT_ABIS = PSM_VAULT_ABIS;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@raac/rpc",
-	"version": "2.0.0-beta.22",
+	"version": "2.0.0-beta.23",
 	"description": "RPC Library for RAAC",
 	"main": "dist/index.js",
 	"types": "dist/types/index.d.ts",