@oydual31/more-vaults-sdk 0.2.9 → 0.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oydual31/more-vaults-sdk",
-  "version": "0.2.9",
+  "version": "0.3.1",
   "description": "TypeScript SDK for MoreVaults protocol — viem/wagmi and ethers.js",
   "type": "module",
   "exports": {

package/src/viem/abis.ts

@@ -451,6 +451,335 @@ export const OFT_ABI = [
   },
 ] as const
 
+// ─────────────────────────────────────────────────────────────────────────────
+// Curator Operations ABIs
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * MulticallFacet ABI — curator action submission and execution with timelock.
+ */
+export const MULTICALL_ABI = [
+  {
+    type: 'function',
+    name: 'submitActions',
+    inputs: [
+      { name: 'actionsData', type: 'bytes[]' },
+    ],
+    outputs: [{ name: 'nonce', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'executeActions',
+    inputs: [
+      { name: 'actionsNonce', type: 'uint256' },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'getPendingActions',
+    inputs: [
+      { name: 'actionsNonce', type: 'uint256' },
+    ],
+    outputs: [
+      { name: 'actionsData', type: 'bytes[]' },
+      { name: 'pendingUntil', type: 'uint256' },
+    ],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'getCurrentNonce',
+    inputs: [],
+    outputs: [{ name: '', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'vetoActions',
+    inputs: [
+      { name: 'actionsNonces', type: 'uint256[]' },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+] as const
+
+/**
+ * GenericDexFacet ABI — single and batch token swaps through any DEX aggregator.
+ */
+export const DEX_ABI = [
+  {
+    type: 'function',
+    name: 'executeSwap',
+    inputs: [
+      {
+        name: 'params',
+        type: 'tuple',
+        components: [
+          { name: 'targetContract', type: 'address' },
+          { name: 'tokenIn', type: 'address' },
+          { name: 'tokenOut', type: 'address' },
+          { name: 'maxAmountIn', type: 'uint256' },
+          { name: 'minAmountOut', type: 'uint256' },
+          { name: 'swapCallData', type: 'bytes' },
+        ],
+      },
+    ],
+    outputs: [{ name: 'amountOut', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'executeBatchSwap',
+    inputs: [
+      {
+        name: 'params',
+        type: 'tuple',
+        components: [
+          {
+            name: 'swaps',
+            type: 'tuple[]',
+            components: [
+              { name: 'targetContract', type: 'address' },
+              { name: 'tokenIn', type: 'address' },
+              { name: 'tokenOut', type: 'address' },
+              { name: 'maxAmountIn', type: 'uint256' },
+              { name: 'minAmountOut', type: 'uint256' },
+              { name: 'swapCallData', type: 'bytes' },
+            ],
+          },
+        ],
+      },
+    ],
+    outputs: [{ name: 'amountsOut', type: 'uint256[]' }],
+    stateMutability: 'nonpayable',
+  },
+] as const
+
+/**
+ * BridgeFacet ABI — curator bridging and cross-chain request initiation.
+ * (extends the existing BRIDGE_ABI with curator-specific functions)
+ */
+export const BRIDGE_FACET_ABI = [
+  {
+    type: 'function',
+    name: 'executeBridging',
+    inputs: [
+      { name: 'adapter', type: 'address' },
+      { name: 'token', type: 'address' },
+      { name: 'amount', type: 'uint256' },
+      { name: 'bridgeSpecificParams', type: 'bytes' },
+    ],
+    outputs: [],
+    stateMutability: 'payable',
+  },
+  {
+    type: 'function',
+    name: 'initVaultActionRequest',
+    inputs: [
+      { name: 'actionType', type: 'uint8' },
+      { name: 'actionCallData', type: 'bytes' },
+      { name: 'amountLimit', type: 'uint256' },
+      { name: 'extraOptions', type: 'bytes' },
+    ],
+    outputs: [{ name: 'guid', type: 'bytes32' }],
+    stateMutability: 'payable',
+  },
+  {
+    type: 'function',
+    name: 'executeRequest',
+    inputs: [
+      { name: 'guid', type: 'bytes32' },
+    ],
+    outputs: [],
+    stateMutability: 'nonpayable',
+  },
+] as const
+
+/**
+ * ERC7540Facet ABI — async deposit and redeem operations on ERC7540 vaults.
+ */
+export const ERC7540_FACET_ABI = [
+  {
+    type: 'function',
+    name: 'erc7540RequestDeposit',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'assets', type: 'uint256' },
+    ],
+    outputs: [{ name: 'requestId', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'erc7540RequestRedeem',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'shares', type: 'uint256' },
+    ],
+    outputs: [{ name: 'requestId', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'erc7540Deposit',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'assets', type: 'uint256' },
+    ],
+    outputs: [{ name: 'shares', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'erc7540Redeem',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'shares', type: 'uint256' },
+    ],
+    outputs: [{ name: 'assets', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+] as const
+
+/**
+ * ConfigurationFacet ABI — extended with curator-relevant read functions.
+ * Augments the existing CONFIG_ABI with additional getters needed by curator dashboard.
+ */
+export const CURATOR_CONFIG_ABI = [
+  {
+    type: 'function',
+    name: 'curator',
+    inputs: [],
+    outputs: [{ name: '', type: 'address' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'timeLockPeriod',
+    inputs: [],
+    outputs: [{ name: '', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'getAvailableAssets',
+    inputs: [],
+    outputs: [{ name: '', type: 'address[]' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'getMaxSlippagePercent',
+    inputs: [],
+    outputs: [{ name: '', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'getCrossChainAccountingManager',
+    inputs: [],
+    outputs: [{ name: '', type: 'address' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'paused',
+    inputs: [],
+    outputs: [{ name: '', type: 'bool' }],
+    stateMutability: 'view',
+  },
+] as const
+
+/**
+ * LzAdapter ABI — fee quoting for bridge and LZ Read operations.
+ */
+export const LZ_ADAPTER_ABI = [
+  {
+    type: 'function',
+    name: 'quoteBridgeFee',
+    inputs: [
+      { name: 'bridgeSpecificParams', type: 'bytes' },
+    ],
+    outputs: [{ name: 'nativeFee', type: 'uint256' }],
+    stateMutability: 'view',
+  },
+  {
+    type: 'function',
+    name: 'quoteReadFee',
+    inputs: [
+      { name: 'vaults', type: 'address[]' },
+      { name: 'eids', type: 'uint32[]' },
+      { name: '_extraOptions', type: 'bytes' },
+    ],
+    outputs: [
+      {
+        name: 'fee',
+        type: 'tuple',
+        components: [
+          { name: 'nativeFee', type: 'uint256' },
+          { name: 'lzTokenFee', type: 'uint256' },
+        ],
+      },
+    ],
+    stateMutability: 'view',
+  },
+] as const
+
+/**
+ * ERC4626Facet ABI — synchronous deposit and redeem into whitelisted ERC-4626 vaults.
+ */
+export const ERC4626_FACET_ABI = [
+  {
+    type: 'function',
+    name: 'erc4626Deposit',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'assets', type: 'uint256' },
+    ],
+    outputs: [{ name: 'shares', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+  {
+    type: 'function',
+    name: 'erc4626Redeem',
+    inputs: [
+      { name: 'vault', type: 'address' },
+      { name: 'shares', type: 'uint256' },
+    ],
+    outputs: [{ name: 'assets', type: 'uint256' }],
+    stateMutability: 'nonpayable',
+  },
+] as const
+
+/**
+ * Vault analysis ABIs — per-vault whitelist and registry reads.
+ */
+export const VAULT_ANALYSIS_ABI = [
+  // Asset management reads
+  { type: 'function', name: 'getAvailableAssets', inputs: [], outputs: [{ type: 'address[]' }], stateMutability: 'view' },
+  { type: 'function', name: 'getDepositableAssets', inputs: [], outputs: [{ type: 'address[]' }], stateMutability: 'view' },
+  { type: 'function', name: 'isAssetAvailable', inputs: [{ name: 'asset', type: 'address' }], outputs: [{ type: 'bool' }], stateMutability: 'view' },
+  { type: 'function', name: 'isAssetDepositable', inputs: [{ name: 'asset', type: 'address' }], outputs: [{ type: 'bool' }], stateMutability: 'view' },
+  // Deposit whitelist
+  { type: 'function', name: 'isDepositWhitelistEnabled', inputs: [], outputs: [{ type: 'bool' }], stateMutability: 'view' },
+  { type: 'function', name: 'getAvailableToDeposit', inputs: [{ name: 'depositor', type: 'address' }], outputs: [{ type: 'uint256' }], stateMutability: 'view' },
+  // Registry
+  { type: 'function', name: 'moreVaultsRegistry', inputs: [], outputs: [{ type: 'address' }], stateMutability: 'view' },
+] as const
+
+/**
+ * MoreVaultsRegistry ABI — global protocol and bridge whitelist checks.
+ */
+export const REGISTRY_ABI = [
+  { type: 'function', name: 'isWhitelisted', inputs: [{ name: 'protocol', type: 'address' }], outputs: [{ type: 'bool' }], stateMutability: 'view' },
+  { type: 'function', name: 'isBridgeAllowed', inputs: [{ name: 'bridge', type: 'address' }], outputs: [{ type: 'bool' }], stateMutability: 'view' },
+  { type: 'function', name: 'getAllowedFacets', inputs: [], outputs: [{ type: 'address[]' }], stateMutability: 'view' },
+] as const
+
 /**
  * Minimal LZ Endpoint V2 ABI for compose queue management.
  * Used by the Stargate 2-TX flow to check compose status and execute pending composes.

package/src/viem/curatorMulticall.ts

@@ -0,0 +1,299 @@
+/**
+ * Curator MulticallFacet write operations for the MoreVaults SDK.
+ *
+ * Provides typed helpers to submit, execute, and veto curator action batches
+ * on any MoreVaults diamond that has the MulticallFacet installed.
+ *
+ * All write functions use the simulate-then-write pattern:
+ *   1. `publicClient.simulateContract` — validates on-chain, catches reverts early
+ *   2. `walletClient.writeContract`    — sends the actual transaction
+ *
+ * @module curatorMulticall
+ */
+
+import {
+  type Address,
+  type PublicClient,
+  type WalletClient,
+  encodeFunctionData,
+  getAddress,
+} from 'viem'
+import {
+  MULTICALL_ABI,
+  DEX_ABI,
+  ERC7540_FACET_ABI,
+  ERC4626_FACET_ABI,
+} from './abis.js'
+import type {
+  CuratorAction,
+  SubmitActionsResult,
+} from './types.js'
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Encoding helpers
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Encode a single typed CuratorAction into raw calldata bytes suitable for
+ * passing into `submitActions(bytes[] actionsData)`.
+ *
+ * The encoded bytes are the full ABI-encoded function call (4-byte selector +
+ * arguments) targeting the vault diamond itself — the MulticallFacet will
+ * call `address(this).call(actionsData[i])` for each entry.
+ *
+ * @param action  A discriminated-union CuratorAction describing what to do
+ * @returns       ABI-encoded calldata bytes (`0x`-prefixed hex string)
+ */
+export function encodeCuratorAction(action: CuratorAction): `0x${string}` {
+  switch (action.type) {
+    case 'swap':
+      return encodeFunctionData({
+        abi: DEX_ABI,
+        functionName: 'executeSwap',
+        args: [
+          {
+            targetContract: getAddress(action.params.targetContract),
+            tokenIn: getAddress(action.params.tokenIn),
+            tokenOut: getAddress(action.params.tokenOut),
+            maxAmountIn: action.params.maxAmountIn,
+            minAmountOut: action.params.minAmountOut,
+            swapCallData: action.params.swapCallData,
+          },
+        ],
+      })
+
+    case 'batchSwap':
+      return encodeFunctionData({
+        abi: DEX_ABI,
+        functionName: 'executeBatchSwap',
+        args: [
+          {
+            swaps: action.params.swaps.map((s) => ({
+              targetContract: getAddress(s.targetContract),
+              tokenIn: getAddress(s.tokenIn),
+              tokenOut: getAddress(s.tokenOut),
+              maxAmountIn: s.maxAmountIn,
+              minAmountOut: s.minAmountOut,
+              swapCallData: s.swapCallData,
+            })),
+          },
+        ],
+      })
+
+    case 'erc4626Deposit':
+      return encodeFunctionData({
+        abi: ERC4626_FACET_ABI,
+        functionName: 'erc4626Deposit',
+        args: [getAddress(action.vault), action.assets],
+      })
+
+    case 'erc4626Redeem':
+      return encodeFunctionData({
+        abi: ERC4626_FACET_ABI,
+        functionName: 'erc4626Redeem',
+        args: [getAddress(action.vault), action.shares],
+      })
+
+    case 'erc7540RequestDeposit':
+      return encodeFunctionData({
+        abi: ERC7540_FACET_ABI,
+        functionName: 'erc7540RequestDeposit',
+        args: [getAddress(action.vault), action.assets],
+      })
+
+    case 'erc7540Deposit':
+      return encodeFunctionData({
+        abi: ERC7540_FACET_ABI,
+        functionName: 'erc7540Deposit',
+        args: [getAddress(action.vault), action.assets],
+      })
+
+    case 'erc7540RequestRedeem':
+      return encodeFunctionData({
+        abi: ERC7540_FACET_ABI,
+        functionName: 'erc7540RequestRedeem',
+        args: [getAddress(action.vault), action.shares],
+      })
+
+    case 'erc7540Redeem':
+      return encodeFunctionData({
+        abi: ERC7540_FACET_ABI,
+        functionName: 'erc7540Redeem',
+        args: [getAddress(action.vault), action.shares],
+      })
+
+    default: {
+      // TypeScript exhaustiveness check — this branch is never reached at runtime
+      const _exhaustive: never = action
+      throw new Error(`[MoreVaults] Unknown CuratorAction type: ${(_exhaustive as any).type}`)
+    }
+  }
+}
+
+/**
+ * Encode an array of CuratorActions into a calldata array ready for
+ * `submitActions`.
+ *
+ * @param actions  Array of typed CuratorAction objects
+ * @returns        Array of ABI-encoded calldata hex strings
+ */
+export function buildCuratorBatch(actions: CuratorAction[]): `0x${string}`[] {
+  return actions.map(encodeCuratorAction)
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Write operations
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Submit a batch of curator actions to the vault's MulticallFacet.
+ *
+ * When `timeLockPeriod == 0` the contract immediately executes the actions
+ * inside `submitActions` itself. When a timelock is configured the actions
+ * are queued and must be executed later with `executeActions`.
+ *
+ * Uses the simulate-then-write pattern: simulation runs first so any on-chain
+ * revert (wrong curator, bad selector, slippage limit, etc.) surfaces before
+ * any gas is spent on a failing transaction.
+ *
+ * After the write succeeds, the function reads `getCurrentNonce` to determine
+ * which nonce was assigned to this batch (nonce - 1 after the submit increments it).
+ *
+ * @param walletClient  Wallet client with curator account attached
+ * @param publicClient  Public client for reads and simulation
+ * @param vault         Vault address (diamond proxy)
+ * @param actions       Array of raw calldata bytes — use `buildCuratorBatch` to build
+ * @returns             Transaction hash and the nonce assigned to this batch
+ * @throws              If the caller is not the curator, or any action selector is
+ *                      not allowed, or any action would revert
+ */
+export async function submitActions(
+  walletClient: WalletClient,
+  publicClient: PublicClient,
+  vault: Address,
+  actions: `0x${string}`[],
+): Promise<SubmitActionsResult> {
+  const account = walletClient.account!
+  const v = getAddress(vault)
+
+  // Simulate first — catches permission errors and reverts before spending gas
+  await publicClient.simulateContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'submitActions',
+    args: [actions],
+    account: account.address,
+  })
+
+  const txHash = await walletClient.writeContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'submitActions',
+    args: [actions],
+    account,
+    chain: walletClient.chain,
+  })
+
+  // Read the nonce that was assigned: the contract increments actionNonce after storing,
+  // so getCurrentNonce now returns (assignedNonce + 1). Subtract 1 to recover it.
+  const nextNonce = await publicClient.readContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'getCurrentNonce',
+  })
+
+  const nonce = nextNonce - 1n
+
+  return { txHash, nonce }
+}
+
+/**
+ * Execute pending actions after their timelock period has expired.
+ *
+ * Can only be called when `block.timestamp >= pendingUntil`. The contract
+ * reverts with `ActionsStillPending` if the timelock has not expired.
+ *
+ * Caller must be the curator (or any address when timeLockPeriod == 0, since
+ * in that case `submitActions` auto-executes and there is nothing to execute here).
+ *
+ * Uses simulate-then-write to surface on-chain reverts early.
+ *
+ * @param walletClient  Wallet client with curator account attached
+ * @param publicClient  Public client for reads and simulation
+ * @param vault         Vault address (diamond proxy)
+ * @param nonce         The action batch nonce to execute
+ * @returns             Transaction hash
+ */
+export async function executeActions(
+  walletClient: WalletClient,
+  publicClient: PublicClient,
+  vault: Address,
+  nonce: bigint,
+): Promise<{ txHash: `0x${string}` }> {
+  const account = walletClient.account!
+  const v = getAddress(vault)
+
+  // Simulate to surface reverts (NoSuchActions, ActionsStillPending, slippage)
+  await publicClient.simulateContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'executeActions',
+    args: [nonce],
+    account: account.address,
+  })
+
+  const txHash = await walletClient.writeContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'executeActions',
+    args: [nonce],
+    account,
+    chain: walletClient.chain,
+  })
+
+  return { txHash }
+}
+
+/**
+ * Guardian-only: cancel (veto) one or more pending action batches.
+ *
+ * Deletes the pending actions from storage, preventing them from ever being
+ * executed. Only the vault guardian can call this.
+ *
+ * Uses simulate-then-write to catch `NoSuchActions` and permission errors early.
+ *
+ * @param walletClient  Wallet client with guardian account attached
+ * @param publicClient  Public client for reads and simulation
+ * @param vault         Vault address (diamond proxy)
+ * @param nonces        Array of action nonces to cancel
+ * @returns             Transaction hash
+ */
+export async function vetoActions(
+  walletClient: WalletClient,
+  publicClient: PublicClient,
+  vault: Address,
+  nonces: bigint[],
+): Promise<{ txHash: `0x${string}` }> {
+  const account = walletClient.account!
+  const v = getAddress(vault)
+
+  // Simulate to catch NotGuardian, NoSuchActions, etc.
+  await publicClient.simulateContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'vetoActions',
+    args: [nonces],
+    account: account.address,
+  })
+
+  const txHash = await walletClient.writeContract({
+    address: v,
+    abi: MULTICALL_ABI,
+    functionName: 'vetoActions',
+    args: [nonces],
+    account,
+    chain: walletClient.chain,
+  })
+
+  return { txHash }
+}