@raac/rpc 2.0.0-beta.1 → 2.0.0-beta.3

package/dist/contracts/pmBlender/previewWithdraw.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Previews how many pmBlender tokens are burned to withdraw an exact amount of a supported token.
  * @param chainId The chain id.
@@ -11,14 +12,13 @@ const _helpers_1 = require("./_helpers");
  * @returns The pmBlender tokens burned, in the pmBlender token (registry decimals and symbol, else 18 decimals: TokenBlender is an 18-decimal ERC20).
  */
 async function previewWithdraw(chainId, token, amountOut, provider) {
+    const { contract, address } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
     try {
-        const { contract, address } = (0, _helpers_1.getPmBlenderContract)(chainId, provider);
         const result = await contract.previewWithdraw(token, amountOut);
         return (0, amount_1.toTokenAmount)(chainId, address, result);
     }
     catch (error) {
-        console.error("Error getting pm blender preview withdraw:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmBlender.previewWithdraw", error, { chainId, address });
     }
 }
 exports.default = previewWithdraw;

package/dist/contracts/pmMarket/getMarketConfig.js

@@ -5,6 +5,7 @@ const contracts_1 = require("../../utils/contracts");
 const artifacts_1 = require("../../utils/artifacts");
 const index_1 = require("../../configs/chains/index");
 const amount_1 = require("../../utils/amount");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the pmMarket (f(x) v1 Market) `marketConfig`.
  * @param chainId The chain id.
@@ -12,9 +13,9 @@ const amount_1 = require("../../utils/amount");
  * @returns The ratio thresholds, each scaled by 1e18.
  */
 async function getMarketConfig(chainId, provider) {
+    const pmMarketAddress = (0, contracts_1.getContractAddress)(chainId, "pmmarket");
     try {
         const runner = provider ?? new ethers_1.ethers.JsonRpcProvider(index_1.configs[chainId].rpcs[0]);
-        const pmMarketAddress = (0, contracts_1.getContractAddress)(chainId, "pmmarket");
         const pmMarketABI = (0, artifacts_1.getABI)("pmmarket");
         const pmMarketContract = new ethers_1.ethers.Contract(pmMarketAddress, pmMarketABI, runner);
         const marketConfig = await pmMarketContract.marketConfig();
@@ -26,8 +27,7 @@ async function getMarketConfig(chainId, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting pm market config:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmMarket.getMarketConfig", error, { chainId, address: pmMarketAddress });
     }
 }
 exports.default = getMarketConfig;

package/dist/contracts/pmTreasury/getCollateralRatio.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the pmTreasury collateral ratio.
  * @param chainId The chain id.
@@ -9,6 +11,7 @@ const _helpers_1 = require("./_helpers");
  * @returns The collateral ratio scaled by 1e18 (`decimals: 18`, 1.5e18 = 150%).
  */
 async function getCollateralRatio(chainId, provider) {
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -16,8 +19,7 @@ async function getCollateralRatio(chainId, provider) {
         return (0, amount_1.toScaled)(collateralRatio, amount_1.WAD_DECIMALS);
     }
     catch (error) {
-        console.error("Error getting collateral ratio:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getCollateralRatio", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getCollateralRatio;

package/dist/contracts/pmTreasury/getCurrentNav.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the current NAVs of the base token, pmUSD and xPM.
  * @param chainId The chain id.
@@ -9,6 +11,7 @@ const _helpers_1 = require("./_helpers");
  * @returns The NAVs, each scaled by 1e18.
  */
 async function getCurrentNav(chainId, provider) {
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -20,8 +23,7 @@ async function getCurrentNav(chainId, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting current nav:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getCurrentNav", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getCurrentNav;

package/dist/contracts/pmTreasury/getLeverageRatio.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the pmTreasury EMA leverage ratio of xPM.
  * @param chainId The chain id.
@@ -9,6 +11,7 @@ const _helpers_1 = require("./_helpers");
  * @returns The leverage ratio scaled by 1e18 (`decimals: 18`, 2e18 = 2x).
  */
 async function getLeverageRatio(chainId, provider) {
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -16,8 +19,7 @@ async function getLeverageRatio(chainId, provider) {
         return (0, amount_1.toScaled)(leverageRatio, amount_1.WAD_DECIMALS);
     }
     catch (error) {
-        console.error("Error getting leverage ratio:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getLeverageRatio", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getLeverageRatio;

package/dist/contracts/pmTreasury/getMaxMintablePMUSD.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the most pmUSD mintable, and the base token needed, before the collateral ratio falls to `newCollateralRatio`.
  * @param chainId The chain id.
@@ -11,6 +13,7 @@ const _helpers_1 = require("./_helpers");
  */
 async function getMaxMintablePMUSD(chainId, newCollateralRatio, provider) {
     (0, _helpers_1.assertCollateralRatio)(newCollateralRatio);
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -21,8 +24,7 @@ async function getMaxMintablePMUSD(chainId, newCollateralRatio, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting max mintable PMUSD:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getMaxMintablePMUSD", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getMaxMintablePMUSD;

package/dist/contracts/pmTreasury/getMaxMintablePMUSDWithoutBaseToken.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the most pmUSD mintable without depositing base token before the collateral ratio falls to `newCollateralRatio`.
  * @param chainId The chain id.
@@ -11,6 +13,7 @@ const _helpers_1 = require("./_helpers");
  */
 async function getMaxMintablePMUSDWithoutBaseToken(chainId, newCollateralRatio, provider) {
     (0, _helpers_1.assertCollateralRatio)(newCollateralRatio);
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -20,8 +23,7 @@ async function getMaxMintablePMUSDWithoutBaseToken(chainId, newCollateralRatio,
         };
     }
     catch (error) {
-        console.error("Error getting max mintable PMUSD:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getMaxMintablePMUSDWithoutBaseToken", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getMaxMintablePMUSDWithoutBaseToken;

package/dist/contracts/pmTreasury/getMaxMintableXPM.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the most xPM mintable, and the base token needed, before the collateral ratio rises to `newCollateralRatio`.
  * @param chainId The chain id.
@@ -11,6 +13,7 @@ const _helpers_1 = require("./_helpers");
  */
 async function getMaxMintableXPM(chainId, newCollateralRatio, provider) {
     (0, _helpers_1.assertCollateralRatio)(newCollateralRatio);
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -21,8 +24,7 @@ async function getMaxMintableXPM(chainId, newCollateralRatio, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting max mintable XPM:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getMaxMintableXPM", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getMaxMintableXPM;

package/dist/contracts/pmTreasury/getMaxRedeemablePMUSD.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the most pmUSD redeemable, and the base token received, before the collateral ratio rises to `newCollateralRatio`.
  * @param chainId The chain id.
@@ -11,6 +13,7 @@ const _helpers_1 = require("./_helpers");
  */
 async function getMaxRedeemablePMUSD(chainId, newCollateralRatio, provider) {
     (0, _helpers_1.assertCollateralRatio)(newCollateralRatio);
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -21,8 +24,7 @@ async function getMaxRedeemablePMUSD(chainId, newCollateralRatio, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting max redeemable PMUSD:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getMaxRedeemablePMUSD", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getMaxRedeemablePMUSD;

package/dist/contracts/pmTreasury/getMaxRedeemableXPM.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the most xPM redeemable, and the base token received, before the collateral ratio falls to `newCollateralRatio`.
  * @param chainId The chain id.
@@ -11,6 +13,7 @@ const _helpers_1 = require("./_helpers");
  */
 async function getMaxRedeemableXPM(chainId, newCollateralRatio, provider) {
     (0, _helpers_1.assertCollateralRatio)(newCollateralRatio);
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -21,8 +24,7 @@ async function getMaxRedeemableXPM(chainId, newCollateralRatio, provider) {
         };
     }
     catch (error) {
-        console.error("Error getting max redeemable XPM:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getMaxRedeemableXPM", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getMaxRedeemableXPM;

package/dist/contracts/pmTreasury/getTotalBaseToken.js

@@ -2,6 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const amount_1 = require("../../utils/amount");
 const _helpers_1 = require("./_helpers");
+const contracts_1 = require("../../utils/contracts");
+const rpcError_1 = require("../../utils/rpcError");
 /**
  * Reads the amount of base token held by the pmTreasury.
  * @param chainId The chain id.
@@ -9,6 +11,7 @@ const _helpers_1 = require("./_helpers");
  * @returns The base token amount, with 18 decimals (fixed by the treasury math).
  */
 async function getTotalBaseToken(chainId, provider) {
+    const contractAddress = (0, contracts_1.getContractAddress)(chainId, "pmtreasury");
     try {
         const runner = (0, _helpers_1.resolvePmTreasuryProvider)(chainId, provider);
         const pmTreasuryContract = (0, _helpers_1.getPmTreasuryContract)(chainId, runner);
@@ -16,8 +19,7 @@ async function getTotalBaseToken(chainId, provider) {
         return (0, amount_1.toAmount)(totalBaseToken, _helpers_1.BASE_TOKEN_DECIMALS);
     }
     catch (error) {
-        console.error("Error getting total base token:", error);
-        throw error;
+        throw (0, rpcError_1.toRpcError)("pmTreasury.getTotalBaseToken", error, { chainId, address: contractAddress });
     }
 }
 exports.default = getTotalBaseToken;

package/dist/contracts/psm/_helpers.js

@@ -0,0 +1,68 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.resolvePsmVault = resolvePsmVault;
+exports.getPsmVaultContract = getPsmVaultContract;
+exports.getPsmRateProviderContract = getPsmRateProviderContract;
+exports.getDefaultProvider = getDefaultProvider;
+exports.getTokenReaderContract = getTokenReaderContract;
+exports.getModuleContract = getModuleContract;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../configs/chains"));
+const artifacts_1 = require("../../utils/artifacts");
+/**
+ * Resolves a PSM vault entry by its config key (any casing) or its deployed
+ * address, since callers may have either on hand.
+ */
+function resolvePsmVault(chainId, vaultKeyOrAddress) {
+    const psm = chains_1.default[chainId]?.psm;
+    if (!psm)
+        throw new Error(`No PSM vaults configured for chain ${chainId}`);
+    const needle = vaultKeyOrAddress.toLowerCase();
+    let key = needle in psm ? needle : undefined;
+    if (!key) {
+        key = Object.keys(psm).find((k) => psm[k].contract.toLowerCase() === needle);
+    }
+    if (!key)
+        throw new Error(`PSM vault "${vaultKeyOrAddress}" not configured for chain ${chainId}`);
+    return { key, entry: psm[key] };
+}
+function getPsmVaultContract(chainId, vaultKeyOrAddress, providerOrSigner) {
+    const { key, entry } = resolvePsmVault(chainId, vaultKeyOrAddress);
+    const abi = (0, artifacts_1.getABI)(key);
+    return new ethers_1.ethers.Contract(entry.contract, abi, providerOrSigner);
+}
+function getPsmRateProviderContract(chainId, vaultKeyOrAddress, providerOrSigner) {
+    const { entry } = resolvePsmVault(chainId, vaultKeyOrAddress);
+    const abi = (0, artifacts_1.getABI)("rateprovider");
+    return new ethers_1.ethers.Contract(entry.rateProvider, abi, providerOrSigner);
+}
+function getDefaultProvider(chainId) {
+    const rpc = chains_1.default[chainId].rpcs[0];
+    return new ethers_1.ethers.JsonRpcProvider(rpc);
+}
+/**
+ * Minimal read-only ERC20 surface, for the vault's savings token and base
+ * asset. Neither necessarily has a compiled artifact in this library (the
+ * savings token is a third-party token) - reads only, no `approve`; use
+ * `wallet.assets.approveAsset` for approvals instead.
+ */
+const ERC20_READ_ABI = [
+    "function balanceOf(address) view returns (uint256)",
+    "function allowance(address owner, address spender) view returns (uint256)",
+    "function decimals() view returns (uint8)",
+    "function symbol() view returns (string)",
+];
+function getTokenReaderContract(address, providerOrSigner) {
+    return new ethers_1.ethers.Contract(address, ERC20_READ_ABI, providerOrSigner);
+}
+/** Minimal read-only surface for a vault's base asset module (rebalancer target), when one is configured. */
+const PSM_MODULE_ABI = [
+    "function balanceOf(address) view returns (uint256)",
+    "function convertToAssets(uint256 shares) view returns (uint256)",
+];
+function getModuleContract(address, providerOrSigner) {
+    return new ethers_1.ethers.Contract(address, PSM_MODULE_ABI, providerOrSigner);
+}

package/dist/contracts/psm/cancelExit.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.cancelExit = cancelExit;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/** Cancels a pending exit request from a PSM vault. */
+async function cancelExit(chainId, vaultKeyOrAddress, signer) {
+    if (!signer) {
+        throw new Error("Signer is required");
+    }
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, signer);
+        const tx = await vault.cancelExit();
+        return await tx.wait();
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.cancelExit", error, { chainId, address: entry.contract });
+    }
+}

package/dist/contracts/psm/deposit.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.deposit = deposit;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/**
+ * Deposits savings token into a PSM vault for shares.
+ * @param savingsAmount The amount to deposit, in savings token base units.
+ * @param minSharesOut The minimum shares to accept, in share base units.
+ * @param receiver The address to receive the shares.
+ */
+async function deposit(chainId, vaultKeyOrAddress, savingsAmount, minSharesOut, receiver, signer) {
+    if (!signer) {
+        throw new Error("Signer is required");
+    }
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, signer);
+        const tx = await vault.deposit(savingsAmount, minSharesOut, receiver);
+        return await tx.wait();
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.deposit", error, { chainId, address: entry.contract });
+    }
+}

package/dist/contracts/psm/getVaultInfo.js

@@ -0,0 +1,126 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getVaultInfo = getVaultInfo;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+const amount_1 = require("../../utils/amount");
+const ZERO_ADDRESS = "0x0000000000000000000000000000000000000000";
+/**
+ * Gets aggregate and (optionally) user-specific info for a PSM vault.
+ * @param chainId - The chain/network to use.
+ * @param vaultKeyOrAddress - The vault's config key (e.g. "rpsm-sUSDS") or its deployed address.
+ * @param userAddress - When given, also returns the user's balances, allowances and redeem request.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+async function getVaultInfo(chainId, vaultKeyOrAddress, userAddress, provider) {
+    if (!provider)
+        provider = (0, _helpers_1.getDefaultProvider)(chainId);
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    const contractAddress = entry.contract;
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        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(),
+            vault.decimals(),
+            vault.depositCap(),
+            vault.swapFee(),
+            vault.computeWithdrawFee(),
+            vault.withdrawTime(),
+            vault.withdrawTimeLimit(),
+            vault.dripRate(),
+            vault.dripEnd(),
+            vault.pendingRewards(),
+            vault.vaultComposition(),
+            vault.minWithdrawFee(),
+            vault.maxWithdrawFee(),
+            vault.rebalancer(),
+            vault.baseAssetModule(),
+            vault.reserveRatioFloor(),
+            vault.rebalanceThreshold(),
+            vault.DRIP_DURATION(),
+            vault.paused(),
+            vault.circuitBreakerEnabled(),
+            vault.navFloor(),
+            vault.savingsToken(),
+            vault.asset(),
+        ]);
+        const savingsTokenContract = (0, _helpers_1.getTokenReaderContract)(savingsToken, provider);
+        const rateProvider = (0, _helpers_1.getPsmRateProviderContract)(chainId, vaultKeyOrAddress, provider);
+        const [savingsTokenRate, vaultSavingsTokenBalance] = await Promise.all([
+            rateProvider.getRate(savingsToken),
+            savingsTokenContract.balanceOf(contractAddress),
+        ]);
+        let moduleVaultBalance = null;
+        let moduleConvertToAssets = null;
+        if (baseAssetModule && baseAssetModule !== ZERO_ADDRESS) {
+            const module = (0, _helpers_1.getModuleContract)(baseAssetModule, provider);
+            const [balance, convertToAssets] = await Promise.all([
+                module.balanceOf(contractAddress),
+                module.convertToAssets(10n ** 18n),
+            ]);
+            moduleVaultBalance = balance;
+            moduleConvertToAssets = (0, amount_1.toScaled)(convertToAssets);
+        }
+        let user = null;
+        if (userAddress) {
+            const baseAssetContract = (0, _helpers_1.getTokenReaderContract)(baseAsset, provider);
+            const [shareBalance, savingsTokenBalance, baseAssetBalance, redeemRequest, savingsTokenAllowance, baseAssetAllowance] = await Promise.all([
+                vault.balanceOf(userAddress),
+                savingsTokenContract.balanceOf(userAddress),
+                baseAssetContract.balanceOf(userAddress),
+                vault.redeemRequests(userAddress),
+                savingsTokenContract.allowance(userAddress, contractAddress),
+                baseAssetContract.allowance(userAddress, contractAddress),
+            ]);
+            user = {
+                shareBalance: (0, amount_1.toAmount)(shareBalance, Number(vaultDecimals), entry.id),
+                savingsTokenBalance: (0, amount_1.toTokenAmount)(chainId, "susds", savingsTokenBalance),
+                baseAssetBalance: (0, amount_1.toTokenAmount)(chainId, "pmusd", baseAssetBalance),
+                redeemRequest: {
+                    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),
+            };
+        }
+        return {
+            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),
+            swapFee,
+            computeWithdrawFee,
+            withdrawTime: Number(withdrawTime),
+            withdrawTimeLimit: Number(withdrawTimeLimit),
+            dripRate: (0, amount_1.toTokenAmount)(chainId, "pmusd", dripRate),
+            dripEnd: Number(dripEnd),
+            pendingRewards: (0, amount_1.toTokenAmount)(chainId, "pmusd", 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]),
+            },
+            minWithdrawFee,
+            maxWithdrawFee,
+            rebalancer,
+            baseAssetModule: baseAssetModule && baseAssetModule !== ZERO_ADDRESS ? baseAssetModule : null,
+            rebalanceThreshold: (0, amount_1.toTokenAmount)(chainId, "pmusd", rebalanceThreshold),
+            reserveRatioFloor: (0, amount_1.toScaled)(reserveRatioFloor),
+            dripDuration: Number(dripDuration),
+            paused,
+            circuitBreakerEnabled,
+            navFloor: (0, amount_1.toScaled)(navFloor),
+            savingsToken,
+            baseAsset,
+            savingsTokenRate: (0, amount_1.toScaled)(savingsTokenRate),
+            vaultSavingsTokenBalance: (0, amount_1.toTokenAmount)(chainId, "susds", vaultSavingsTokenBalance),
+            moduleVaultBalance,
+            moduleConvertToAssets,
+            user,
+        };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.getVaultInfo", error, { chainId, address: contractAddress });
+    }
+}

package/dist/contracts/psm/previewDeposit.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewDeposit = previewDeposit;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/**
+ * Previews depositing `savingsAmount` (savings token base units) into a PSM vault.
+ * @returns The shares out, in share base units.
+ */
+async function previewDeposit(chainId, vaultKeyOrAddress, savingsAmount, provider) {
+    if (!provider)
+        provider = (0, _helpers_1.getDefaultProvider)(chainId);
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        return await vault.previewDeposit(savingsAmount);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.previewDeposit", error, { chainId, address: entry.contract });
+    }
+}

package/dist/contracts/psm/previewProportionalSplit.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewProportionalSplit = previewProportionalSplit;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/** @returns The 3-way split of `entitlement` across the module token, base asset, and savings token. */
+async function previewProportionalSplit(chainId, vaultKeyOrAddress, entitlement, provider) {
+    if (!provider)
+        provider = (0, _helpers_1.getDefaultProvider)(chainId);
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        const [moduleTokenOut, baseAssetOut, savingsTokenOut] = await vault.previewProportionalSplit(entitlement);
+        return { moduleTokenOut, baseAssetOut, savingsTokenOut };
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.previewProportionalSplit", error, { chainId, address: entry.contract });
+    }
+}

package/dist/contracts/psm/previewRedeem.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewRedeem = previewRedeem;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/**
+ * Previews redeeming `shares` (share base units) from a PSM vault.
+ * @returns The assets out after fee, in base asset base units.
+ */
+async function previewRedeem(chainId, vaultKeyOrAddress, shares, provider) {
+    if (!provider)
+        provider = (0, _helpers_1.getDefaultProvider)(chainId);
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        return await vault.previewRedeem(shares);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.previewRedeem", error, { chainId, address: entry.contract });
+    }
+}

package/dist/contracts/psm/previewSwap.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.previewSwap = previewSwap;
+const _helpers_1 = require("./_helpers");
+const rpcError_1 = require("../../utils/rpcError");
+/**
+ * Previews swapping `amountIn` of `tokenIn` for `tokenOut` through a PSM vault.
+ * @returns The amount out, in tokenOut base units.
+ */
+async function previewSwap(chainId, vaultKeyOrAddress, tokenIn, tokenOut, amountIn, provider) {
+    if (!provider)
+        provider = (0, _helpers_1.getDefaultProvider)(chainId);
+    const { entry } = (0, _helpers_1.resolvePsmVault)(chainId, vaultKeyOrAddress);
+    try {
+        const vault = (0, _helpers_1.getPsmVaultContract)(chainId, vaultKeyOrAddress, provider);
+        return await vault.previewSwap(tokenIn, tokenOut, amountIn);
+    }
+    catch (error) {
+        throw (0, rpcError_1.toRpcError)("psm.previewSwap", error, { chainId, address: entry.contract });
+    }
+}