@oydual31/more-vaults-sdk 0.1.0 → 0.1.2

package/dist/ethers/index.d.cts

@@ -1,6 +1,27 @@
 import { ContractTransactionReceipt, Signer, Provider } from 'ethers';
 export { ContractTransactionReceipt, Provider, Signer } from 'ethers';
 
+/** EVM Chain IDs for chains supported by MoreVaults */
+declare const CHAIN_IDS: {
+    readonly flowEVMMainnet: 747;
+    readonly flowEVMTestnet: 545;
+    readonly arbitrum: 42161;
+    readonly base: 8453;
+    readonly ethereum: 1;
+};
+/** LayerZero Endpoint IDs (EID) for chains supported by MoreVaults */
+declare const LZ_EIDS: {
+    readonly flowMainnet: 30332;
+    readonly flowTestnet: 30333;
+    readonly arbitrum: 30110;
+    readonly base: 30184;
+    readonly ethereum: 30101;
+};
+/** LayerZero EID → EVM Chain ID */
+declare const EID_TO_CHAIN_ID: Record<number, number>;
+/** EVM Chain ID → LayerZero EID */
+declare const CHAIN_ID_TO_EID: Record<number, number>;
+
 /** Addresses involved in vault operations. */
 interface VaultAddresses {
     /** Hub vault (diamond proxy) address. */
@@ -11,6 +32,12 @@ interface VaultAddresses {
     shareOFT?: string;
     /** OFT address for USDC bridging (cross-chain only). */
     usdcOFT?: string;
+    /**
+     * Expected EVM chain ID of the hub. When provided, SDK functions will
+     * throw a clear WrongChainError if the signer is on a different chain.
+     * Prevents silent failures when MetaMask is connected to the wrong network.
+     */
+    hubChainId?: number;
 }
 /** Result of a synchronous deposit or mint. */
 interface DepositResult {
@@ -107,6 +134,9 @@ declare class NotHubVaultError extends MoreVaultsError {
 declare class MissingEscrowAddressError extends MoreVaultsError {
     constructor();
 }
+declare class WrongChainError extends MoreVaultsError {
+    constructor(currentChainId: number, expectedChainId: number);
+}
 
 /**
  * Deposit `assets` of the vault's underlying token and receive shares.
@@ -668,4 +698,17 @@ type VaultSummary = VaultStatus & VaultMetadata;
  */
 declare function getVaultSummary(provider: Provider, vault: string): Promise<VaultSummary>;
 
-export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, 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, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+/**
+ * Cast an ethers Signer (e.g. from wagmi's useEthersSigner adapter) to
+ * the SDK's expected type. Use this to avoid `as any` casts:
+ * ```ts
+ * import { useEthersSigner } from './wagmi-ethers-adapter'
+ * import { asSdkSigner } from '@oydual31/more-vaults-sdk/ethers'
+ * const signer = asSdkSigner(useEthersSigner())
+ * ```
+ * This function validates the signer is non-null and applies a documented
+ * cast instead of an opaque `as any`.
+ */
+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, 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, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };

package/dist/ethers/index.d.ts

@@ -1,6 +1,27 @@
 import { ContractTransactionReceipt, Signer, Provider } from 'ethers';
 export { ContractTransactionReceipt, Provider, Signer } from 'ethers';
 
+/** EVM Chain IDs for chains supported by MoreVaults */
+declare const CHAIN_IDS: {
+    readonly flowEVMMainnet: 747;
+    readonly flowEVMTestnet: 545;
+    readonly arbitrum: 42161;
+    readonly base: 8453;
+    readonly ethereum: 1;
+};
+/** LayerZero Endpoint IDs (EID) for chains supported by MoreVaults */
+declare const LZ_EIDS: {
+    readonly flowMainnet: 30332;
+    readonly flowTestnet: 30333;
+    readonly arbitrum: 30110;
+    readonly base: 30184;
+    readonly ethereum: 30101;
+};
+/** LayerZero EID → EVM Chain ID */
+declare const EID_TO_CHAIN_ID: Record<number, number>;
+/** EVM Chain ID → LayerZero EID */
+declare const CHAIN_ID_TO_EID: Record<number, number>;
+
 /** Addresses involved in vault operations. */
 interface VaultAddresses {
     /** Hub vault (diamond proxy) address. */
@@ -11,6 +32,12 @@ interface VaultAddresses {
     shareOFT?: string;
     /** OFT address for USDC bridging (cross-chain only). */
     usdcOFT?: string;
+    /**
+     * Expected EVM chain ID of the hub. When provided, SDK functions will
+     * throw a clear WrongChainError if the signer is on a different chain.
+     * Prevents silent failures when MetaMask is connected to the wrong network.
+     */
+    hubChainId?: number;
 }
 /** Result of a synchronous deposit or mint. */
 interface DepositResult {
@@ -107,6 +134,9 @@ declare class NotHubVaultError extends MoreVaultsError {
 declare class MissingEscrowAddressError extends MoreVaultsError {
     constructor();
 }
+declare class WrongChainError extends MoreVaultsError {
+    constructor(currentChainId: number, expectedChainId: number);
+}
 
 /**
  * Deposit `assets` of the vault's underlying token and receive shares.
@@ -668,4 +698,17 @@ type VaultSummary = VaultStatus & VaultMetadata;
  */
 declare function getVaultSummary(provider: Provider, vault: string): Promise<VaultSummary>;
 
-export { ActionType, type ActionTypeValue, type AsyncRequestResult, type AsyncRequestStatus, type AsyncRequestStatusInfo, BRIDGE_ABI, CCManagerNotConfiguredError, CONFIG_ABI, CapacityFullError, type CrossChainRequestInfo, type DepositBlockReason, type DepositEligibility, type DepositResult, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, 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, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+/**
+ * Cast an ethers Signer (e.g. from wagmi's useEthersSigner adapter) to
+ * the SDK's expected type. Use this to avoid `as any` casts:
+ * ```ts
+ * import { useEthersSigner } from './wagmi-ethers-adapter'
+ * import { asSdkSigner } from '@oydual31/more-vaults-sdk/ethers'
+ * const signer = asSdkSigner(useEthersSigner())
+ * ```
+ * This function validates the signer is non-null and applies a documented
+ * cast instead of an opaque `as any`.
+ */
+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, 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, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };

package/dist/ethers/index.js

@@ -1,5 +1,35 @@
 import { Contract, ZeroAddress, Interface, AbiCoder, zeroPadValue } from 'ethers';
 
+// src/ethers/chains.ts
+var CHAIN_IDS = {
+  flowEVMMainnet: 747,
+  flowEVMTestnet: 545,
+  arbitrum: 42161,
+  base: 8453,
+  ethereum: 1
+};
+var LZ_EIDS = {
+  flowMainnet: 30332,
+  flowTestnet: 30333,
+  arbitrum: 30110,
+  base: 30184,
+  ethereum: 30101
+};
+var EID_TO_CHAIN_ID = {
+  [LZ_EIDS.flowMainnet]: CHAIN_IDS.flowEVMMainnet,
+  [LZ_EIDS.flowTestnet]: CHAIN_IDS.flowEVMTestnet,
+  [LZ_EIDS.arbitrum]: CHAIN_IDS.arbitrum,
+  [LZ_EIDS.base]: CHAIN_IDS.base,
+  [LZ_EIDS.ethereum]: CHAIN_IDS.ethereum
+};
+var CHAIN_ID_TO_EID = {
+  [CHAIN_IDS.flowEVMMainnet]: LZ_EIDS.flowMainnet,
+  [CHAIN_IDS.flowEVMTestnet]: LZ_EIDS.flowTestnet,
+  [CHAIN_IDS.arbitrum]: LZ_EIDS.arbitrum,
+  [CHAIN_IDS.base]: LZ_EIDS.base,
+  [CHAIN_IDS.ethereum]: LZ_EIDS.ethereum
+};
+
 // src/ethers/types.ts
 var ActionType = {
   DEPOSIT: 0,
@@ -145,6 +175,14 @@ var MissingEscrowAddressError = class extends MoreVaultsError {
     this.name = "MissingEscrowAddressError";
   }
 };
+var WrongChainError = class extends MoreVaultsError {
+  constructor(currentChainId, expectedChainId) {
+    super(
+      `Wrong network: wallet is on chain ${currentChainId}, but the vault hub requires chain ${expectedChainId}. Switch networks before proceeding.`
+    );
+    this.name = "WrongChainError";
+  }
+};
 async function preflightAsync(provider, vault, escrow) {
   const config = new Contract(vault, CONFIG_ABI, provider);
   const bridge = new Contract(vault, BRIDGE_ABI, provider);
@@ -216,6 +254,17 @@ async function preflightSync(provider, vault) {
     );
   }
 }
+
+// src/ethers/chainValidation.ts
+async function validateWalletChain(signer, hubChainId) {
+  if (!hubChainId) return;
+  const network = await signer.provider?.getNetwork();
+  if (!network) return;
+  const current = Number(network.chainId);
+  if (current !== hubChainId) {
+    throw new WrongChainError(current, hubChainId);
+  }
+}
 var MULTICALL3_ADDRESS = "0xcA11bde05977b3631167028862bE2a173976CA11";
 var MULTICALL3_ABI = [
   "function aggregate3(tuple(address target, bool allowFailure, bytes callData)[] calls) payable returns (tuple(bool success, bytes returnData)[] returnData)"
@@ -407,6 +456,7 @@ async function ensureAllowance2(signer, token, spender, amount) {
 }
 async function depositSimple(signer, addresses, assets, receiver) {
   const provider = signer.provider;
+  await validateWalletChain(signer, addresses.hubChainId);
   await preflightSync(provider, addresses.vault);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const underlying = await vault.asset();
@@ -430,6 +480,7 @@ async function depositSimple(signer, addresses, assets, receiver) {
   return { receipt, shares };
 }
 async function depositMultiAsset(signer, addresses, tokens, amounts, receiver, minShares) {
+  await validateWalletChain(signer, addresses.hubChainId);
   for (let i = 0; i < tokens.length; i++) {
     await ensureAllowance2(signer, tokens[i], addresses.vault, amounts[i]);
   }
@@ -457,6 +508,7 @@ async function depositAsync(signer, addresses, assets, receiver, lzFee, extraOpt
   const provider = signer.provider;
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
+  await validateWalletChain(signer, addresses.hubChainId);
   await preflightAsync(provider, addresses.vault);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const underlying = await vault.asset();
@@ -489,6 +541,7 @@ async function mintAsync(signer, addresses, shares, maxAssets, receiver, lzFee,
   const provider = signer.provider;
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
+  await validateWalletChain(signer, addresses.hubChainId);
   await preflightAsync(provider, addresses.vault);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const underlying = await vault.asset();
@@ -629,6 +682,7 @@ async function ensureAllowance4(signer, token, spender, amount) {
   }
 }
 async function redeemShares(signer, addresses, shares, receiver, owner) {
+  await validateWalletChain(signer, addresses.hubChainId);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const assets = await vault.redeem.staticCall(shares, receiver, owner);
   const tx = await vault.redeem(shares, receiver, owner);
@@ -636,12 +690,14 @@ async function redeemShares(signer, addresses, shares, receiver, owner) {
   return { receipt, assets };
 }
 async function withdrawAssets(signer, addresses, assets, receiver, owner) {
+  await validateWalletChain(signer, addresses.hubChainId);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const tx = await vault.withdraw(assets, receiver, owner);
   const receipt = await tx.wait();
   return { receipt, assets };
 }
 async function requestRedeem(signer, addresses, shares, owner) {
+  await validateWalletChain(signer, addresses.hubChainId);
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
   const tx = await vault.requestRedeem(shares, owner);
   const receipt = await tx.wait();
@@ -659,6 +715,7 @@ async function redeemAsync(signer, addresses, shares, receiver, owner, lzFee, ex
   const provider = signer.provider;
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
+  await validateWalletChain(signer, addresses.hubChainId);
   await preflightAsync(provider, addresses.vault);
   await preflightRedeemLiquidity(provider, addresses.vault, shares);
   await ensureAllowance4(signer, addresses.vault, escrow, shares);
@@ -919,6 +976,12 @@ async function getVaultSummary(provider, vault) {
   return { ...status, ...metadata };
 }
 
-export { ActionType, BRIDGE_ABI, CCManagerNotConfiguredError, CONFIG_ABI, CapacityFullError, ERC20_ABI, EscrowNotConfiguredError, InsufficientLiquidityError, METADATA_ABI, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, VAULT_ABI, VaultPausedError, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
+// src/ethers/wagmiCompat.ts
+function asSdkSigner(signer) {
+  if (!signer) throw new Error("[MoreVaults] No signer available. Make sure the wallet is connected and wagmi is configured correctly.");
+  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, METADATA_ABI, MissingEscrowAddressError, MoreVaultsError, NotHubVaultError, NotWhitelistedError, OFT_ABI, VAULT_ABI, VaultPausedError, WrongChainError, asSdkSigner, bridgeSharesToHub, canDeposit, depositAsync, depositCrossChainOracleOn, depositFromSpoke, depositFromSpokeAsync, depositMultiAsset, depositSimple, ensureAllowance, getAsyncRequestStatus, getAsyncRequestStatusLabel, getMaxWithdrawable, getUserBalances, getUserPosition, getVaultMetadata, getVaultStatus, getVaultSummary, getWithdrawalRequest, isAsyncMode, mintAsync, preflightAsync, preflightRedeemLiquidity, preflightSync, previewDeposit, previewRedeem, quoteDepositFromSpokeFee, quoteLzFee, redeemAsync, redeemShares, requestRedeem, smartDeposit, withdrawAssets };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map