@oydual31/more-vaults-sdk 0.3.2 → 0.4.0

package/src/ethers/curatorSwaps.ts

@@ -0,0 +1,192 @@
+/**
+ * Curator swap helpers for Uniswap V3-compatible DEXes.
+ *
+ * Provides typed helpers to build CuratorAction objects and raw calldata for
+ * Uniswap V3 exactInputSingle swaps, automatically resolving the correct router
+ * and ABI variant (SwapRouter vs SwapRouter02) per chain.
+ *
+ * Supported chains and routers:
+ *   - Base (8453):        SwapRouter02 0x2626...  — NO deadline field
+ *   - Ethereum (1):       SwapRouter   0xE592...  — HAS deadline field
+ *   - Arbitrum (42161):   SwapRouter   0xE592...  — HAS deadline field
+ *   - Optimism (10):      SwapRouter   0xE592...  — HAS deadline field
+ *   - Flow EVM (747):     FlowSwap V3  0xeEDC...  — HAS deadline field
+ *
+ * @module curatorSwaps
+ */
+
+import { Interface } from "ethers";
+import { UNISWAP_V3_ROUTERS } from "./chains";
+import type { CuratorAction } from "./types";
+
+// ─────────────────────────────────────────────────────────────────────────────
+// ABI constants
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Uniswap V3 SwapRouter exactInputSingle ABI (human-readable).
+ * Used for: Ethereum (1), Arbitrum (42161), Optimism (10), Flow EVM (747).
+ * Struct includes `deadline` field.
+ */
+const UNISWAP_V3_SWAP_ROUTER_ABI = [
+  "function exactInputSingle(tuple(address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 deadline, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)",
+] as const;
+
+/**
+ * Uniswap V3 SwapRouter02 exactInputSingle ABI (human-readable).
+ * Used for: Base (8453).
+ * Struct does NOT include `deadline` field — SwapRouter02 removed it.
+ */
+const UNISWAP_V3_SWAP_ROUTER02_ABI = [
+  "function exactInputSingle(tuple(address tokenIn, address tokenOut, uint24 fee, address recipient, uint256 amountIn, uint256 amountOutMinimum, uint160 sqrtPriceLimitX96) params) payable returns (uint256 amountOut)",
+] as const;
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Chain variant detection
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Chains that use SwapRouter02 (no deadline in struct).
+ * All other chains in UNISWAP_V3_ROUTERS use the original SwapRouter.
+ */
+const SWAP_ROUTER02_CHAINS = new Set([8453]);
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Calldata encoding
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Encode Uniswap V3 exactInputSingle calldata directly.
+ * For curators who want raw calldata without the CuratorAction wrapper.
+ *
+ * Automatically selects the correct ABI variant (SwapRouter vs SwapRouter02)
+ * based on the chainId. The deadline (for SwapRouter chains) is set to
+ * `now + 20 minutes` to prevent stale transactions from executing.
+ *
+ * @param params.chainId       EVM chain ID — must be present in UNISWAP_V3_ROUTERS
+ * @param params.tokenIn       Input token address
+ * @param params.tokenOut      Output token address
+ * @param params.fee           Pool fee tier: 100, 500, 3000, or 10000
+ * @param params.amountIn      Exact input amount (in tokenIn units)
+ * @param params.minAmountOut  Minimum acceptable output (slippage protection)
+ * @param params.recipient     Address to receive the output tokens (usually the vault)
+ * @returns                    The router contract address and ABI-encoded calldata
+ * @throws                     If no router is configured for the given chainId
+ */
+export function encodeUniswapV3SwapCalldata(params: {
+  chainId: number;
+  tokenIn: string;
+  tokenOut: string;
+  fee: number;
+  amountIn: bigint;
+  minAmountOut: bigint;
+  recipient: string;
+}): { targetContract: string; swapCallData: string } {
+  const { chainId, tokenIn, tokenOut, fee, amountIn, minAmountOut, recipient } = params;
+
+  const router = UNISWAP_V3_ROUTERS[chainId];
+  if (!router) {
+    throw new Error(
+      `[MoreVaults] No Uniswap V3 router configured for chainId ${chainId}. ` +
+      `Supported chains: ${Object.keys(UNISWAP_V3_ROUTERS).join(', ')}`
+    );
+  }
+
+  let swapCallData: string;
+
+  if (SWAP_ROUTER02_CHAINS.has(chainId)) {
+    // SwapRouter02 (Base) — no deadline field
+    const iface = new Interface(UNISWAP_V3_SWAP_ROUTER02_ABI as unknown as string[]);
+    swapCallData = iface.encodeFunctionData("exactInputSingle", [
+      {
+        tokenIn,
+        tokenOut,
+        fee,
+        recipient,
+        amountIn,
+        amountOutMinimum: minAmountOut,
+        sqrtPriceLimitX96: 0n,
+      },
+    ]);
+  } else {
+    // Original SwapRouter (Eth/Arb/Op/Flow EVM) — has deadline field
+    const deadline = BigInt(Math.floor(Date.now() / 1000) + 1200); // now + 20 minutes
+    const iface = new Interface(UNISWAP_V3_SWAP_ROUTER_ABI as unknown as string[]);
+    swapCallData = iface.encodeFunctionData("exactInputSingle", [
+      {
+        tokenIn,
+        tokenOut,
+        fee,
+        recipient,
+        deadline,
+        amountIn,
+        amountOutMinimum: minAmountOut,
+        sqrtPriceLimitX96: 0n,
+      },
+    ]);
+  }
+
+  return { targetContract: router, swapCallData };
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// CuratorAction builder
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Build a CuratorAction for a Uniswap V3 exactInputSingle swap.
+ *
+ * Automatically resolves the router address from UNISWAP_V3_ROUTERS and
+ * selects the correct ABI struct (with or without deadline) based on chainId.
+ *
+ * The returned action is a `swap` variant ready to be passed to
+ * `buildCuratorBatch` and then `submitActions`.
+ *
+ * @param params.chainId       EVM chain ID — must be present in UNISWAP_V3_ROUTERS
+ * @param params.tokenIn       Input token address
+ * @param params.tokenOut      Output token address
+ * @param params.fee           Pool fee tier: 100, 500, 3000, or 10000
+ * @param params.amountIn      Exact input amount (in tokenIn units)
+ * @param params.minAmountOut  Minimum acceptable output (slippage protection)
+ * @param params.recipient     Address to receive output tokens (usually the vault)
+ * @returns                    A typed CuratorAction ready for buildCuratorBatch
+ * @throws                     If no router is configured for the given chainId
+ *
+ * @example
+ * ```typescript
+ * const action = buildUniswapV3Swap({
+ *   chainId: 8453,
+ *   tokenIn:  '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913', // USDC
+ *   tokenOut: '0x4200000000000000000000000000000000000006', // WETH
+ *   fee: 500,           // 0.05% pool
+ *   amountIn: 150_000n, // 0.15 USDC (6 decimals)
+ *   minAmountOut: 1n,   // accept any amount (set properly in production)
+ *   recipient: VAULT,
+ * })
+ * const batch = buildCuratorBatch([action])
+ * await submitActions(signer, vault, batch)
+ * ```
+ */
+export function buildUniswapV3Swap(params: {
+  chainId: number;
+  tokenIn: string;
+  tokenOut: string;
+  fee: number;
+  amountIn: bigint;
+  minAmountOut: bigint;
+  recipient: string;
+}): CuratorAction {
+  const { targetContract, swapCallData } = encodeUniswapV3SwapCalldata(params);
+
+  return {
+    type: 'swap',
+    params: {
+      targetContract,
+      tokenIn: params.tokenIn,
+      tokenOut: params.tokenOut,
+      maxAmountIn: params.amountIn,
+      minAmountOut: params.minAmountOut,
+      swapCallData,
+    },
+  };
+}

package/src/ethers/distribution.ts

@@ -0,0 +1,156 @@
+/**
+ * Vault distribution helpers for the MoreVaults ethers.js v6 SDK.
+ *
+ * Reads the cross-chain capital distribution of a vault: hub balance,
+ * spoke balances, and aggregate totals.
+ */
+
+import type { Provider } from "ethers";
+import { getVaultStatus } from "./utils";
+import { getVaultTopology } from "./topology";
+
+// ─────────────────────────────────────────────────────────────────────────────
+
+export interface SpokeBalance {
+  chainId: number;
+  totalAssets: bigint;
+  /** false if the RPC call to this spoke failed */
+  isReachable: boolean;
+}
+
+export interface VaultDistribution {
+  hubChainId: number;
+  /** Underlying token balance idle on the hub (not deployed to strategies) */
+  hubLiquidBalance: bigint;
+  /** Hub totalAssets minus hubLiquidBalance (capital in Morpho, Aave, etc.) */
+  hubStrategyBalance: bigint;
+  /** Hub vault totalAssets() */
+  hubTotalAssets: bigint;
+  /** What the hub's accounting thinks is deployed on spokes */
+  spokesDeployedBalance: bigint;
+  /** Actual per-spoke balances read directly from each spoke chain */
+  spokeBalances: SpokeBalance[];
+  /** hubTotalAssets + sum of reachable spoke totalAssets */
+  totalActual: bigint;
+  oracleAccountingEnabled: boolean;
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Read the full cross-chain capital distribution of a vault.
+ *
+ * Queries the hub for its status, then reads `totalAssets()` on each spoke
+ * chain in parallel. Spoke calls are individually wrapped so a single
+ * unreachable RPC never fails the entire call.
+ *
+ * @param hubProvider     Provider connected to the hub chain
+ * @param vault           Vault address (same on all chains via CREATE3)
+ * @param spokeProviders  Map of chainId → Provider for each spoke chain
+ *
+ * @example
+ * ```ts
+ * const dist = await getVaultDistribution(baseProvider, VAULT, {
+ *   [1]: ethProvider,
+ *   [42161]: arbProvider,
+ * })
+ * console.log(`Hub liquid: ${dist.hubLiquidBalance}`)
+ * console.log(`Total actual: ${dist.totalActual}`)
+ * ```
+ */
+export async function getVaultDistribution(
+  hubProvider: Provider,
+  vault: string,
+  spokeProviders: Record<number, Provider>,
+): Promise<VaultDistribution> {
+  // Read hub status
+  const hubStatus = await getVaultStatus(hubProvider, vault);
+
+  const hubChainId = Number((await hubProvider.getNetwork()).chainId);
+  const hubTotalAssets = hubStatus.totalAssets;
+  const hubLiquidBalance = hubStatus.hubLiquidBalance;
+  const hubStrategyBalance =
+    hubTotalAssets > hubLiquidBalance ? hubTotalAssets - hubLiquidBalance : 0n;
+
+  // Read each spoke's totalAssets in parallel, never throwing
+  const spokeEntries = Object.entries(spokeProviders).map(([chainIdStr, provider]) => ({
+    chainId: Number(chainIdStr),
+    provider,
+  }));
+
+  const spokeBalances: SpokeBalance[] = await Promise.all(
+    spokeEntries.map(async ({ chainId, provider }): Promise<SpokeBalance> => {
+      try {
+        const spokeStatus = await getVaultStatus(provider, vault);
+        return { chainId, totalAssets: spokeStatus.totalAssets, isReachable: true };
+      } catch {
+        return { chainId, totalAssets: 0n, isReachable: false };
+      }
+    }),
+  );
+
+  // totalActual = hub + reachable spokes
+  const reachableSpokeSum = spokeBalances
+    .filter((s) => s.isReachable)
+    .reduce((acc, s) => acc + s.totalAssets, 0n);
+
+  const totalActual = hubTotalAssets + reachableSpokeSum;
+
+  return {
+    hubChainId,
+    hubLiquidBalance,
+    hubStrategyBalance,
+    hubTotalAssets,
+    spokesDeployedBalance: hubStatus.spokesDeployedBalance,
+    spokeBalances,
+    totalActual,
+    oracleAccountingEnabled: hubStatus.oracleAccountingEnabled,
+  };
+}
+
+/**
+ * Hub-only distribution — uses topology to discover spokes but does NOT
+ * read spoke chains (no spoke providers needed).
+ *
+ * Returns hub data plus the list of spoke chainIds from the factory.
+ * `spokeBalances` will be empty — callers must provide spoke providers to
+ * `getVaultDistribution` for actual spoke reads.
+ *
+ * @param hubProvider  Provider connected to the hub chain
+ * @param vault        Vault address
+ *
+ * @example
+ * ```ts
+ * const dist = await getVaultDistributionWithTopology(baseProvider, VAULT)
+ * // dist.spokeBalances === [] (no spoke providers provided)
+ * // dist.spokeChainIds tells you which chains to query
+ * ```
+ */
+export async function getVaultDistributionWithTopology(
+  hubProvider: Provider,
+  vault: string,
+): Promise<VaultDistribution & { spokeChainIds: number[] }> {
+  // Read hub status and topology in parallel
+  const [hubStatus, topology] = await Promise.all([
+    getVaultStatus(hubProvider, vault),
+    getVaultTopology(hubProvider, vault),
+  ]);
+
+  const hubChainId = Number((await hubProvider.getNetwork()).chainId);
+  const hubTotalAssets = hubStatus.totalAssets;
+  const hubLiquidBalance = hubStatus.hubLiquidBalance;
+  const hubStrategyBalance =
+    hubTotalAssets > hubLiquidBalance ? hubTotalAssets - hubLiquidBalance : 0n;
+
+  return {
+    hubChainId,
+    hubLiquidBalance,
+    hubStrategyBalance,
+    hubTotalAssets,
+    spokesDeployedBalance: hubStatus.spokesDeployedBalance,
+    spokeBalances: [],
+    totalActual: hubTotalAssets, // hub-only, no spoke data
+    oracleAccountingEnabled: hubStatus.oracleAccountingEnabled,
+    spokeChainIds: topology.spokeChainIds,
+  };
+}

package/src/ethers/index.ts

@@ -15,6 +15,18 @@ export type {
   Signer,
   Provider,
   ContractTransactionReceipt,
+  // Curator types
+  SwapParams,
+  BatchSwapParams,
+  BridgeParams,
+  PendingAction,
+  SubmitActionsResult,
+  CuratorAction,
+  CuratorVaultStatus,
+  AssetInfo,
+  VaultAnalysis,
+  AssetBalance,
+  VaultAssetBreakdown,
 } from "./types";
 export { ActionType } from "./types";
 
@@ -27,6 +39,16 @@ export {
   OFT_ABI,
   METADATA_ABI,
   LZ_ENDPOINT_ABI,
+  // Curator ABIs
+  MULTICALL_ABI,
+  DEX_ABI,
+  BRIDGE_FACET_ABI,
+  ERC7540_FACET_ABI,
+  ERC4626_FACET_ABI,
+  CURATOR_CONFIG_ABI,
+  LZ_ADAPTER_ABI,
+  VAULT_ANALYSIS_ABI,
+  REGISTRY_ABI,
 } from "./abis";
 
 // --- Errors ---
@@ -60,6 +82,7 @@ export {
   quoteDepositFromSpokeFee,
   quoteComposeFee,
   executeCompose,
+  waitForCompose,
 } from "./crossChainFlows";
 
 // --- Redeem flows ---
@@ -72,7 +95,10 @@ export {
   smartRedeem,
   bridgeSharesToHub,
   bridgeAssetsToSpoke,
+  resolveRedeemAddresses,
+  quoteShareBridgeFee,
 } from "./redeemFlows";
+export type { SpokeRedeemRoute } from "./redeemFlows";
 
 // --- Utilities ---
 export {
@@ -81,11 +107,18 @@ export {
   isAsyncMode,
   getAsyncRequestStatus,
   getVaultStatus,
+  detectStargateOft,
 } from "./utils";
 export type { VaultStatus, VaultMode } from "./utils";
 
 // --- Pre-flight validation ---
-export { preflightSync, preflightAsync, preflightRedeemLiquidity } from "./preflight";
+export {
+  preflightSync,
+  preflightAsync,
+  preflightRedeemLiquidity,
+  preflightSpokeDeposit,
+  preflightSpokeRedeem,
+} from "./preflight";
 
 // --- User Helpers ---
 export {
@@ -98,6 +131,7 @@ export {
   getUserBalances,
   getMaxWithdrawable,
   getVaultSummary,
+  getUserPositionMultiChain,
 } from "./userHelpers";
 export type {
   UserPosition,
@@ -109,7 +143,68 @@ export type {
   UserBalances,
   MaxWithdrawable,
   VaultSummary,
+  MultiChainUserPosition,
 } from "./userHelpers";
 
+// --- Curator status reads ---
+export {
+  getCuratorVaultStatus,
+  getPendingActions,
+  isCurator,
+  getVaultAnalysis,
+  checkProtocolWhitelist,
+  getVaultAssetBreakdown,
+} from "./curatorStatus";
+
+// --- Curator multicall writes ---
+export {
+  encodeCuratorAction,
+  buildCuratorBatch,
+  submitActions,
+  executeActions,
+  vetoActions,
+} from "./curatorMulticall";
+
+// --- Curator swap helpers ---
+export {
+  buildUniswapV3Swap,
+  encodeUniswapV3SwapCalldata,
+} from "./curatorSwaps";
+
+// --- Topology ---
+export {
+  getVaultTopology,
+  getFullVaultTopology,
+  discoverVaultTopology,
+  isOnHubChain,
+  getAllVaultChainIds,
+  OMNI_FACTORY_ADDRESS,
+} from "./topology";
+export type { VaultTopology } from "./topology";
+
+// --- Distribution ---
+export {
+  getVaultDistribution,
+  getVaultDistributionWithTopology,
+} from "./distribution";
+export type { VaultDistribution, SpokeBalance } from "./distribution";
+
+// --- Spoke routes ---
+export {
+  getInboundRoutes,
+  getUserBalancesForRoutes,
+  getOutboundRoutes,
+  quoteRouteDepositFee,
+  NATIVE_SYMBOL,
+} from "./spokeRoutes";
+export type {
+  InboundRoute,
+  InboundRouteWithBalance,
+  OutboundRoute,
+} from "./spokeRoutes";
+
+// --- Chains ---
+export { UNISWAP_V3_ROUTERS, OFT_ROUTES } from "./chains";
+
 // --- wagmi / ethers adapter compatibility ---
 export { asSdkSigner } from "./wagmiCompat";