@oydual31/more-vaults-sdk 0.3.0 → 0.3.2

package/src/viem/curatorSwaps.ts

@@ -0,0 +1,239 @@
+/**
+ * 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 { type Address, encodeFunctionData } from 'viem'
+import { UNISWAP_V3_ROUTERS } from './chains.js'
+import type { CuratorAction } from './types.js'
+
+// ─────────────────────────────────────────────────────────────────────────────
+// ABI constants
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Uniswap V3 SwapRouter exactInputSingle ABI.
+ * Used for: Ethereum (1), Arbitrum (42161), Optimism (10), Flow EVM (747).
+ * Struct includes `deadline` field.
+ */
+const UNISWAP_V3_SWAP_ROUTER_ABI = [
+  {
+    type: 'function',
+    name: 'exactInputSingle',
+    inputs: [
+      {
+        type: 'tuple',
+        name: 'params',
+        components: [
+          { name: 'tokenIn',           type: 'address' },
+          { name: 'tokenOut',          type: 'address' },
+          { name: 'fee',               type: 'uint24'  },
+          { name: 'recipient',         type: 'address' },
+          { name: 'deadline',          type: 'uint256' },
+          { name: 'amountIn',          type: 'uint256' },
+          { name: 'amountOutMinimum',  type: 'uint256' },
+          { name: 'sqrtPriceLimitX96', type: 'uint160' },
+        ],
+      },
+    ],
+    outputs: [{ name: 'amountOut', type: 'uint256' }],
+    stateMutability: 'payable',
+  },
+] as const
+
+/**
+ * Uniswap V3 SwapRouter02 exactInputSingle ABI.
+ * Used for: Base (8453).
+ * Struct does NOT include `deadline` field — SwapRouter02 removed it.
+ */
+const UNISWAP_V3_SWAP_ROUTER02_ABI = [
+  {
+    type: 'function',
+    name: 'exactInputSingle',
+    inputs: [
+      {
+        type: 'tuple',
+        name: 'params',
+        components: [
+          { name: 'tokenIn',           type: 'address' },
+          { name: 'tokenOut',          type: 'address' },
+          { name: 'fee',               type: 'uint24'  },
+          { name: 'recipient',         type: 'address' },
+          { name: 'amountIn',          type: 'uint256' },
+          { name: 'amountOutMinimum',  type: 'uint256' },
+          { name: 'sqrtPriceLimitX96', type: 'uint160' },
+        ],
+      },
+    ],
+    outputs: [{ name: 'amountOut', type: 'uint256' }],
+    stateMutability: 'payable',
+  },
+] 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: Address
+  tokenOut: Address
+  fee: number
+  amountIn: bigint
+  minAmountOut: bigint
+  recipient: Address
+}): { targetContract: Address; swapCallData: `0x${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: `0x${string}`
+
+  if (SWAP_ROUTER02_CHAINS.has(chainId)) {
+    // SwapRouter02 (Base) — no deadline field
+    swapCallData = encodeFunctionData({
+      abi: UNISWAP_V3_SWAP_ROUTER02_ABI,
+      functionName: 'exactInputSingle',
+      args: [
+        {
+          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
+    swapCallData = encodeFunctionData({
+      abi: UNISWAP_V3_SWAP_ROUTER_ABI,
+      functionName: 'exactInputSingle',
+      args: [
+        {
+          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(walletClient, publicClient, vault, batch)
+ * ```
+ */
+export function buildUniswapV3Swap(params: {
+  chainId: number
+  tokenIn: Address
+  tokenOut: Address
+  fee: number
+  amountIn: bigint
+  minAmountOut: bigint
+  recipient: Address
+}): 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/viem/index.ts

@@ -2,7 +2,7 @@
 // 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, OFT_ROUTES, STARGATE_TAXI_CMD, USDC_STARGATE_OFT, USDC_TOKEN, LZ_TIMEOUTS } from './chains'
+export { CHAIN_IDS, LZ_EIDS, EID_TO_CHAIN_ID, CHAIN_ID_TO_EID, OFT_ROUTES, STARGATE_TAXI_CMD, USDC_STARGATE_OFT, USDC_TOKEN, LZ_TIMEOUTS, UNISWAP_V3_ROUTERS } from './chains'
 
 // --- ABIs ---
 export {
@@ -17,8 +17,11 @@ export {
   DEX_ABI,
   BRIDGE_FACET_ABI,
   ERC7540_FACET_ABI,
+  ERC4626_FACET_ABI,
   CURATOR_CONFIG_ABI,
   LZ_ADAPTER_ABI,
+  VAULT_ANALYSIS_ABI,
+  REGISTRY_ABI,
 } from './abis'
 
 // --- Types ---
@@ -38,6 +41,10 @@ export type {
   SubmitActionsResult,
   CuratorAction,
   CuratorVaultStatus,
+  AssetInfo,
+  AssetBalance,
+  VaultAnalysis,
+  VaultAssetBreakdown,
 } from './types'
 export { ActionType } from './types'
 
@@ -155,7 +162,21 @@ export {
   getCuratorVaultStatus,
   getPendingActions,
   isCurator,
+  getVaultAnalysis,
+  checkProtocolWhitelist,
+  getVaultAssetBreakdown,
 } from './curatorStatus'
+export {
+  encodeCuratorAction,
+  buildCuratorBatch,
+  submitActions,
+  executeActions,
+  vetoActions,
+} from './curatorMulticall'
+export {
+  buildUniswapV3Swap,
+  encodeUniswapV3SwapCalldata,
+} from './curatorSwaps'
 
 // --- wagmi compatibility ---
 // Re-export viem's PublicClient type for wagmi compatibility.

package/src/viem/types.ts

@@ -155,3 +155,41 @@ export interface CuratorVaultStatus {
   lzAdapter: Address
   paused: boolean
 }
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Vault Analysis Types
+// ─────────────────────────────────────────────────────────────────────────────
+
+export interface AssetInfo {
+  address: Address
+  symbol: string
+  name: string
+  decimals: number
+}
+
+export interface VaultAnalysis {
+  /** All tokens the vault can hold/swap (curator-managed) */
+  availableAssets: AssetInfo[]
+  /** Tokens users can deposit */
+  depositableAssets: AssetInfo[]
+  /** Whether deposit whitelist is enabled (restricts who can deposit) */
+  depositWhitelistEnabled: boolean
+  /** Registry address for global protocol whitelist checks */
+  registryAddress: Address | null
+}
+
+export interface AssetBalance extends AssetInfo {
+  /** Raw balance held by the vault */
+  balance: bigint
+}
+
+export interface VaultAssetBreakdown {
+  /** Per-asset balances held by the vault on the hub chain */
+  assets: AssetBalance[]
+  /** totalAssets() as reported by the vault (all positions converted to underlying) */
+  totalAssets: bigint
+  /** totalSupply() of vault shares */
+  totalSupply: bigint
+  /** Vault underlying token decimals */
+  underlyingDecimals: number
+}

package/src/viem/userHelpers.ts

@@ -1,5 +1,5 @@
 import { type Address, type PublicClient, getAddress } from 'viem'
-import { BRIDGE_ABI, CONFIG_ABI, ERC20_ABI, VAULT_ABI, METADATA_ABI, OFT_ABI } from './abis'
+import { BRIDGE_ABI, CONFIG_ABI, ERC20_ABI, VAULT_ABI, METADATA_ABI, OFT_ABI, VAULT_ANALYSIS_ABI } from './abis'
 import type { CrossChainRequestInfo } from './types'
 import { getVaultStatus } from './utils'
 import type { VaultStatus } from './utils'
@@ -140,6 +140,10 @@ export type DepositBlockReason = 'paused' | 'capacity-full' | 'not-whitelisted'
 export interface DepositEligibility {
   allowed: boolean
   reason: DepositBlockReason
+  /** Max deposit amount for this user (0n if capacity full or not whitelisted) */
+  maxDeposit?: bigint
+  /** Whether the vault restricts deposits to whitelisted addresses */
+  whitelistEnabled?: boolean
 }
 
 /**
@@ -167,15 +171,27 @@ export async function canDeposit(
     allowFailure: false,
   })
 
+  // Read whitelist status (may revert on older vaults — default to false)
+  let whitelistEnabled = false
+  try {
+    whitelistEnabled = await publicClient.readContract({
+      address: v,
+      abi: VAULT_ANALYSIS_ABI,
+      functionName: 'isDepositWhitelistEnabled',
+    }) as boolean
+  } catch {
+    // Older vaults may not have this function
+  }
+
   if (isPaused) {
-    return { allowed: false, reason: 'paused' }
+    return { allowed: false, reason: 'paused', whitelistEnabled }
   }
 
   // Cross-chain async hubs revert on maxDeposit — this is expected, not a whitelist block.
   // The vault accepts deposits via initVaultActionRequest instead of the standard ERC-4626 path.
   const isCrossChainAsync = isHub && !oraclesEnabled
   if (isCrossChainAsync) {
-    return { allowed: true, reason: 'ok' }
+    return { allowed: true, reason: 'ok', whitelistEnabled }
   }
 
   // maxDeposit(user) can REVERT on vaults with whitelist/ACL
@@ -189,13 +205,13 @@ export async function canDeposit(
     })
   } catch {
     // Revert means the vault has whitelist/ACL and this user is not approved
-    return { allowed: false, reason: 'not-whitelisted' }
+    return { allowed: false, reason: 'not-whitelisted', maxDeposit: 0n, whitelistEnabled }
   }
 
   if (maxDepositAmount === 0n) {
-    return { allowed: false, reason: 'capacity-full' }
+    return { allowed: false, reason: 'capacity-full', maxDeposit: 0n, whitelistEnabled }
   }
-  return { allowed: true, reason: 'ok' }
+  return { allowed: true, reason: 'ok', maxDeposit: maxDepositAmount, whitelistEnabled }
 }
 
 // ─────────────────────────────────────────────────────────────────────────────