@oydual31/more-vaults-sdk 0.2.0 → 0.2.1

package/dist/ethers/index.d.cts

@@ -25,6 +25,24 @@ declare const LZ_EIDS: {
 declare const EID_TO_CHAIN_ID: Record<number, number>;
 /** EVM Chain ID → LayerZero EID */
 declare const CHAIN_ID_TO_EID: Record<number, number>;
+/**
+ * Recommended timeouts for cross-chain operations (milliseconds).
+ * UIs should show a progress indicator and NOT timeout before these values.
+ */
+declare const LZ_TIMEOUTS: {
+    /** Poll interval between balance/event checks */
+    readonly POLL_INTERVAL: 30000;
+    /** Standard OFT bridge (shares or assets, non-Stargate) */
+    readonly OFT_BRIDGE: 900000;
+    /** Stargate bridge (USDC, USDT, WETH) — slower due to pool mechanics */
+    readonly STARGATE_BRIDGE: 1800000;
+    /** LZ Read callback (async vault actions) */
+    readonly LZ_READ_CALLBACK: 900000;
+    /** Compose delivery to hub (deposit from spoke) */
+    readonly COMPOSE_DELIVERY: 2700000;
+    /** Full spoke→hub→spoke redeem (all steps combined) */
+    readonly FULL_SPOKE_REDEEM: 3600000;
+};
 
 /** Addresses involved in vault operations. */
 interface VaultAddresses {
@@ -410,6 +428,42 @@ declare function redeemAsync(signer: Signer, addresses: VaultAddresses, shares:
 declare function bridgeSharesToHub(signer: Signer, shareOFT: string, hubChainEid: number, shares: bigint, receiver: string, lzFee: bigint): Promise<{
     receipt: ContractTransactionReceipt;
 }>;
+/**
+ * Smart redeem — auto-selects the correct flow based on vault configuration.
+ *
+ * Detects the vault mode and dispatches to:
+ * - Sync vaults (local / cross-chain-oracle): `redeemShares`
+ * - Async vaults (cross-chain, oracle OFF): `redeemAsync` (quotes LZ fee automatically)
+ *
+ * @param signer         Wallet signer with account attached
+ * @param addresses      Vault address set (`escrow` required for async vaults)
+ * @param shares         Amount of shares to redeem
+ * @param receiver       Address that will receive the underlying assets
+ * @param owner          Owner of the shares being redeemed
+ * @param extraOptions   Optional LZ extra options (only used for async vaults)
+ * @returns              RedeemResult or AsyncRequestResult depending on vault mode
+ */
+declare function smartRedeem(signer: Signer, addresses: VaultAddresses, shares: bigint, receiver: string, owner: string, extraOptions?: string): Promise<RedeemResult | AsyncRequestResult>;
+/**
+ * Bridge underlying assets from hub back to spoke chain via OFT.
+ *
+ * Step 3 of the full spoke redeem flow:
+ *   1. bridgeSharesToHub() — shares spoke->hub
+ *   2. smartRedeem() — redeem on hub
+ *   3. bridgeAssetsToSpoke() — assets hub->spoke
+ *
+ * @param signer         Wallet signer on the HUB chain
+ * @param assetOFT       OFT address for the underlying asset on hub
+ * @param spokeChainEid  LayerZero EID for the spoke (destination) chain
+ * @param amount         Amount of underlying assets to bridge
+ * @param receiver       Receiver address on the spoke chain
+ * @param lzFee          OFT send fee (quote via OFT.quoteSend)
+ * @param isStargate     Whether this is a Stargate OFT (uses TAXI mode)
+ * @returns              Transaction receipt
+ */
+declare function bridgeAssetsToSpoke(signer: Signer, assetOFT: string, spokeChainEid: number, amount: bigint, receiver: string, lzFee: bigint, isStargate?: boolean): Promise<{
+    receipt: ContractTransactionReceipt;
+}>;
 
 /**
  * Utility helpers for the MoreVaults ethers.js v6 SDK.
@@ -741,4 +795,4 @@ declare function getVaultSummary(provider: Provider, vault: string): Promise<Vau
  */
 declare function asSdkSigner(signer: unknown): Signer;
 
-export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, METADATA_ABI, type MaxWithdrawable, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, type RedeemResult, type UserBalances, type UserPosition, VAULT_ABI, type VaultAddresses, type VaultMetadata, type VaultMode, VaultPausedError, type VaultStatus, type VaultSummary, WrongChainError, asSdkSigner, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, LZ_TIMEOUTS, METADATA_ABI, type MaxWithdrawable, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, type RedeemResult, type UserBalances, type UserPosition, VAULT_ABI, type VaultAddresses, type VaultMetadata, type VaultMode, VaultPausedError, type VaultStatus, type VaultSummary, WrongChainError, asSdkSigner, bridgeAssetsToSpoke, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, smartRedeem, withdrawAssets };

package/dist/ethers/index.d.ts

@@ -25,6 +25,24 @@ declare const LZ_EIDS: {
 declare const EID_TO_CHAIN_ID: Record<number, number>;
 /** EVM Chain ID → LayerZero EID */
 declare const CHAIN_ID_TO_EID: Record<number, number>;
+/**
+ * Recommended timeouts for cross-chain operations (milliseconds).
+ * UIs should show a progress indicator and NOT timeout before these values.
+ */
+declare const LZ_TIMEOUTS: {
+    /** Poll interval between balance/event checks */
+    readonly POLL_INTERVAL: 30000;
+    /** Standard OFT bridge (shares or assets, non-Stargate) */
+    readonly OFT_BRIDGE: 900000;
+    /** Stargate bridge (USDC, USDT, WETH) — slower due to pool mechanics */
+    readonly STARGATE_BRIDGE: 1800000;
+    /** LZ Read callback (async vault actions) */
+    readonly LZ_READ_CALLBACK: 900000;
+    /** Compose delivery to hub (deposit from spoke) */
+    readonly COMPOSE_DELIVERY: 2700000;
+    /** Full spoke→hub→spoke redeem (all steps combined) */
+    readonly FULL_SPOKE_REDEEM: 3600000;
+};
 
 /** Addresses involved in vault operations. */
 interface VaultAddresses {
@@ -410,6 +428,42 @@ declare function redeemAsync(signer: Signer, addresses: VaultAddresses, shares:
 declare function bridgeSharesToHub(signer: Signer, shareOFT: string, hubChainEid: number, shares: bigint, receiver: string, lzFee: bigint): Promise<{
     receipt: ContractTransactionReceipt;
 }>;
+/**
+ * Smart redeem — auto-selects the correct flow based on vault configuration.
+ *
+ * Detects the vault mode and dispatches to:
+ * - Sync vaults (local / cross-chain-oracle): `redeemShares`
+ * - Async vaults (cross-chain, oracle OFF): `redeemAsync` (quotes LZ fee automatically)
+ *
+ * @param signer         Wallet signer with account attached
+ * @param addresses      Vault address set (`escrow` required for async vaults)
+ * @param shares         Amount of shares to redeem
+ * @param receiver       Address that will receive the underlying assets
+ * @param owner          Owner of the shares being redeemed
+ * @param extraOptions   Optional LZ extra options (only used for async vaults)
+ * @returns              RedeemResult or AsyncRequestResult depending on vault mode
+ */
+declare function smartRedeem(signer: Signer, addresses: VaultAddresses, shares: bigint, receiver: string, owner: string, extraOptions?: string): Promise<RedeemResult | AsyncRequestResult>;
+/**
+ * Bridge underlying assets from hub back to spoke chain via OFT.
+ *
+ * Step 3 of the full spoke redeem flow:
+ *   1. bridgeSharesToHub() — shares spoke->hub
+ *   2. smartRedeem() — redeem on hub
+ *   3. bridgeAssetsToSpoke() — assets hub->spoke
+ *
+ * @param signer         Wallet signer on the HUB chain
+ * @param assetOFT       OFT address for the underlying asset on hub
+ * @param spokeChainEid  LayerZero EID for the spoke (destination) chain
+ * @param amount         Amount of underlying assets to bridge
+ * @param receiver       Receiver address on the spoke chain
+ * @param lzFee          OFT send fee (quote via OFT.quoteSend)
+ * @param isStargate     Whether this is a Stargate OFT (uses TAXI mode)
+ * @returns              Transaction receipt
+ */
+declare function bridgeAssetsToSpoke(signer: Signer, assetOFT: string, spokeChainEid: number, amount: bigint, receiver: string, lzFee: bigint, isStargate?: boolean): Promise<{
+    receipt: ContractTransactionReceipt;
+}>;
 
 /**
  * Utility helpers for the MoreVaults ethers.js v6 SDK.
@@ -741,4 +795,4 @@ declare function getVaultSummary(provider: Provider, vault: string): Promise<Vau
  */
 declare function asSdkSigner(signer: unknown): Signer;
 
-export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, METADATA_ABI, type MaxWithdrawable, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, type RedeemResult, type UserBalances, type UserPosition, VAULT_ABI, type VaultAddresses, type VaultMetadata, type VaultMode, VaultPausedError, type VaultStatus, type VaultSummary, WrongChainError, asSdkSigner, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, LZ_TIMEOUTS, METADATA_ABI, type MaxWithdrawable, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, type RedeemResult, type UserBalances, type UserPosition, VAULT_ABI, type VaultAddresses, type VaultMetadata, type VaultMode, VaultPausedError, type VaultStatus, type VaultSummary, WrongChainError, asSdkSigner, bridgeAssetsToSpoke, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, smartRedeem, withdrawAssets };

package/dist/ethers/index.js

@@ -29,6 +29,25 @@ var CHAIN_ID_TO_EID = {
   [CHAIN_IDS.base]: LZ_EIDS.base,
   [CHAIN_IDS.ethereum]: LZ_EIDS.ethereum
 };
+var LZ_TIMEOUTS = {
+  /** Poll interval between balance/event checks */
+  POLL_INTERVAL: 3e4,
+  /** Standard OFT bridge (shares or assets, non-Stargate) */
+  OFT_BRIDGE: 9e5,
+  // 15 min
+  /** Stargate bridge (USDC, USDT, WETH) — slower due to pool mechanics */
+  STARGATE_BRIDGE: 18e5,
+  // 30 min
+  /** LZ Read callback (async vault actions) */
+  LZ_READ_CALLBACK: 9e5,
+  // 15 min
+  /** Compose delivery to hub (deposit from spoke) */
+  COMPOSE_DELIVERY: 27e5,
+  // 45 min
+  /** Full spoke→hub→spoke redeem (all steps combined) */
+  FULL_SPOKE_REDEEM: 36e5
+  // 60 min
+};
 
 // src/ethers/types.ts
 var ActionType = {
@@ -825,6 +844,46 @@ async function bridgeSharesToHub(signer, shareOFT, hubChainEid, shares, receiver
   const receipt = await tx.wait();
   return { receipt };
 }
+async function smartRedeem(signer, addresses, shares, receiver, owner, extraOptions = "0x") {
+  const provider = signer.provider;
+  const vault = addresses.vault;
+  const status = await getVaultStatus(provider, vault);
+  if (status.mode === "paused") {
+    throw new Error(`[MoreVaults] Vault ${vault} is paused. Cannot redeem.`);
+  }
+  if (status.recommendedDepositFlow === "depositAsync") {
+    const lzFee = await quoteLzFee(provider, vault, extraOptions);
+    return redeemAsync(signer, addresses, shares, receiver, owner, lzFee, extraOptions);
+  }
+  return redeemShares(signer, addresses, shares, receiver, owner);
+}
+async function bridgeAssetsToSpoke(signer, assetOFT, spokeChainEid, amount, receiver, lzFee, isStargate = true) {
+  const oft = new Contract(assetOFT, OFT_ABI, signer);
+  const token = await oft.token();
+  if (token.toLowerCase() !== assetOFT.toLowerCase()) {
+    await ensureAllowance4(signer, token, assetOFT, amount);
+  } else {
+    await ensureAllowance4(signer, assetOFT, assetOFT, amount);
+  }
+  const refundAddress = await signer.getAddress();
+  const toBytes32 = zeroPadValue(receiver, 32);
+  const sendParam = {
+    dstEid: spokeChainEid,
+    to: toBytes32,
+    amountLD: amount,
+    minAmountLD: amount * 99n / 100n,
+    // 1% slippage for Stargate
+    extraOptions: "0x",
+    composeMsg: "0x",
+    oftCmd: isStargate ? "0x01" : "0x"
+  };
+  const msgFee = { nativeFee: lzFee, lzTokenFee: 0n };
+  const tx = await oft.send(sendParam, msgFee, refundAddress, {
+    value: lzFee
+  });
+  const receipt = await tx.wait();
+  return { receipt };
+}
 var MULTICALL3_ADDRESS2 = "0xcA11bde05977b3631167028862bE2a173976CA11";
 var MULTICALL3_ABI2 = [
   "function aggregate3(tuple(address target, bool allowFailure, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)"
@@ -1042,6 +1101,6 @@ function asSdkSigner(signer) {
   return signer;
 }
 
-export { ActionType, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, METADATA_ABI, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, VAULT_ABI, VaultPausedError, WrongChainError, asSdkSigner, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+export { ActionType, BRIDGE_ABI, CCManagerNotConfiguredError, CHAIN_IDS, CHAIN_ID_TO_EID, CONFIG_ABI, CapacityFullError, EID_TO_CHAIN_ID, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, LZ_EIDS, LZ_ENDPOINT_ABI, LZ_TIMEOUTS, METADATA_ABI, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, VAULT_ABI, VaultPausedError, WrongChainError, asSdkSigner, bridgeAssetsToSpoke, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, executeCompose, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteComposeFee, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, smartRedeem, withdrawAssets };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map