@oydual31/more-vaults-sdk 0.2.9 → 0.3.0

package/package.json

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

package/src/viem/abis.ts

@@ -451,6 +451,284 @@ 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
+
 /**
  * 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/curatorStatus.ts

@@ -0,0 +1,124 @@
+/**
+ * Curator / vault-manager read helpers for the MoreVaults SDK.
+ *
+ * All functions are read-only (no wallet needed) and use multicall for
+ * batched RPC efficiency.
+ */
+
+import { type Address, type PublicClient, getAddress } from 'viem'
+import { MULTICALL_ABI, CURATOR_CONFIG_ABI } from './abis.js'
+import type { CuratorVaultStatus, PendingAction } from './types.js'
+
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Read a comprehensive status snapshot for the curator dashboard.
+ *
+ * Fetches in two batches (multicall) to minimise round trips:
+ *   Batch 1: curator, timeLockPeriod, getMaxSlippagePercent, getCurrentNonce,
+ *            getAvailableAssets, getCrossChainAccountingManager, paused
+ *
+ * @param publicClient  Viem public client (must be on the vault's chain)
+ * @param vault         Vault address (diamond proxy)
+ * @returns             CuratorVaultStatus snapshot
+ */
+export async function getCuratorVaultStatus(
+  publicClient: PublicClient,
+  vault: Address,
+): Promise<CuratorVaultStatus> {
+  const v = getAddress(vault)
+
+  const [
+    curator,
+    timeLockPeriod,
+    maxSlippagePercent,
+    currentNonce,
+    availableAssets,
+    lzAdapter,
+    paused,
+  ] = await publicClient.multicall({
+    contracts: [
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'curator' },
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'timeLockPeriod' },
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'getMaxSlippagePercent' },
+      { address: v, abi: MULTICALL_ABI,      functionName: 'getCurrentNonce' },
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'getAvailableAssets' },
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'getCrossChainAccountingManager' },
+      { address: v, abi: CURATOR_CONFIG_ABI, functionName: 'paused' },
+    ],
+    allowFailure: false,
+  })
+
+  return {
+    curator: getAddress(curator as Address),
+    timeLockPeriod: timeLockPeriod as bigint,
+    maxSlippagePercent: maxSlippagePercent as bigint,
+    currentNonce: currentNonce as bigint,
+    availableAssets: (availableAssets as Address[]).map(getAddress),
+    lzAdapter: getAddress(lzAdapter as Address),
+    paused: paused as boolean,
+  }
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Fetch pending actions for a specific nonce and resolve whether they are
+ * executable (i.e. the timelock has expired).
+ *
+ * @param publicClient  Viem public client (must be on the vault's chain)
+ * @param vault         Vault address (diamond proxy)
+ * @param nonce         Action nonce to query
+ * @returns             PendingAction with isExecutable flag set
+ */
+export async function getPendingActions(
+  publicClient: PublicClient,
+  vault: Address,
+  nonce: bigint,
+): Promise<PendingAction> {
+  const v = getAddress(vault)
+
+  const [actionsResult, block] = await Promise.all([
+    publicClient.readContract({
+      address: v,
+      abi: MULTICALL_ABI,
+      functionName: 'getPendingActions',
+      args: [nonce],
+    }),
+    publicClient.getBlock(),
+  ])
+
+  const [actionsData, pendingUntil] = actionsResult as [`0x${string}`[], bigint]
+  const isExecutable = pendingUntil > 0n && block.timestamp >= pendingUntil
+
+  return {
+    nonce,
+    actionsData,
+    pendingUntil,
+    isExecutable,
+  }
+}
+
+// ─────────────────────────────────────────────────────────────────────────────
+
+/**
+ * Check whether a given address is the curator of the vault.
+ *
+ * @param publicClient  Viem public client (must be on the vault's chain)
+ * @param vault         Vault address (diamond proxy)
+ * @param address       Address to check
+ * @returns             true if address is the current curator
+ */
+export async function isCurator(
+  publicClient: PublicClient,
+  vault: Address,
+  address: Address,
+): Promise<boolean> {
+  const curatorAddress = await publicClient.readContract({
+    address: getAddress(vault),
+    abi: CURATOR_CONFIG_ABI,
+    functionName: 'curator',
+  })
+
+  return getAddress(curatorAddress as Address) === getAddress(address)
+}

package/src/viem/index.ts

@@ -13,6 +13,12 @@ export {
   OFT_ABI,
   METADATA_ABI,
   LZ_ENDPOINT_ABI,
+  MULTICALL_ABI,
+  DEX_ABI,
+  BRIDGE_FACET_ABI,
+  ERC7540_FACET_ABI,
+  CURATOR_CONFIG_ABI,
+  LZ_ADAPTER_ABI,
 } from './abis'
 
 // --- Types ---
@@ -25,6 +31,13 @@ export type {
   ActionTypeValue,
   ComposeData,
   SpokeDepositResult,
+  SwapParams,
+  BatchSwapParams,
+  BridgeParams,
+  PendingAction,
+  SubmitActionsResult,
+  CuratorAction,
+  CuratorVaultStatus,
 } from './types'
 export { ActionType } from './types'
 
@@ -137,6 +150,13 @@ export type { VaultDistribution, SpokeBalance } from './distribution'
 export { getInboundRoutes, getUserBalancesForRoutes, getOutboundRoutes, quoteRouteDepositFee, NATIVE_SYMBOL } from './spokeRoutes'
 export type { InboundRoute, InboundRouteWithBalance, OutboundRoute } from './spokeRoutes'
 
+// --- Curator Operations ---
+export {
+  getCuratorVaultStatus,
+  getPendingActions,
+  isCurator,
+} from './curatorStatus'
+
 // --- wagmi compatibility ---
 // Re-export viem's PublicClient type for wagmi compatibility.
 // wagmi's usePublicClient() returns a type that is structurally compatible

package/src/viem/types.ts

@@ -98,3 +98,60 @@ export interface CrossChainRequestInfo {
   finalizationResult: bigint
   amountLimit: bigint
 }
+
+// ─────────────────────────────────────────────────────────────────────────────
+// Curator Operations Types
+// ─────────────────────────────────────────────────────────────────────────────
+
+export interface SwapParams {
+  targetContract: Address
+  tokenIn: Address
+  tokenOut: Address
+  maxAmountIn: bigint
+  minAmountOut: bigint
+  swapCallData: `0x${string}`
+}
+
+export interface BatchSwapParams {
+  swaps: SwapParams[]
+}
+
+export interface BridgeParams {
+  oftToken: Address
+  dstEid: number
+  amount: bigint
+  dstVault: Address
+  refundAddress: Address
+}
+
+export interface PendingAction {
+  nonce: bigint
+  actionsData: `0x${string}`[]
+  pendingUntil: bigint
+  isExecutable: boolean
+}
+
+export interface SubmitActionsResult {
+  txHash: `0x${string}`
+  nonce: bigint
+}
+
+export type CuratorAction =
+  | { type: 'swap'; params: SwapParams }
+  | { type: 'batchSwap'; params: BatchSwapParams }
+  | { type: 'erc4626Deposit'; vault: Address; assets: bigint }
+  | { type: 'erc4626Redeem'; vault: Address; shares: bigint }
+  | { type: 'erc7540RequestDeposit'; vault: Address; assets: bigint }
+  | { type: 'erc7540Deposit'; vault: Address; assets: bigint }
+  | { type: 'erc7540RequestRedeem'; vault: Address; shares: bigint }
+  | { type: 'erc7540Redeem'; vault: Address; shares: bigint }
+
+export interface CuratorVaultStatus {
+  curator: Address
+  timeLockPeriod: bigint
+  maxSlippagePercent: bigint
+  currentNonce: bigint
+  availableAssets: Address[]
+  lzAdapter: Address
+  paused: boolean
+}