@oydual31/more-vaults-sdk 0.2.3 → 0.2.5

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

@@ -153,8 +153,46 @@ declare function isAsyncMode(publicClient: PublicClient, vault: Address): Promis
 declare function getAsyncRequestStatus(publicClient: PublicClient, vault: Address, guid: `0x${string}`): Promise<{
     fulfilled: boolean;
     finalized: boolean;
+    refunded: boolean;
     result: bigint;
 }>;
+interface AsyncRequestFinalResult {
+    /** 'completed' = assets/shares received, 'refunded' = tokens returned to user */
+    status: 'completed' | 'refunded';
+    /** For deposit: shares minted. For redeem: assets returned. 0 if refunded. */
+    result: bigint;
+}
+/**
+ * Poll an async cross-chain request until it finalizes or times out.
+ *
+ * This is the correct way to wait for smartDeposit/smartRedeem results on
+ * async vaults. Do NOT poll balance — use this instead, which reads the
+ * on-chain request state by GUID.
+ *
+ * @param publicClient  Public client on the hub chain
+ * @param vault         Vault address
+ * @param guid          GUID from smartDeposit/smartRedeem result
+ * @param pollInterval  Milliseconds between polls (default: 30_000)
+ * @param timeout       Max wait time in milliseconds (default: 900_000 = 15 min)
+ * @param onPoll        Optional callback invoked after each poll with current status
+ * @returns             Final result with status and amount
+ * @throws              Error if timeout is reached
+ *
+ * @example
+ * const depositResult = await smartDeposit(walletClient, publicClient, { vault }, amount, receiver)
+ * if ('guid' in depositResult) {
+ *   const final = await waitForAsyncRequest(publicClient, vault, depositResult.guid, 30_000, 900_000, (s) => {
+ *     console.log(`Status: fulfilled=${s.fulfilled}, finalized=${s.finalized}`)
+ *   })
+ *   console.log(`Done: ${final.status}, result: ${final.result}`)
+ * }
+ */
+declare function waitForAsyncRequest(publicClient: PublicClient, vault: Address, guid: `0x${string}`, pollInterval?: number, timeout?: number, onPoll?: (status: {
+    fulfilled: boolean;
+    finalized: boolean;
+    refunded: boolean;
+    result: bigint;
+}) => void): Promise<AsyncRequestFinalResult>;
 
 interface UserPosition {
     /** Vault share balance */
@@ -290,6 +328,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 +611,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 AsyncRequestFinalResult as A, getVaultDistribution as B, getVaultDistributionWithTopology as C, type DepositBlockReason as D, getVaultMetadata as E, getVaultStatus as F, getVaultSummary as G, getVaultTopology as H, type InboundRoute as I, isAsyncMode as J, isOnHubChain as K, previewDeposit as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, previewRedeem as P, quoteLzFee as Q, quoteRouteDepositFee as R, type SpokeBalance as S, waitForAsyncRequest as T, type UserBalances as U, type VaultDistribution as V, waitForTx as W, type AsyncRequestStatus as a, type AsyncRequestStatusInfo as b, type DepositEligibility as c, type InboundRouteWithBalance as d, type MultiChainUserPosition as e, type OutboundRoute as f, type UserPosition as g, type VaultMetadata as h, type VaultMode as i, type VaultStatus as j, type VaultSummary as k, type VaultTopology as l, canDeposit as m, discoverVaultTopology as n, ensureAllowance as o, getAllVaultChainIds as p, getAsyncRequestStatus as q, getAsyncRequestStatusLabel as r, getFullVaultTopology as s, getInboundRoutes as t, getMaxWithdrawable as u, getOutboundRoutes as v, getUserBalances as w, getUserBalancesForRoutes as x, getUserPosition as y, getUserPositionMultiChain as z };

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

@@ -153,8 +153,46 @@ declare function isAsyncMode(publicClient: PublicClient, vault: Address): Promis
 declare function getAsyncRequestStatus(publicClient: PublicClient, vault: Address, guid: `0x${string}`): Promise<{
     fulfilled: boolean;
     finalized: boolean;
+    refunded: boolean;
     result: bigint;
 }>;
+interface AsyncRequestFinalResult {
+    /** 'completed' = assets/shares received, 'refunded' = tokens returned to user */
+    status: 'completed' | 'refunded';
+    /** For deposit: shares minted. For redeem: assets returned. 0 if refunded. */
+    result: bigint;
+}
+/**
+ * Poll an async cross-chain request until it finalizes or times out.
+ *
+ * This is the correct way to wait for smartDeposit/smartRedeem results on
+ * async vaults. Do NOT poll balance — use this instead, which reads the
+ * on-chain request state by GUID.
+ *
+ * @param publicClient  Public client on the hub chain
+ * @param vault         Vault address
+ * @param guid          GUID from smartDeposit/smartRedeem result
+ * @param pollInterval  Milliseconds between polls (default: 30_000)
+ * @param timeout       Max wait time in milliseconds (default: 900_000 = 15 min)
+ * @param onPoll        Optional callback invoked after each poll with current status
+ * @returns             Final result with status and amount
+ * @throws              Error if timeout is reached
+ *
+ * @example
+ * const depositResult = await smartDeposit(walletClient, publicClient, { vault }, amount, receiver)
+ * if ('guid' in depositResult) {
+ *   const final = await waitForAsyncRequest(publicClient, vault, depositResult.guid, 30_000, 900_000, (s) => {
+ *     console.log(`Status: fulfilled=${s.fulfilled}, finalized=${s.finalized}`)
+ *   })
+ *   console.log(`Done: ${final.status}, result: ${final.result}`)
+ * }
+ */
+declare function waitForAsyncRequest(publicClient: PublicClient, vault: Address, guid: `0x${string}`, pollInterval?: number, timeout?: number, onPoll?: (status: {
+    fulfilled: boolean;
+    finalized: boolean;
+    refunded: boolean;
+    result: bigint;
+}) => void): Promise<AsyncRequestFinalResult>;
 
 interface UserPosition {
     /** Vault share balance */
@@ -290,6 +328,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 +611,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 AsyncRequestFinalResult as A, getVaultDistribution as B, getVaultDistributionWithTopology as C, type DepositBlockReason as D, getVaultMetadata as E, getVaultStatus as F, getVaultSummary as G, getVaultTopology as H, type InboundRoute as I, isAsyncMode as J, isOnHubChain as K, previewDeposit as L, type MaxWithdrawable as M, NATIVE_SYMBOL as N, OMNI_FACTORY_ADDRESS as O, previewRedeem as P, quoteLzFee as Q, quoteRouteDepositFee as R, type SpokeBalance as S, waitForAsyncRequest as T, type UserBalances as U, type VaultDistribution as V, waitForTx as W, type AsyncRequestStatus as a, type AsyncRequestStatusInfo as b, type DepositEligibility as c, type InboundRouteWithBalance as d, type MultiChainUserPosition as e, type OutboundRoute as f, type UserPosition as g, type VaultMetadata as h, type VaultMode as i, type VaultStatus as j, type VaultSummary as k, type VaultTopology as l, canDeposit as m, discoverVaultTopology as n, ensureAllowance as o, getAllVaultChainIds as p, getAsyncRequestStatus as q, getAsyncRequestStatusLabel as r, getFullVaultTopology as s, getInboundRoutes as t, getMaxWithdrawable as u, getOutboundRoutes as v, getUserBalances as w, getUserBalancesForRoutes as x, getUserPosition as y, getUserPositionMultiChain as z };

package/dist/viem/index.cjs

@@ -1131,9 +1131,27 @@ async function getAsyncRequestStatus(publicClient, vault, guid) {
   return {
     fulfilled: info.fulfilled,
     finalized: info.finalized,
+    refunded: info.refunded,
     result: finalizationResult
   };
 }
+async function waitForAsyncRequest(publicClient, vault, guid, pollInterval = 3e4, timeout = 9e5, onPoll) {
+  const deadline = Date.now() + timeout;
+  while (Date.now() < deadline) {
+    const status = await getAsyncRequestStatus(publicClient, vault, guid);
+    if (onPoll) onPoll(status);
+    if (status.finalized) {
+      return { status: "completed", result: status.result };
+    }
+    if (status.refunded) {
+      return { status: "refunded", result: 0n };
+    }
+    await new Promise((r) => setTimeout(r, pollInterval));
+  }
+  throw new Error(
+    `[MoreVaults] Async request ${guid} did not finalize within ${timeout / 1e3}s. The request may still complete \u2014 check https://layerzeroscan.com/tx/${guid}`
+  );
+}
 var PUBLIC_RPCS = {
   1: [
     "https://ethereum-rpc.publicnode.com",
@@ -2956,6 +2974,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 +3199,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;
@@ -3099,6 +3227,7 @@ exports.requestRedeem = requestRedeem;
 exports.resolveRedeemAddresses = resolveRedeemAddresses;
 exports.smartDeposit = smartDeposit;
 exports.smartRedeem = smartRedeem;
+exports.waitForAsyncRequest = waitForAsyncRequest;
 exports.waitForCompose = waitForCompose;
 exports.waitForTx = waitForTx;
 exports.withdrawAssets = withdrawAssets;