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

package/dist/RPCLibrary.js

@@ -193,6 +193,7 @@ const requestWithdraw_1 = require("./pools/stabilityPool/requestWithdraw");
 // PSM
 const getVaultInfo_1 = require("./contracts/psm/getVaultInfo");
 const getVaultSettings_1 = require("./contracts/psm/getVaultSettings");
+const listVaults_1 = require("./contracts/psm/listVaults");
 const getState_3 = __importDefault(require("./contracts/housePrices/getState"));
 const getState_4 = __importDefault(require("./contracts/crvUSDToUSDOracle/getState"));
 const getRoles_1 = __importDefault(require("./contracts/getRoles"));
@@ -800,6 +801,7 @@ class RPCLibrary {
             },
         };
         this.psm = {
+            listVaults: listVaults_1.listVaults,
             getVaultInfo: getVaultInfo_1.getVaultInfo,
             getVaultSettings: getVaultSettings_1.getVaultSettings,
             previewDeposit: previewDeposit_2.previewDeposit,

package/dist/configs/chains/1.json

@@ -136,7 +136,10 @@
             "version": "1.0.0",
             "name": "RAAC Peg Stability Module sUSDS",
             "contract": "0xB2102B4d8802648EC6A9e89ACD46b4B799833469",
-            "rateProvider": "0x9a6b5BDA2128e6341175c79E43Cd2A7E0C5F5b21"
+            "rateProvider": "0x9a6b5BDA2128e6341175c79E43Cd2A7E0C5F5b21",
+            "pairingToken": "susds",
+            "baseAsset": "pmusd",
+            "shareToken": "rpsm-susds"
         }
     },
     "pools": {
@@ -182,6 +185,13 @@
             "decimals": 18,
             "contract": "0xa3931d71877C0E7a3148CB7Eb4463524FEc27fbD"
         },
+        "rpsm-susds": {
+            "id": "rpsm-susds",
+            "name": "RAAC PSM sUSDS Share",
+            "symbol": "rpsm-sUSDS",
+            "decimals": 18,
+            "contract": "0xB2102B4d8802648EC6A9e89ACD46b4B799833469"
+        },
         "xpm": {
             "id": "xpm",
             "name": "xPM",

package/dist/configs/chains/11155111.json

@@ -191,7 +191,10 @@
             "version": "1.0.0",
             "name": "RAAC Peg Stability Module sUSDS",
             "contract": "0x1c7Dfbc9bea1d8b6eb33ce8C715dC5313DC3d8B8",
-            "rateProvider": "0xC0508Cf612C507E22E75C89501E7A1F64D634bd9"
+            "rateProvider": "0xC0508Cf612C507E22E75C89501E7A1F64D634bd9",
+            "pairingToken": "susds",
+            "baseAsset": "pmusd",
+            "shareToken": "rpsm-susds"
         }
     },
     "pools": {
@@ -246,6 +249,13 @@
             "flavour": "stableswap",
             "coins": ["pmusd", "usdc"]
         },
+        "pmusd-susds": {
+            "id": "pmusd-susds",
+            "name": "pmUSD / sUSDS",
+            "contract": "0xdDCD3229FD143aFCdE31bA2FfA3B23C62d5F688b",
+            "flavour": "stableswap",
+            "coins": ["pmusd", "susds"]
+        },
         "leraac-raac-pmusd": {
             "id": "leraac-raac-pmusd",
             "name": "leRAAC / RAAC / pmUSD",
@@ -332,6 +342,13 @@
             "decimals": 18,
             "contract": "0xAADD480013475e416cAC2F511697060c920bEE67"
         },
+        "rpsm-susds": {
+            "id": "rpsm-susds",
+            "name": "RAAC PSM sUSDS Share",
+            "symbol": "rpsm-sUSDS",
+            "decimals": 18,
+            "contract": "0x1c7Dfbc9bea1d8b6eb33ce8C715dC5313DC3d8B8"
+        },
         "rtoken": {
             "id": "rtoken",
             "name": "RToken",

package/dist/contracts/psm/_helpers.js

@@ -4,6 +4,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolvePsmVault = resolvePsmVault;
+exports.getPsmVaults = getPsmVaults;
+exports.resolvePsmAsset = resolvePsmAsset;
 exports.getPsmVaultMajor = getPsmVaultMajor;
 exports.getPsmVaultContract = getPsmVaultContract;
 exports.getPairingToken = getPairingToken;
@@ -32,6 +34,21 @@ function resolvePsmVault(chainId, vaultKeyOrAddress) {
         throw new Error(`PSM vault "${vaultKeyOrAddress}" not configured for chain ${chainId}`);
     return { key, entry: psm[key] };
 }
+/** The PSM vaults configured on `chainId`, keyed by config key; empty when the chain has none. */
+function getPsmVaults(chainId) {
+    return chains_1.default[chainId]?.psm ?? {};
+}
+/**
+ * The `assets` entry a PSM vault refers to by key (its pairing token, base asset or share token).
+ * @throws When the chain has no such asset, so a misconfigured vault fails loudly instead of formatting with 18 decimals.
+ */
+function resolvePsmAsset(chainId, assetKey) {
+    const assets = chains_1.default[chainId]?.assets;
+    const asset = assets?.[assetKey];
+    if (!asset)
+        throw new Error(`PSM asset "${assetKey}" not configured for chain ${chainId}`);
+    return asset;
+}
 /** The first PSMVault major that calls the pairing token `pairingToken` instead of `savingsToken`. */
 const PAIRING_TOKEN_RENAME_MAJOR = 3;
 /**

package/dist/contracts/psm/getVaultInfo.js

@@ -17,6 +17,7 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
         provider = (0, _helpers_1.getDefaultProvider)(chainId);
     const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
     const contractAddress = entry.contract;
+    const { pairingToken: pairingKey, baseAsset: baseKey } = entry;
     try {
         const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
         const major = (0, _helpers_1.getPsmVaultMajor)(entry);
@@ -76,32 +77,32 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
                     shares: (0, amount_1.toAmount)(redeemRequest[0], Number(vaultDecimals), entry.id),
                     exitTime: Number(redeemRequest[1]),
                 },
-                savingsTokenAllowance: (0, amount_1.toTokenAmount)(chainId, "susds", savingsTokenAllowance),
-                baseAssetAllowance: (0, amount_1.toTokenAmount)(chainId, "pmusd", baseAssetAllowance),
+                savingsTokenAllowance: (0, amount_1.toTokenAmount)(chainId, pairingKey, savingsTokenAllowance),
+                baseAssetAllowance: (0, amount_1.toTokenAmount)(chainId, baseKey, baseAssetAllowance),
             };
         }
         return {
             version: entry.version,
-            totalAssets: (0, amount_1.toTokenAmount)(chainId, "pmusd", totalAssets),
+            totalAssets: (0, amount_1.toTokenAmount)(chainId, baseKey, totalAssets),
             totalSupply: (0, amount_1.toAmount)(totalSupply, Number(vaultDecimals), entry.id),
-            depositCap: (0, amount_1.toTokenAmount)(chainId, "susds", depositCap),
+            depositCap: (0, amount_1.toTokenAmount)(chainId, pairingKey, depositCap),
             swapFee,
             computeWithdrawFee,
             withdrawTime: Number(withdrawTime),
             withdrawTimeLimit: Number(withdrawTimeLimit),
-            dripRate: (0, amount_1.toTokenAmount)(chainId, "pmusd", dripRate),
+            dripRate: (0, amount_1.toTokenAmount)(chainId, baseKey, dripRate),
             dripEnd: Number(dripEnd),
-            pendingRewards: (0, amount_1.toTokenAmount)(chainId, "pmusd", pendingRewards),
+            pendingRewards: (0, amount_1.toTokenAmount)(chainId, baseKey, pendingRewards),
             vaultComposition: {
-                baseAssetValue: (0, amount_1.toTokenAmount)(chainId, "pmusd", vaultComposition[0]),
-                savingsTokenValue: (0, amount_1.toTokenAmount)(chainId, "pmusd", vaultComposition[1]),
-                total: (0, amount_1.toTokenAmount)(chainId, "pmusd", vaultComposition[2]),
+                baseAssetValue: (0, amount_1.toTokenAmount)(chainId, baseKey, vaultComposition[0]),
+                savingsTokenValue: (0, amount_1.toTokenAmount)(chainId, baseKey, vaultComposition[1]),
+                total: (0, amount_1.toTokenAmount)(chainId, baseKey, vaultComposition[2]),
             },
             minWithdrawFee,
             maxWithdrawFee,
             rebalancer,
             baseAssetModule: baseAssetModule && baseAssetModule !== ZERO_ADDRESS ? baseAssetModule : null,
-            rebalanceThreshold: (0, amount_1.toTokenAmount)(chainId, "pmusd", rebalanceThreshold),
+            rebalanceThreshold: (0, amount_1.toTokenAmount)(chainId, baseKey, rebalanceThreshold),
             reserveRatioFloor: (0, amount_1.toScaled)(reserveRatioFloor),
             dripDuration: Number(dripDuration),
             paused,
@@ -110,7 +111,7 @@ async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
             savingsToken,
             baseAsset,
             savingsTokenRate: (0, amount_1.toScaled)(savingsTokenRate),
-            vaultSavingsTokenBalance: (0, amount_1.toTokenAmount)(chainId, "susds", vaultSavingsTokenBalance),
+            vaultSavingsTokenBalance: (0, amount_1.toTokenAmount)(chainId, pairingKey, vaultSavingsTokenBalance),
             moduleVaultBalance,
             moduleConvertToAssets,
             user,

package/dist/contracts/psm/listVaults.js

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.listVaults = listVaults;
+const _helpers_1 = require("./_helpers");
+/**
+ * Lists the PSM vaults configured on a chain, in config order, with their pairing token, base asset and share token
+ * resolved from the chain's `assets`. Reads no chain state.
+ * @param chainId - The chain/network to use.
+ * @returns An empty list for a chain without PSM vaults.
+ * @throws When a vault refers to an asset key the chain does not configure.
+ */
+function listVaults(chainId) {
+    return Object.entries((0, _helpers_1.getPsmVaults)(chainId)).map(([key, entry]) => {
+        const withKey = (assetKey) => ({ ...(0, _helpers_1.resolvePsmAsset)(chainId, assetKey), key: assetKey });
+        return {
+            key,
+            id: entry.id,
+            name: entry.name,
+            version: entry.version,
+            contract: entry.contract,
+            rateProvider: entry.rateProvider,
+            pairingToken: withKey(entry.pairingToken),
+            baseAsset: withKey(entry.baseAsset),
+            shareToken: withKey(entry.shareToken),
+        };
+    });
+}

package/dist/types/RPCLibrary.d.ts

@@ -134,6 +134,7 @@ import { getWithdrawTimelockConfig as getStabilityPoolWithdrawTimelockConfig } f
 import { requestWithdraw as requestStabilityPoolWithdraw } from "./pools/stabilityPool/requestWithdraw";
 import { getVaultInfo as getPsmVaultInfo } from "./contracts/psm/getVaultInfo";
 import { getVaultSettings as getPsmVaultSettings } from "./contracts/psm/getVaultSettings";
+import { listVaults as listPsmVaults } from "./contracts/psm/listVaults";
 import getHousePricesState from "./contracts/housePrices/getState";
 import getCrvUSDToUSDOracleState from "./contracts/crvUSDToUSDOracle/getState";
 import getRoles from "./contracts/getRoles";
@@ -682,6 +683,7 @@ declare class RPCLibrary {
         };
     };
     psm: {
+        listVaults: typeof listPsmVaults;
         getVaultInfo: typeof getPsmVaultInfo;
         getVaultSettings: typeof getPsmVaultSettings;
         previewDeposit: typeof previewDepositPsm;

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

@@ -135,6 +135,9 @@ declare const chains: {
                 name: string;
                 contract: string;
                 rateProvider: string;
+                pairingToken: string;
+                baseAsset: string;
+                shareToken: string;
             };
         };
         pools: {
@@ -180,6 +183,13 @@ declare const chains: {
                 decimals: number;
                 contract: string;
             };
+            "rpsm-susds": {
+                id: string;
+                name: string;
+                symbol: string;
+                decimals: number;
+                contract: string;
+            };
             xpm: {
                 id: string;
                 name: string;
@@ -403,6 +413,9 @@ export declare const configs: {
                 name: string;
                 contract: string;
                 rateProvider: string;
+                pairingToken: string;
+                baseAsset: string;
+                shareToken: string;
             };
         };
         pools: {
@@ -448,6 +461,13 @@ export declare const configs: {
                 decimals: number;
                 contract: string;
             };
+            "rpsm-susds": {
+                id: string;
+                name: string;
+                symbol: string;
+                decimals: number;
+                contract: string;
+            };
             xpm: {
                 id: string;
                 name: string;

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

@@ -135,6 +135,9 @@ declare function getChainsConfig(): {
                 name: string;
                 contract: string;
                 rateProvider: string;
+                pairingToken: string;
+                baseAsset: string;
+                shareToken: string;
             };
         };
         pools: {
@@ -180,6 +183,13 @@ declare function getChainsConfig(): {
                 decimals: number;
                 contract: string;
             };
+            "rpsm-susds": {
+                id: string;
+                name: string;
+                symbol: string;
+                decimals: number;
+                contract: string;
+            };
             xpm: {
                 id: string;
                 name: string;

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

@@ -1,6 +1,6 @@
 import { ethers, Provider, Signer } from "ethers";
 import { ChainId } from "../../configs/chains";
-import { PsmVaultEntry } from "../../configs/chains/chain";
+import { Asset, Psm, PsmVaultEntry } from "../../configs/chains/chain";
 import { PSMVault } from "../../typechain-types/psm/PSMVault";
 import { RateProvider } from "../../typechain-types/psm/RateProvider";
 /**
@@ -11,6 +11,13 @@ export declare function resolvePsmVault(chainId: ChainId, vaultKeyOrAddress: str
     key: string;
     entry: PsmVaultEntry;
 };
+/** The PSM vaults configured on `chainId`, keyed by config key; empty when the chain has none. */
+export declare function getPsmVaults(chainId: ChainId): Psm;
+/**
+ * The `assets` entry a PSM vault refers to by key (its pairing token, base asset or share token).
+ * @throws When the chain has no such asset, so a misconfigured vault fails loudly instead of formatting with 18 decimals.
+ */
+export declare function resolvePsmAsset(chainId: ChainId, assetKey: string): Asset;
 /**
  * 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.

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

@@ -0,0 +1,34 @@
+import { ChainId } from "../../configs/chains";
+import { Asset } from "../../configs/chains/chain";
+/** A configured PSM vault with its tokens resolved from the chain's `assets`. */
+export interface PsmVaultDescriptor {
+    /** Config key, e.g. "rpsm-susds"; accepted by every `psm.*` call in place of the address. */
+    key: string;
+    id: string;
+    name: string;
+    /** Implementation semver; its major decides which getters the `psm.*` reads call. */
+    version: string;
+    /** The vault contract, which is also its share token. */
+    contract: string;
+    rateProvider: string;
+    /** The token deposited into the vault and swapped against the base asset, with its `assets` key. */
+    pairingToken: Asset & {
+        key: string;
+    };
+    /** The vault's base asset (pmUSD), with its `assets` key. */
+    baseAsset: Asset & {
+        key: string;
+    };
+    /** The vault's share token, with its `assets` key. */
+    shareToken: Asset & {
+        key: string;
+    };
+}
+/**
+ * Lists the PSM vaults configured on a chain, in config order, with their pairing token, base asset and share token
+ * resolved from the chain's `assets`. Reads no chain state.
+ * @param chainId - The chain/network to use.
+ * @returns An empty list for a chain without PSM vaults.
+ * @throws When a vault refers to an asset key the chain does not configure.
+ */
+export declare function listVaults(chainId: ChainId): PsmVaultDescriptor[];

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

@@ -137,6 +137,9 @@ export declare const getConfigs: () => {
                 name: string;
                 contract: string;
                 rateProvider: string;
+                pairingToken: string;
+                baseAsset: string;
+                shareToken: string;
             };
         };
         pools: {
@@ -182,6 +185,13 @@ export declare const getConfigs: () => {
                 decimals: number;
                 contract: string;
             };
+            "rpsm-susds": {
+                id: string;
+                name: string;
+                symbol: string;
+                decimals: number;
+                contract: string;
+            };
             xpm: {
                 id: string;
                 name: string;
@@ -413,6 +423,9 @@ declare const _default: {
                     name: string;
                     contract: string;
                     rateProvider: string;
+                    pairingToken: string;
+                    baseAsset: string;
+                    shareToken: string;
                 };
             };
             pools: {
@@ -458,6 +471,13 @@ declare const _default: {
                     decimals: number;
                     contract: string;
                 };
+                "rpsm-susds": {
+                    id: string;
+                    name: string;
+                    symbol: string;
+                    decimals: number;
+                    contract: string;
+                };
                 xpm: {
                     id: string;
                     name: string;

package/package.json

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