@oydual31/more-vaults-sdk 0.2.2 → 0.2.4

package/dist/{spokeRoutes-CK5NSOOF.d.cts → spokeRoutes-CXMG7nLp.d.cts}

@@ -290,6 +290,40 @@ type VaultSummary = VaultStatus & VaultMetadata;
  * @returns             Merged VaultStatus and VaultMetadata
  */
 declare function getVaultSummary(publicClient: PublicClient, vault: Address): Promise<VaultSummary>;
+interface MultiChainUserPosition {
+    /** Shares held directly on the hub vault (vault.balanceOf) */
+    hubShares: bigint;
+    /** Per-spoke SHARE_OFT balances: { [chainId]: bigint } */
+    spokeShares: Record<number, bigint>;
+    /** hubShares + sum of all spokeShares */
+    totalShares: bigint;
+    /** convertToAssets(totalShares) on the hub */
+    estimatedAssets: bigint;
+    /** Share price: convertToAssets(10^decimals) */
+    sharePrice: bigint;
+    /** Vault decimals */
+    decimals: number;
+    /** Pending async withdrawal request on hub, or null */
+    pendingWithdrawal: {
+        shares: bigint;
+        timelockEndsAt: bigint;
+        canRedeemNow: boolean;
+    } | null;
+}
+/**
+ * Read the user's position across all chains of an omni vault.
+ *
+ * Discovers topology automatically, reads hub shares + pending withdrawal,
+ * then reads SHARE_OFT balances on each spoke chain in parallel.
+ *
+ * For local (single-chain) vaults, spokeShares will be empty and this
+ * behaves identically to getUserPosition.
+ *
+ * @param vault  Vault address (same on all chains via CREATE3)
+ * @param user   User wallet address
+ * @returns      Aggregated position across all chains
+ */
+declare function getUserPositionMultiChain(vault: Address, user: Address): Promise<MultiChainUserPosition>;
 
 declare const OMNI_FACTORY_ADDRESS: Address;
 interface VaultTopology {
@@ -539,4 +573,4 @@ declare function getOutboundRoutes(hubChainId: number, vault: Address): Promise<
  */
 declare function quoteRouteDepositFee(route: InboundRoute, hubChainId: number, amount: bigint, userAddress: Address): Promise<bigint>;
 
-export { type AsyncRequestStatus as A, getVaultStatus as B, getVaultSummary as C, type DepositBlockReason as D, getVaultTopology as E, isAsyncMode as F, isOnHubChain as G, previewDeposit as H, type InboundRoute as I, previewRedeem as J, quoteLzFee as K, quoteRouteDepositFee as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, waitForTx as P, type SpokeBalance as S, type UserBalances as U, type VaultDistribution as V, type AsyncRequestStatusInfo as a, type DepositEligibility as b, type InboundRouteWithBalance as c, type OutboundRoute as d, type UserPosition as e, type VaultMetadata as f, type VaultMode as g, type VaultStatus as h, type VaultSummary as i, type VaultTopology as j, canDeposit as k, discoverVaultTopology as l, ensureAllowance as m, getAllVaultChainIds as n, getAsyncRequestStatus as o, getAsyncRequestStatusLabel as p, getFullVaultTopology as q, getInboundRoutes as r, getMaxWithdrawable as s, getOutboundRoutes as t, getUserBalances as u, getUserBalancesForRoutes as v, getUserPosition as w, getVaultDistribution as x, getVaultDistributionWithTopology as y, getVaultMetadata as z };
+export { type AsyncRequestStatus as A, getVaultDistributionWithTopology as B, getVaultMetadata as C, type DepositBlockReason as D, getVaultStatus as E, getVaultSummary as F, getVaultTopology as G, isAsyncMode as H, type InboundRoute as I, isOnHubChain as J, previewDeposit as K, previewRedeem as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, quoteLzFee as P, quoteRouteDepositFee as Q, waitForTx as R, type SpokeBalance as S, type UserBalances as U, type VaultDistribution as V, type AsyncRequestStatusInfo as a, type DepositEligibility as b, type InboundRouteWithBalance as c, type MultiChainUserPosition as d, type OutboundRoute as e, type UserPosition as f, type VaultMetadata as g, type VaultMode as h, type VaultStatus as i, type VaultSummary as j, type VaultTopology as k, canDeposit as l, discoverVaultTopology as m, ensureAllowance as n, getAllVaultChainIds as o, getAsyncRequestStatus as p, getAsyncRequestStatusLabel as q, getFullVaultTopology as r, getInboundRoutes as s, getMaxWithdrawable as t, getOutboundRoutes as u, getUserBalances as v, getUserBalancesForRoutes as w, getUserPosition as x, getUserPositionMultiChain as y, getVaultDistribution as z };

package/dist/{spokeRoutes-CK5NSOOF.d.ts → spokeRoutes-CXMG7nLp.d.ts}

@@ -290,6 +290,40 @@ type VaultSummary = VaultStatus & VaultMetadata;
  * @returns             Merged VaultStatus and VaultMetadata
  */
 declare function getVaultSummary(publicClient: PublicClient, vault: Address): Promise<VaultSummary>;
+interface MultiChainUserPosition {
+    /** Shares held directly on the hub vault (vault.balanceOf) */
+    hubShares: bigint;
+    /** Per-spoke SHARE_OFT balances: { [chainId]: bigint } */
+    spokeShares: Record<number, bigint>;
+    /** hubShares + sum of all spokeShares */
+    totalShares: bigint;
+    /** convertToAssets(totalShares) on the hub */
+    estimatedAssets: bigint;
+    /** Share price: convertToAssets(10^decimals) */
+    sharePrice: bigint;
+    /** Vault decimals */
+    decimals: number;
+    /** Pending async withdrawal request on hub, or null */
+    pendingWithdrawal: {
+        shares: bigint;
+        timelockEndsAt: bigint;
+        canRedeemNow: boolean;
+    } | null;
+}
+/**
+ * Read the user's position across all chains of an omni vault.
+ *
+ * Discovers topology automatically, reads hub shares + pending withdrawal,
+ * then reads SHARE_OFT balances on each spoke chain in parallel.
+ *
+ * For local (single-chain) vaults, spokeShares will be empty and this
+ * behaves identically to getUserPosition.
+ *
+ * @param vault  Vault address (same on all chains via CREATE3)
+ * @param user   User wallet address
+ * @returns      Aggregated position across all chains
+ */
+declare function getUserPositionMultiChain(vault: Address, user: Address): Promise<MultiChainUserPosition>;
 
 declare const OMNI_FACTORY_ADDRESS: Address;
 interface VaultTopology {
@@ -539,4 +573,4 @@ declare function getOutboundRoutes(hubChainId: number, vault: Address): Promise<
  */
 declare function quoteRouteDepositFee(route: InboundRoute, hubChainId: number, amount: bigint, userAddress: Address): Promise<bigint>;
 
-export { type AsyncRequestStatus as A, getVaultStatus as B, getVaultSummary as C, type DepositBlockReason as D, getVaultTopology as E, isAsyncMode as F, isOnHubChain as G, previewDeposit as H, type InboundRoute as I, previewRedeem as J, quoteLzFee as K, quoteRouteDepositFee as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, waitForTx as P, type SpokeBalance as S, type UserBalances as U, type VaultDistribution as V, type AsyncRequestStatusInfo as a, type DepositEligibility as b, type InboundRouteWithBalance as c, type OutboundRoute as d, type UserPosition as e, type VaultMetadata as f, type VaultMode as g, type VaultStatus as h, type VaultSummary as i, type VaultTopology as j, canDeposit as k, discoverVaultTopology as l, ensureAllowance as m, getAllVaultChainIds as n, getAsyncRequestStatus as o, getAsyncRequestStatusLabel as p, getFullVaultTopology as q, getInboundRoutes as r, getMaxWithdrawable as s, getOutboundRoutes as t, getUserBalances as u, getUserBalancesForRoutes as v, getUserPosition as w, getVaultDistribution as x, getVaultDistributionWithTopology as y, getVaultMetadata as z };
+export { type AsyncRequestStatus as A, getVaultDistributionWithTopology as B, getVaultMetadata as C, type DepositBlockReason as D, getVaultStatus as E, getVaultSummary as F, getVaultTopology as G, isAsyncMode as H, type InboundRoute as I, isOnHubChain as J, previewDeposit as K, previewRedeem as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, quoteLzFee as P, quoteRouteDepositFee as Q, waitForTx as R, type SpokeBalance as S, type UserBalances as U, type VaultDistribution as V, type AsyncRequestStatusInfo as a, type DepositEligibility as b, type InboundRouteWithBalance as c, type MultiChainUserPosition as d, type OutboundRoute as e, type UserPosition as f, type VaultMetadata as g, type VaultMode as h, type VaultStatus as i, type VaultSummary as j, type VaultTopology as k, canDeposit as l, discoverVaultTopology as m, ensureAllowance as n, getAllVaultChainIds as o, getAsyncRequestStatus as p, getAsyncRequestStatusLabel as q, getFullVaultTopology as r, getInboundRoutes as s, getMaxWithdrawable as t, getOutboundRoutes as u, getUserBalances as v, getUserBalancesForRoutes as w, getUserPosition as x, getUserPositionMultiChain as y, getVaultDistribution as z };

package/dist/viem/index.cjs

@@ -2956,6 +2956,115 @@ async function getVaultSummary(publicClient, vault) {
   ]);
   return { ...status, ...metadata };
 }
+var FACTORY_COMPOSER_ABI3 = [
+  {
+    type: "function",
+    name: "vaultComposer",
+    inputs: [{ name: "_vault", type: "address" }],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  }
+];
+var COMPOSER_SHARE_OFT_ABI = [
+  {
+    type: "function",
+    name: "SHARE_OFT",
+    inputs: [],
+    outputs: [{ name: "", type: "address" }],
+    stateMutability: "view"
+  }
+];
+async function getUserPositionMultiChain(vault, user) {
+  const v = viem.getAddress(vault);
+  const u = viem.getAddress(user);
+  const topo = await discoverVaultTopology(vault);
+  const hubClient = createChainClient(topo.hubChainId);
+  if (!hubClient) throw new Error(`No public RPC for hub chainId ${topo.hubChainId}`);
+  const [hubShares, decimals, withdrawalRequest] = await hubClient.multicall({
+    contracts: [
+      { address: v, abi: VAULT_ABI, functionName: "balanceOf", args: [u] },
+      { address: v, abi: METADATA_ABI, functionName: "decimals" },
+      { address: v, abi: VAULT_ABI, functionName: "getWithdrawalRequest", args: [u] }
+    ],
+    allowFailure: false
+  });
+  const [withdrawShares, timelockEndsAt] = withdrawalRequest;
+  const spokeShares = {};
+  if (topo.spokeChainIds.length > 0) {
+    let hubShareOft = null;
+    try {
+      const composerAddress = await hubClient.readContract({
+        address: OMNI_FACTORY_ADDRESS,
+        abi: FACTORY_COMPOSER_ABI3,
+        functionName: "vaultComposer",
+        args: [v]
+      });
+      if (composerAddress !== "0x0000000000000000000000000000000000000000") {
+        hubShareOft = await hubClient.readContract({
+          address: composerAddress,
+          abi: COMPOSER_SHARE_OFT_ABI,
+          functionName: "SHARE_OFT"
+        });
+      }
+    } catch {
+    }
+    if (hubShareOft) {
+      const spokePromises = topo.spokeChainIds.map(async (spokeChainId) => {
+        try {
+          const spokeEid = CHAIN_ID_TO_EID[spokeChainId];
+          if (!spokeEid) return { chainId: spokeChainId, balance: 0n };
+          const spokeOftBytes32 = await hubClient.readContract({
+            address: hubShareOft,
+            abi: OFT_ABI,
+            functionName: "peers",
+            args: [spokeEid]
+          });
+          const spokeOft = viem.getAddress(`0x${spokeOftBytes32.slice(-40)}`);
+          if (spokeOft === "0x0000000000000000000000000000000000000000") {
+            return { chainId: spokeChainId, balance: 0n };
+          }
+          const spokeClient = createChainClient(spokeChainId);
+          if (!spokeClient) return { chainId: spokeChainId, balance: 0n };
+          const balance = await spokeClient.readContract({
+            address: spokeOft,
+            abi: ERC20_ABI,
+            functionName: "balanceOf",
+            args: [u]
+          });
+          return { chainId: spokeChainId, balance };
+        } catch {
+          return { chainId: spokeChainId, balance: 0n };
+        }
+      });
+      const results = await Promise.all(spokePromises);
+      for (const { chainId, balance } of results) {
+        spokeShares[chainId] = balance;
+      }
+    }
+  }
+  const totalSpokeShares = Object.values(spokeShares).reduce((sum, b) => sum + b, 0n);
+  const totalShares = hubShares + totalSpokeShares;
+  const oneShare = 10n ** BigInt(decimals);
+  const [estimatedAssets, sharePrice] = await Promise.all([
+    totalShares === 0n ? Promise.resolve(0n) : hubClient.readContract({ address: v, abi: VAULT_ABI, functionName: "convertToAssets", args: [totalShares] }),
+    hubClient.readContract({ address: v, abi: VAULT_ABI, functionName: "convertToAssets", args: [oneShare] })
+  ]);
+  const block = await hubClient.getBlock();
+  const pendingWithdrawal = withdrawShares === 0n ? null : {
+    shares: withdrawShares,
+    timelockEndsAt,
+    canRedeemNow: timelockEndsAt === 0n || block.timestamp >= timelockEndsAt
+  };
+  return {
+    hubShares,
+    spokeShares,
+    totalShares,
+    estimatedAssets,
+    sharePrice,
+    decimals,
+    pendingWithdrawal
+  };
+}
 
 // src/viem/distribution.ts
 async function getVaultDistribution(hubClient, vault, spokeClients) {
@@ -3072,6 +3181,7 @@ exports.getOutboundRoutes = getOutboundRoutes;
 exports.getUserBalances = getUserBalances;
 exports.getUserBalancesForRoutes = getUserBalancesForRoutes;
 exports.getUserPosition = getUserPosition;
+exports.getUserPositionMultiChain = getUserPositionMultiChain;
 exports.getVaultDistribution = getVaultDistribution;
 exports.getVaultDistributionWithTopology = getVaultDistributionWithTopology;
 exports.getVaultMetadata = getVaultMetadata;