@varla/sdk 2.17.0 → 2.18.0

package/src/views/pool.ts

@@ -1,6 +1,8 @@
 // Note: explicit .js extension is required for Node ESM resolution.
 
 import type { Address } from "viem";
+import { multicallChunks } from "../batch.js";
+import { abis } from "../generated.js";
 
 export type ReadPoolSnapshot = {
   totalAssets: bigint;
@@ -154,6 +156,16 @@ export type ReadPoolHealthScore =
       kind: "no-liquidity";
     };
 
+export type ReadPoolDashboard = {
+  snapshot: ReadPoolSnapshot;
+  caps: ReadPoolCaps;
+  accounting: ReadPoolAccounting;
+  rates: ReadPoolRates;
+  sharePrice: ReadPoolSharePrice;
+  healthScore: ReadPoolHealthScore;
+  debtState: ReadPoolDebtState;
+};
+
 /**
  * Reads pool “rates” and near-term capacity in one convenience call.
  */
@@ -275,3 +287,144 @@ export async function readPoolCoreAddress(params: {
 }): Promise<Address> {
   return params.pool.read.varlaCore();
 }
+
+/**
+ * Multicall-backed aggregate reader for pool-heavy UIs.
+ *
+ * Deduplicates the overlapping primitives used across snapshot/caps/accounting/rates/share price
+ * so frontends can hydrate the full pool page with one batched request group.
+ */
+// wraps: VarlaPool.getPoolStats,VarlaPool.depositCap,VarlaPool.borrowCap,VarlaPool.reserveBalance,VarlaPool.scaledTotalBorrowed,VarlaPool.lastUpdateTimestamp,VarlaPool.totalSupply,VarlaPool.maxBorrow,VarlaPool.getCurrentBorrowIndex
+export async function readPoolDashboard(params: {
+  pool: { address: Address };
+  client: { multicall: (args: any) => Promise<any> };
+  chunkSize?: number;
+}): Promise<ReadPoolDashboard> {
+  const chunkSize = params.chunkSize ?? 256;
+
+  const calls = [
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "getPoolStats" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "depositCap" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "borrowCap" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "reserveBalance" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "scaledTotalBorrowed" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "lastUpdateTimestamp" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "totalSupply" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "maxBorrow" as const,
+    },
+    {
+      address: params.pool.address,
+      abi: abis.VARLAPOOL_ABI,
+      functionName: "getCurrentBorrowIndex" as const,
+    },
+  ];
+
+  const res = await multicallChunks({
+    client: params.client as any,
+    contracts: calls as any,
+    chunkSize,
+  });
+
+  for (const r of res as any[]) {
+    if (r.status !== "success") {
+      throw new Error(`Pool dashboard multicall failed: ${String(r.error ?? "unknown")}`);
+    }
+  }
+
+  const snapshot = await readPoolSnapshot({
+    pool: {
+      read: {
+        getPoolStats: async () => (res as any[])[0]!.result,
+      },
+    },
+  });
+
+  const depositCap = (res as any[])[1]!.result as bigint;
+  const borrowCap = (res as any[])[2]!.result as bigint;
+  const reserveBalance = (res as any[])[3]!.result as bigint;
+  const scaledTotalBorrowed = (res as any[])[4]!.result as bigint;
+  const lastUpdateTimestamp = BigInt((res as any[])[5]!.result);
+  const totalShares = (res as any[])[6]!.result as bigint;
+  const maxBorrow = (res as any[])[7]!.result as bigint;
+  const currentBorrowIndex = (res as any[])[8]!.result as bigint;
+
+  const sharePrice: ReadPoolSharePrice = {
+    totalAssets: snapshot.totalAssets,
+    totalShares,
+    assetsPerShareWad:
+      totalShares === 0n ? 0n : (snapshot.totalAssets * 1_000_000_000_000_000_000n) / totalShares,
+  };
+
+  const healthScore: ReadPoolHealthScore =
+    snapshot.totalAssets === 0n
+      ? { kind: "no-liquidity" }
+      : {
+          kind: "ok",
+          utilizationWad: snapshot.utilization,
+          scoreBps:
+            ((1_000_000_000_000_000_000n -
+              (snapshot.utilization > 1_000_000_000_000_000_000n
+                ? 1_000_000_000_000_000_000n
+                : snapshot.utilization < 0n
+                  ? 0n
+                  : snapshot.utilization)) *
+              10_000n) /
+            1_000_000_000_000_000_000n,
+        };
+
+  return {
+    snapshot,
+    caps: { depositCap, borrowCap },
+    accounting: {
+      reserveBalance,
+      scaledTotalBorrowed,
+      borrowIndex: snapshot.borrowIndex,
+      lastUpdateTimestamp,
+    },
+    rates: {
+      utilization: snapshot.utilization,
+      borrowRate: snapshot.borrowRate,
+      supplyAPY: snapshot.supplyAPY,
+      availableLiquidity: snapshot.available,
+      maxBorrow,
+    },
+    sharePrice,
+    healthScore,
+    debtState: {
+      totalBorrowed: snapshot.totalBorrowed,
+      currentBorrowIndex,
+      borrowRate: snapshot.borrowRate,
+    },
+  };
+}

package/src/views/system.ts

@@ -1,11 +1,17 @@
 // Note: explicit .js extension is required for Node ESM resolution.
 
 import type { ReadDefaultLtvConfig, ReadLiquidationConfig } from "./core.js";
-import { readDefaultLtvConfig, readLiquidationConfig } from "./core.js";
+import { readCoreDashboard, readDefaultLtvConfig, readLiquidationConfig } from "./core.js";
 import type { ReadOracleConfig } from "./oracle.js";
 import { readOracleConfig } from "./oracle.js";
-import type { ReadPoolAccounting, ReadPoolCaps, ReadPoolSnapshot } from "./pool.js";
-import { readPoolAccounting, readPoolCaps, readPoolSnapshot } from "./pool.js";
+import type {
+  ReadPoolAccounting,
+  ReadPoolCaps,
+  ReadPoolHealthScore,
+  ReadPoolSharePrice,
+  ReadPoolSnapshot,
+} from "./pool.js";
+import { readPoolAccounting, readPoolCaps, readPoolDashboard, readPoolSnapshot } from "./pool.js";
 
 export type ReadSystemSnapshot = {
   pool: ReadPoolSnapshot;
@@ -16,6 +22,11 @@ export type ReadSystemSnapshot = {
   oracle: ReadOracleConfig;
 };
 
+export type ReadSystemDashboardSnapshot = ReadSystemSnapshot & {
+  poolSharePrice: ReadPoolSharePrice;
+  poolHealthScore: ReadPoolHealthScore;
+};
+
 /**
  * A lightweight “global protocol state” read for dashboards.
  *
@@ -40,3 +51,40 @@ export async function readSystemSnapshot(params: {
 
   return { pool, poolCaps, poolAccounting, coreLtv, coreLiquidation, oracle };
 }
+
+/**
+ * Multicall-backed system snapshot used by dashboards.
+ */
+export async function readSystemDashboardSnapshot(params: {
+  pool: { address: `0x${string}` };
+  core: { address: `0x${string}` };
+  oracle: any;
+  client: { multicall: (args: any) => Promise<any> };
+}): Promise<ReadSystemDashboardSnapshot> {
+  const [poolDashboard, coreDashboard, oracle] = await Promise.all([
+    readPoolDashboard({
+      pool: { address: params.pool.address },
+      client: params.client,
+    }),
+    readCoreDashboard({
+      core: { address: params.core.address },
+      client: params.client,
+    }),
+    readOracleConfig({ oracle: params.oracle }),
+  ]);
+
+  return {
+    pool: poolDashboard.snapshot,
+    poolCaps: poolDashboard.caps,
+    poolAccounting: poolDashboard.accounting,
+    coreLtv: {
+      conservative: coreDashboard.ltvConfig.tier0,
+      moderate: coreDashboard.ltvConfig.tier1,
+      risk: coreDashboard.ltvConfig.tier2,
+    },
+    coreLiquidation: coreDashboard.liqConfig,
+    oracle,
+    poolSharePrice: poolDashboard.sharePrice,
+    poolHealthScore: poolDashboard.healthScore,
+  };
+}