@raac/rpc 2.0.0-beta.16 → 2.0.0-beta.18

package/dist/user/getUserPortfolio.js

@@ -14,13 +14,14 @@ const getUserDebt_1 = require("./getUserDebt");
 const getUserWalletBalances_1 = require("./getUserWalletBalances");
 const getUserFarming_1 = require("./getUserFarming");
 const getUserGovernance_1 = require("./getUserGovernance");
+const getUserSavings_1 = require("./getUserSavings");
 const _helpers_1 = require("./_helpers");
 const unavailable = (what, sections) => {
     const failed = sections.filter((section) => section.error);
     return failed.length ? new Error(`${what} needs data that could not be read: ${failed.map((section) => section.error.message).join("; ")}`) : null;
 };
 /** Builds the effective return legs from the reads. Each unit of capital earns each yield once. */
-function buildLegs(debt, rates, wallet, farming) {
+function buildLegs(debt, rates, wallet, farming, savings) {
     const legs = [];
     if (debt.valueUsd > 0) {
         legs.push({ id: "borrow", source: "Borrow pmUSD", kind: "cost", yieldType: "borrow", countsAsCapital: false, valueUsd: debt.valueUsd, rate: (0, amount_1.toNumber)(rates.borrowApy), rateKind: "apy" });
@@ -37,12 +38,16 @@ function buildLegs(debt, rates, wallet, farming) {
             continue;
         legs.push({ id: `gauge:${gauge.id}`, source: gauge.name, kind: "earning", yieldType: "gauge", countsAsCapital: false, valueUsd: gauge.valueUsd, rate: gauge.apr ?? 0, rateKind: "apr" });
     }
+    // Savings shares are pmUSD the user holds, so they count as capital; the rate is the vault's current reward stream.
+    for (const vault of savings.vaults) {
+        legs.push({ id: `savings:${vault.id}`, source: vault.name, kind: "earning", yieldType: "savings", countsAsCapital: true, valueUsd: vault.valueUsd, rate: (0, amount_1.toNumber)(vault.apr), rateKind: "apr" });
+    }
     const idleUsd = wallet.idleUsd + coins.filter((coin) => coin.yield === "none").reduce((sum, coin) => sum + coin.valueUsd, 0);
     return { legs, idleUsd };
 }
 /**
  * The user's position across the app: iREET collateral, debt and health factor, wallet RpmUSD/DEpmUSD/pmUSD, LP and
- * gauge positions, veRAAC governance power, and the projected effective return built from them. Each part is read
+ * gauge positions, savings vault positions, veRAAC governance power, and the projected effective return built from them. Each part is read
  * independently, so one failing read shows as an `error` on that part and the rest still return.
  *
  * Only the user's position data is returned; pool parameters such as the liquidation threshold stay with the callers
@@ -51,7 +56,7 @@ function buildLegs(debt, rates, wallet, farming) {
  * @param chainId - The chain/network to use.
  * @param user - The user's address.
  * @param prices - USD per whole token, keyed by lowercase symbol. iREET, pmUSD, RpmUSD, DEpmUSD and RAAC are needed,
- *   plus every coin of a Curve pool the user holds.
+ *   plus every coin of a Curve pool the user holds. Savings positions are valued at their asset's price (pmUSD).
  * @param provider - Optional ethers.js Provider instance. Read-only is enough.
  * @returns Each part as `{ data, error }`, the effective return legs, and the computed effective return.
  */
@@ -63,7 +68,7 @@ const getUserPortfolio = async (chainId, user, prices, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const [collateral, debt, rates, wallet, farming, governance] = await Promise.all([
+    const [collateral, debt, rates, wallet, farming, governance, savings] = await Promise.all([
         (0, _helpers_1.settled)((0, getUserCollateral_1.getUserCollateral)(chainId, user, provider).then((amount) => ({ amount, valueUsd: (0, _helpers_1.requireUsd)(prices, amount, "rwaindextoken") }))),
         (0, _helpers_1.settled)((0, getUserDebt_1.getUserDebt)(chainId, user, provider).then((debt) => ({ ...debt, valueUsd: (0, _helpers_1.requireUsd)(prices, debt.amount, chains_1.default[chainId].pools.lendingpool.asset ?? "debt") }))),
         (0, _helpers_1.settled)((0, getLendingPoolInfo_1.default)(chainId, undefined, provider).then(({ borrowRate, borrowApy, supplyApy }) => ({ borrowRate, borrowApy, supplyApy }))),
@@ -74,6 +79,10 @@ const getUserPortfolio = async (chainId, user, prices, provider) => {
         }))),
         (0, _helpers_1.settled)((0, getUserFarming_1.getUserFarming)(chainId, user, prices, provider)),
         (0, _helpers_1.settled)((0, getUserGovernance_1.getUserGovernance)(chainId, user, provider)),
+        (0, _helpers_1.settled)((0, getUserSavings_1.getUserSavings)(chainId, user, provider).then((read) => {
+            const vaults = read.vaults.map((vault) => ({ ...vault, valueUsd: (0, _helpers_1.requireUsd)(prices, vault.assets, vault.id) }));
+            return { vaults, valueUsd: vaults.reduce((sum, vault) => sum + vault.valueUsd, 0) };
+        })),
     ]);
     const netPositionError = unavailable("Net RAACLend position", [collateral, debt, wallet]);
     const netPositionUsd = netPositionError
@@ -83,12 +92,12 @@ const getUserPortfolio = async (chainId, user, prices, provider) => {
     const farmingErrors = (farming.data?.errors ?? []).map(({ pool, error }) => ({ data: null, error: new Error(`Curve pool ${pool}: ${error.message}`) }));
     let legs = [];
     let effectiveReturn;
-    const returnError = unavailable("Effective return", [collateral, debt, rates, wallet, farming, ...farmingErrors]);
+    const returnError = unavailable("Effective return", [collateral, debt, rates, wallet, farming, savings, ...farmingErrors]);
     if (returnError) {
         effectiveReturn = { data: null, error: returnError };
     }
     else {
-        const built = buildLegs(debt.data, rates.data, wallet.data, farming.data);
+        const built = buildLegs(debt.data, rates.data, wallet.data, farming.data, savings.data);
         legs = built.legs;
         effectiveReturn = { data: (0, computeEffectiveReturn_1.computeEffectiveReturn)({ legs, collateralUsd: collateral.data.valueUsd, idleUsd: built.idleUsd }), error: null };
     }
@@ -101,6 +110,7 @@ const getUserPortfolio = async (chainId, user, prices, provider) => {
         wallet,
         farming,
         governance,
+        savings,
         netPositionUsd,
         legs,
         effectiveReturn,

package/dist/user/getUserSavings.js

@@ -0,0 +1,35 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserSavings = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../configs/chains"));
+const getApr_1 = require("../contracts/yearn/vault/getApr");
+const getUserInfo_1 = require("../contracts/yearn/vault/getUserInfo");
+const getVaults_1 = require("../contracts/yearn/vault/getVaults");
+/**
+ * The user's positions in the chain's savings vaults (the Yearn V3 vaults in the chain config, e.g. spmUSD). Vaults
+ * the user holds nothing in are left out; a chain without savings vaults returns none.
+ *
+ * @param chainId - The chain/network to use.
+ * @param user - The user's address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The vaults the user holds, with what the shares are worth and the vault's current APR.
+ */
+const getUserSavings = async (chainId, user, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const held = await Promise.all((0, getVaults_1.getVaults)(chainId).map(async (entry) => {
+        const info = await (0, getUserInfo_1.getUserInfo)(chainId, entry.contract, user, provider);
+        if (info.shares.value === 0n)
+            return null;
+        const apr = await (0, getApr_1.getApr)(chainId, entry.contract, provider);
+        return { id: entry.id, name: entry.name, vault: entry.contract, shares: info.shares, assets: info.assets, apr };
+    }));
+    return { vaults: held.filter((vault) => vault !== null) };
+};
+exports.getUserSavings = getUserSavings;

package/dist/user/index.js

@@ -21,4 +21,5 @@ __exportStar(require("./getUserDebt"), exports);
 __exportStar(require("./getUserFarming"), exports);
 __exportStar(require("./getUserGovernance"), exports);
 __exportStar(require("./getUserPortfolio"), exports);
+__exportStar(require("./getUserSavings"), exports);
 __exportStar(require("./getUserWalletBalances"), exports);

package/package.json

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