@oydual31/more-vaults-sdk 0.1.0 → 0.1.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oydual31/more-vaults-sdk",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "TypeScript SDK for MoreVaults protocol — viem/wagmi and ethers.js",
   "type": "module",
   "exports": {
@@ -40,7 +40,11 @@
     "ethers": ">=6.0.0"
   },
   "peerDependenciesMeta": {
-    "viem": { "optional": true },
-    "ethers": { "optional": true }
+    "viem": {
+      "optional": true
+    },
+    "ethers": {
+      "optional": true
+    }
   }
 }

package/src/ethers/chainValidation.ts

@@ -0,0 +1,16 @@
+import type { Signer } from 'ethers'
+import { WrongChainError } from './errors'
+
+/**
+ * Validate that the signer is connected to the expected chain.
+ * Only validates if hubChainId is provided — opt-in, non-breaking.
+ */
+export async function validateWalletChain(signer: Signer, hubChainId?: number): Promise<void> {
+  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)
+  }
+}

package/src/ethers/chains.ts

@@ -0,0 +1,35 @@
+/** EVM Chain IDs for chains supported by MoreVaults */
+export const CHAIN_IDS = {
+  flowEVMMainnet: 747,
+  flowEVMTestnet: 545,
+  arbitrum: 42161,
+  base: 8453,
+  ethereum: 1,
+} as const;
+
+/** LayerZero Endpoint IDs (EID) for chains supported by MoreVaults */
+export const LZ_EIDS = {
+  flowMainnet: 30332,
+  flowTestnet: 30333,
+  arbitrum: 30110,
+  base: 30184,
+  ethereum: 30101,
+} as const;
+
+/** LayerZero EID → EVM Chain ID */
+export const EID_TO_CHAIN_ID: Record<number, number> = {
+  [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,
+};
+
+/** EVM Chain ID → LayerZero EID */
+export const CHAIN_ID_TO_EID: Record<number, number> = {
+  [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,
+};

package/src/ethers/depositFlows.ts

@@ -9,6 +9,7 @@ import {
 } from "./types";
 import { preflightAsync, preflightSync } from "./preflight";
 import { MissingEscrowAddressError, VaultPausedError, CapacityFullError } from "./errors";
+import { validateWalletChain } from "./chainValidation";
 import { getVaultStatus, quoteLzFee } from "./utils";
 
 /**
@@ -53,6 +54,9 @@ export async function depositSimple(
 ): Promise<DepositResult> {
   const provider = signer.provider!;
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   // Pre-flight: validate vault is operational and accepting deposits
   await preflightSync(provider, addresses.vault);
 
@@ -114,6 +118,9 @@ export async function depositMultiAsset(
   receiver: string,
   minShares: bigint
 ): Promise<DepositResult> {
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   // Approve each token
   for (let i = 0; i < tokens.length; i++) {
     await ensureAllowance(signer, tokens[i], addresses.vault, amounts[i]);
@@ -190,6 +197,9 @@ export async function depositAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(provider, addresses.vault, escrow);
 
@@ -262,6 +272,9 @@ export async function mintAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(provider, addresses.vault, escrow);
 

package/src/ethers/errors.ts

@@ -79,3 +79,12 @@ export class MissingEscrowAddressError extends MoreVaultsError {
     this.name = 'MissingEscrowAddressError'
   }
 }
+
+export class WrongChainError extends MoreVaultsError {
+  constructor(currentChainId: number, expectedChainId: number) {
+    super(
+      `Wrong network: wallet is on chain ${currentChainId}, but the vault hub requires chain ${expectedChainId}. Switch networks before proceeding.`,
+    )
+    this.name = 'WrongChainError'
+  }
+}

package/src/ethers/index.ts

@@ -1,6 +1,9 @@
 // MoreVaults SDK -- ethers.js v6
 // Barrel export for all flows and utilities.
 
+// --- Chain constants ---
+export { CHAIN_IDS, LZ_EIDS, EID_TO_CHAIN_ID, CHAIN_ID_TO_EID } from "./chains";
+
 // --- Types ---
 export type {
   VaultAddresses,
@@ -36,6 +39,7 @@ export {
   EscrowNotConfiguredError,
   NotHubVaultError,
   MissingEscrowAddressError,
+  WrongChainError,
 } from "./errors";
 
 // --- Deposit flows ---
@@ -101,3 +105,6 @@ export type {
   MaxWithdrawable,
   VaultSummary,
 } from "./userHelpers";
+
+// --- wagmi / ethers adapter compatibility ---
+export { asSdkSigner } from "./wagmiCompat";

package/src/ethers/redeemFlows.ts

@@ -14,6 +14,7 @@ import {
 import type { ContractTransactionReceipt } from "ethers";
 import { preflightAsync, preflightRedeemLiquidity } from "./preflight";
 import { MissingEscrowAddressError } from "./errors";
+import { validateWalletChain } from "./chainValidation";
 
 /**
  * Ensure `spender` has at least `amount` allowance from `owner`.
@@ -58,6 +59,9 @@ export async function redeemShares(
   receiver: string,
   owner: string
 ): Promise<RedeemResult> {
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   const vault = new Contract(addresses.vault, VAULT_ABI, signer);
 
   // Static call to get the return value (assets) before broadcasting
@@ -92,6 +96,9 @@ export async function withdrawAssets(
   receiver: string,
   owner: string
 ): Promise<RedeemResult> {
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  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();
@@ -122,6 +129,9 @@ export async function requestRedeem(
   shares: bigint,
   owner: string
 ): Promise<{ receipt: ContractTransactionReceipt }> {
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  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();
@@ -192,6 +202,9 @@ export async function redeemAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError();
   const escrow = addresses.escrow;
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  await validateWalletChain(signer, addresses.hubChainId);
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(provider, addresses.vault, escrow);
 

package/src/ethers/types.ts

@@ -10,6 +10,12 @@ export 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. */

package/src/ethers/wagmiCompat.ts

@@ -0,0 +1,17 @@
+import type { Signer } from 'ethers'
+
+/**
+ * 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`.
+ */
+export function asSdkSigner(signer: unknown): Signer {
+  if (!signer) throw new Error('[MoreVaults] No signer available. Make sure the wallet is connected and wagmi is configured correctly.')
+  return signer as Signer
+}

package/src/viem/chainValidation.ts

@@ -0,0 +1,14 @@
+import type { WalletClient } from 'viem'
+import { WrongChainError } from './errors'
+
+/**
+ * Validate that the walletClient is connected to the expected chain.
+ * Only validates if hubChainId is provided — opt-in, non-breaking.
+ */
+export function validateWalletChain(walletClient: WalletClient, hubChainId?: number): void {
+  if (!hubChainId) return
+  const current = walletClient.chain?.id
+  if (current !== undefined && current !== hubChainId) {
+    throw new WrongChainError(current, hubChainId)
+  }
+}

package/src/viem/chains.ts

@@ -0,0 +1,35 @@
+/** EVM Chain IDs for chains supported by MoreVaults */
+export const CHAIN_IDS = {
+  flowEVMMainnet: 747,
+  flowEVMTestnet: 545,
+  arbitrum: 42161,
+  base: 8453,
+  ethereum: 1,
+} as const
+
+/** LayerZero Endpoint IDs (EID) for chains supported by MoreVaults */
+export const LZ_EIDS = {
+  flowMainnet: 30332,
+  flowTestnet: 30333,
+  arbitrum: 30110,
+  base: 30184,
+  ethereum: 30101,
+} as const
+
+/** LayerZero EID → EVM Chain ID */
+export const EID_TO_CHAIN_ID: Record<number, number> = {
+  [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,
+}
+
+/** EVM Chain ID → LayerZero EID */
+export const CHAIN_ID_TO_EID: Record<number, number> = {
+  [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,
+}

package/src/viem/depositFlows.ts

@@ -15,6 +15,7 @@ import { ActionType } from './types'
 import { ensureAllowance, getVaultStatus, quoteLzFee } from './utils'
 import { preflightSync, preflightAsync } from './preflight'
 import { MissingEscrowAddressError, VaultPausedError, CapacityFullError } from './errors'
+import { validateWalletChain } from './chainValidation'
 
 /**
  * D1 / D3 — Simple deposit (ERC-4626 standard).
@@ -42,6 +43,9 @@ export async function depositSimple(
   const account = walletClient.account!
   const vault = getAddress(addresses.vault)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   // Pre-flight: validate vault is operational and accepting deposits
   await preflightSync(publicClient, vault)
 
@@ -111,6 +115,9 @@ export async function depositMultiAsset(
   const account = walletClient.account!
   const vault = getAddress(addresses.vault)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   // Approve each token
   for (let i = 0; i < tokens.length; i++) {
     await ensureAllowance(walletClient, publicClient, tokens[i], vault, amounts[i])
@@ -169,6 +176,9 @@ export async function depositAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError()
   const escrow = getAddress(addresses.escrow)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(publicClient, vault, escrow)
 
@@ -244,6 +254,9 @@ export async function mintAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError()
   const escrow = getAddress(addresses.escrow)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(publicClient, vault, escrow)
 

package/src/viem/errors.ts

@@ -79,3 +79,12 @@ export class MissingEscrowAddressError extends MoreVaultsError {
     this.name = 'MissingEscrowAddressError'
   }
 }
+
+export class WrongChainError extends MoreVaultsError {
+  constructor(currentChainId: number, expectedChainId: number) {
+    super(
+      `Wrong network: wallet is on chain ${currentChainId}, but the vault hub requires chain ${expectedChainId}. Switch networks before proceeding.`,
+    )
+    this.name = 'WrongChainError'
+  }
+}

package/src/viem/index.ts

@@ -1,6 +1,9 @@
 // MoreVaults SDK — viem/wagmi
 // Provides typed helpers for all deposit, redeem, and cross-chain vault flows.
 
+// --- Chain constants ---
+export { CHAIN_IDS, LZ_EIDS, EID_TO_CHAIN_ID, CHAIN_ID_TO_EID } from './chains'
+
 // --- ABIs ---
 export {
   VAULT_ABI,
@@ -33,6 +36,7 @@ export {
   EscrowNotConfiguredError,
   NotHubVaultError,
   MissingEscrowAddressError,
+  WrongChainError,
 } from './errors'
 
 // --- Deposit Flows ---
@@ -98,3 +102,10 @@ export type {
   MaxWithdrawable,
   VaultSummary,
 } from './userHelpers'
+
+// --- wagmi compatibility ---
+// Re-export viem's PublicClient type for wagmi compatibility.
+// wagmi's usePublicClient() returns a type that is structurally compatible
+// with viem's PublicClient but TypeScript may complain without this cast helper.
+export type { PublicClient as SdkPublicClient } from 'viem'
+export { asSdkClient } from './wagmiCompat'

package/src/viem/redeemFlows.ts

@@ -17,6 +17,7 @@ import { ActionType } from './types'
 import { ensureAllowance } from './utils'
 import { preflightAsync, preflightRedeemLiquidity } from './preflight'
 import { MissingEscrowAddressError } from './errors'
+import { validateWalletChain } from './chainValidation'
 
 /**
  * R1 — Simple share redemption (ERC-4626 standard).
@@ -46,6 +47,9 @@ export async function redeemShares(
   const account = walletClient.account!
   const vault = getAddress(addresses.vault)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   const { result: assets } = await publicClient.simulateContract({
     address: vault,
     abi: VAULT_ABI,
@@ -94,6 +98,9 @@ export async function withdrawAssets(
   const account = walletClient.account!
   const vault = getAddress(addresses.vault)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   const { result: sharesBurned } = await publicClient.simulateContract({
     address: vault,
     abi: VAULT_ABI,
@@ -143,6 +150,9 @@ export async function requestRedeem(
   const account = walletClient.account!
   const vault = getAddress(addresses.vault)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   await publicClient.simulateContract({
     address: vault,
     abi: VAULT_ABI,
@@ -231,6 +241,9 @@ export async function redeemAsync(
   if (!addresses.escrow) throw new MissingEscrowAddressError()
   const escrow = getAddress(addresses.escrow)
 
+  // Validate wallet is on the correct chain (opt-in via hubChainId)
+  validateWalletChain(walletClient, addresses.hubChainId)
+
   // Pre-flight: validate async cross-chain setup before sending any transaction
   await preflightAsync(publicClient, vault, escrow)
 

package/src/viem/types.ts

@@ -9,6 +9,12 @@ export interface VaultAddresses {
   shareOFT?: Address
   /** OFT for USDC bridging (cross-chain deposits from spoke) */
   usdcOFT?: Address
+  /**
+   * Expected EVM chain ID of the hub. When provided, SDK functions will
+   * throw a clear WrongChainError if the walletClient is on a different chain.
+   * Prevents silent failures when MetaMask is connected to the wrong network.
+   */
+  hubChainId?: number
 }
 
 export interface DepositResult {

package/src/viem/wagmiCompat.ts

@@ -0,0 +1,18 @@
+import type { PublicClient } from 'viem'
+
+/**
+ * Cast a wagmi PublicClient to the SDK's expected type.
+ * Use this in React components to avoid `as any` casts:
+ * ```ts
+ * import { usePublicClient } from 'wagmi'
+ * import { asSdkClient } from '@oydual31/more-vaults-sdk/viem'
+ * const pc = asSdkClient(usePublicClient())
+ * ```
+ * wagmi v2 uses viem as a peer dependency, so the types are structurally
+ * identical — this function validates the client is non-null and applies
+ * a documented cast instead of an opaque `as any`.
+ */
+export function asSdkClient(client: unknown): PublicClient {
+  if (!client) throw new Error('[MoreVaults] No public client available. Make sure wagmi is configured correctly.')
+  return client as PublicClient
+}