@oydual31/more-vaults-sdk 0.4.0 → 0.4.2

package/dist/react/index.d.cts

@@ -1,5 +1,5 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { j as VaultStatus, h as VaultMetadata, g as UserPosition, e as MultiChainUserPosition, b as AsyncRequestStatusInfo, l as VaultTopology, V as VaultDistribution, d as InboundRouteWithBalance } from '../spokeRoutes-BIafSbQ3.cjs';
+import { z as VaultStatus, x as VaultMetadata, v as UserPosition, r as MultiChainUserPosition, l as AsyncRequestStatusInfo, F as VaultTopology, w as VaultDistribution, q as InboundRouteWithBalance, a as CuratorVaultStatus, b as VaultAnalysis, c as VaultAssetBreakdown, P as PendingAction, e as SubmitActionsResult, d as CuratorAction } from '../spokeRoutes-B8Lnk-t4.cjs';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import { Address } from 'viem';
 
@@ -536,4 +536,113 @@ declare function getRouteTokenDecimals(symbol: string): number;
  */
 declare function useInboundRoutes(hubChainId: number | undefined, vault: Address | undefined, vaultAsset: Address | undefined, userAddress: Address | undefined): UseInboundRoutesReturn;
 
-export { AsyncRequestStatusInfo, MultiChainUserPosition, UserPosition, VaultMetadata, VaultStatus, VaultTopology, getRouteTokenDecimals, useAsyncRequestStatus, useDepositSimple, useInboundRoutes, useLzFee, useOmniDeposit, useOmniRedeem, useRedeemShares, useSmartDeposit, useSmartRedeem, useUserPosition, useUserPositionMultiChain, useVaultDistribution, useVaultMetadata, useVaultStatus, useVaultTopology };
+interface UseCuratorVaultStatusOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read the curator vault status snapshot.
+ *
+ * @example
+ * const { data: status, isLoading } = useCuratorVaultStatus('0xVAULT', 747)
+ */
+declare function useCuratorVaultStatus(vault: `0x${string}` | undefined, chainId: number, options?: UseCuratorVaultStatusOptions): _tanstack_react_query.UseQueryResult<CuratorVaultStatus, Error>;
+
+interface UseVaultAnalysisOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read a detailed analysis of a vault.
+ *
+ * @example
+ * const { data: analysis, isLoading } = useVaultAnalysis('0xVAULT', 747)
+ */
+declare function useVaultAnalysis(vault: `0x${string}` | undefined, chainId: number, options?: UseVaultAnalysisOptions): _tanstack_react_query.UseQueryResult<VaultAnalysis, Error>;
+
+interface UseVaultAssetBreakdownOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read the asset breakdown of a vault.
+ *
+ * @example
+ * const { data: breakdown, isLoading } = useVaultAssetBreakdown('0xVAULT', 747)
+ */
+declare function useVaultAssetBreakdown(vault: `0x${string}` | undefined, chainId: number, options?: UseVaultAssetBreakdownOptions): _tanstack_react_query.UseQueryResult<VaultAssetBreakdown, Error>;
+
+interface UsePendingActionsOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read pending curator actions for a vault by nonce.
+ *
+ * @example
+ * const { data: pending, isLoading } = usePendingActions('0xVAULT', 747, 1n)
+ */
+declare function usePendingActions(vault: `0x${string}` | undefined, chainId: number, nonce: bigint | undefined, options?: UsePendingActionsOptions): _tanstack_react_query.UseQueryResult<PendingAction, Error>;
+
+interface UseIsCuratorOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Check whether an address is a curator of a vault.
+ *
+ * @example
+ * const { data: curator, isLoading } = useIsCurator('0xVAULT', 747, '0xADDR')
+ */
+declare function useIsCurator(vault: `0x${string}` | undefined, chainId: number, address: `0x${string}` | undefined, options?: UseIsCuratorOptions): _tanstack_react_query.UseQueryResult<boolean, Error>;
+
+interface UseProtocolWhitelistOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Check which protocols are whitelisted for a vault.
+ *
+ * @example
+ * const { data: whitelist, isLoading } = useProtocolWhitelist('0xVAULT', 747, ['0xPROTOCOL'])
+ */
+declare function useProtocolWhitelist(vault: `0x${string}` | undefined, chainId: number, protocols: `0x${string}`[], options?: UseProtocolWhitelistOptions): _tanstack_react_query.UseQueryResult<Record<string, boolean>, Error>;
+
+/**
+ * Submit a batch of curator actions to the vault.
+ *
+ * @example
+ * const { mutateAsync } = useSubmitActions('0xVAULT', 747)
+ * await mutateAsync({ actions: [{ type: 'erc4626Deposit', vault: '0x...', assets: 100n }] })
+ */
+declare function useSubmitActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<SubmitActionsResult, Error, {
+    actions: CuratorAction[];
+}, unknown>;
+
+/**
+ * Execute a pending curator action batch by nonce.
+ *
+ * @example
+ * const { mutateAsync } = useExecuteActions('0xVAULT', 747)
+ * await mutateAsync({ nonce: 1n })
+ */
+declare function useExecuteActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<{
+    txHash: `0x${string}`;
+}, Error, {
+    nonce: bigint;
+}, unknown>;
+
+/**
+ * Guardian-only: cancel (veto) one or more pending curator action batches.
+ *
+ * @example
+ * const { mutateAsync } = useVetoActions('0xVAULT', 747)
+ * await mutateAsync({ nonces: [1n, 2n] })
+ */
+declare function useVetoActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<{
+    txHash: `0x${string}`;
+}, Error, {
+    nonces: bigint[];
+}, unknown>;
+
+export { AsyncRequestStatusInfo, CuratorAction, CuratorVaultStatus, MultiChainUserPosition, PendingAction, UserPosition, VaultAnalysis, VaultAssetBreakdown, VaultMetadata, VaultStatus, VaultTopology, getRouteTokenDecimals, useAsyncRequestStatus, useCuratorVaultStatus, useDepositSimple, useExecuteActions, useInboundRoutes, useIsCurator, useLzFee, useOmniDeposit, useOmniRedeem, usePendingActions, useProtocolWhitelist, useRedeemShares, useSmartDeposit, useSmartRedeem, useSubmitActions, useUserPosition, useUserPositionMultiChain, useVaultAnalysis, useVaultAssetBreakdown, useVaultDistribution, useVaultMetadata, useVaultStatus, useVaultTopology, useVetoActions };

package/dist/react/index.d.ts

@@ -1,5 +1,5 @@
 import * as _tanstack_react_query from '@tanstack/react-query';
-import { j as VaultStatus, h as VaultMetadata, g as UserPosition, e as MultiChainUserPosition, b as AsyncRequestStatusInfo, l as VaultTopology, V as VaultDistribution, d as InboundRouteWithBalance } from '../spokeRoutes-BIafSbQ3.js';
+import { z as VaultStatus, x as VaultMetadata, v as UserPosition, r as MultiChainUserPosition, l as AsyncRequestStatusInfo, F as VaultTopology, w as VaultDistribution, q as InboundRouteWithBalance, a as CuratorVaultStatus, b as VaultAnalysis, c as VaultAssetBreakdown, P as PendingAction, e as SubmitActionsResult, d as CuratorAction } from '../spokeRoutes-B8Lnk-t4.js';
 import * as _tanstack_query_core from '@tanstack/query-core';
 import { Address } from 'viem';
 
@@ -536,4 +536,113 @@ declare function getRouteTokenDecimals(symbol: string): number;
  */
 declare function useInboundRoutes(hubChainId: number | undefined, vault: Address | undefined, vaultAsset: Address | undefined, userAddress: Address | undefined): UseInboundRoutesReturn;
 
-export { AsyncRequestStatusInfo, MultiChainUserPosition, UserPosition, VaultMetadata, VaultStatus, VaultTopology, getRouteTokenDecimals, useAsyncRequestStatus, useDepositSimple, useInboundRoutes, useLzFee, useOmniDeposit, useOmniRedeem, useRedeemShares, useSmartDeposit, useSmartRedeem, useUserPosition, useUserPositionMultiChain, useVaultDistribution, useVaultMetadata, useVaultStatus, useVaultTopology };
+interface UseCuratorVaultStatusOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read the curator vault status snapshot.
+ *
+ * @example
+ * const { data: status, isLoading } = useCuratorVaultStatus('0xVAULT', 747)
+ */
+declare function useCuratorVaultStatus(vault: `0x${string}` | undefined, chainId: number, options?: UseCuratorVaultStatusOptions): _tanstack_react_query.UseQueryResult<CuratorVaultStatus, Error>;
+
+interface UseVaultAnalysisOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read a detailed analysis of a vault.
+ *
+ * @example
+ * const { data: analysis, isLoading } = useVaultAnalysis('0xVAULT', 747)
+ */
+declare function useVaultAnalysis(vault: `0x${string}` | undefined, chainId: number, options?: UseVaultAnalysisOptions): _tanstack_react_query.UseQueryResult<VaultAnalysis, Error>;
+
+interface UseVaultAssetBreakdownOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read the asset breakdown of a vault.
+ *
+ * @example
+ * const { data: breakdown, isLoading } = useVaultAssetBreakdown('0xVAULT', 747)
+ */
+declare function useVaultAssetBreakdown(vault: `0x${string}` | undefined, chainId: number, options?: UseVaultAssetBreakdownOptions): _tanstack_react_query.UseQueryResult<VaultAssetBreakdown, Error>;
+
+interface UsePendingActionsOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Read pending curator actions for a vault by nonce.
+ *
+ * @example
+ * const { data: pending, isLoading } = usePendingActions('0xVAULT', 747, 1n)
+ */
+declare function usePendingActions(vault: `0x${string}` | undefined, chainId: number, nonce: bigint | undefined, options?: UsePendingActionsOptions): _tanstack_react_query.UseQueryResult<PendingAction, Error>;
+
+interface UseIsCuratorOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Check whether an address is a curator of a vault.
+ *
+ * @example
+ * const { data: curator, isLoading } = useIsCurator('0xVAULT', 747, '0xADDR')
+ */
+declare function useIsCurator(vault: `0x${string}` | undefined, chainId: number, address: `0x${string}` | undefined, options?: UseIsCuratorOptions): _tanstack_react_query.UseQueryResult<boolean, Error>;
+
+interface UseProtocolWhitelistOptions {
+    /** Refetch interval in ms. Default: 30_000 (30s) */
+    refetchInterval?: number;
+}
+/**
+ * Check which protocols are whitelisted for a vault.
+ *
+ * @example
+ * const { data: whitelist, isLoading } = useProtocolWhitelist('0xVAULT', 747, ['0xPROTOCOL'])
+ */
+declare function useProtocolWhitelist(vault: `0x${string}` | undefined, chainId: number, protocols: `0x${string}`[], options?: UseProtocolWhitelistOptions): _tanstack_react_query.UseQueryResult<Record<string, boolean>, Error>;
+
+/**
+ * Submit a batch of curator actions to the vault.
+ *
+ * @example
+ * const { mutateAsync } = useSubmitActions('0xVAULT', 747)
+ * await mutateAsync({ actions: [{ type: 'erc4626Deposit', vault: '0x...', assets: 100n }] })
+ */
+declare function useSubmitActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<SubmitActionsResult, Error, {
+    actions: CuratorAction[];
+}, unknown>;
+
+/**
+ * Execute a pending curator action batch by nonce.
+ *
+ * @example
+ * const { mutateAsync } = useExecuteActions('0xVAULT', 747)
+ * await mutateAsync({ nonce: 1n })
+ */
+declare function useExecuteActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<{
+    txHash: `0x${string}`;
+}, Error, {
+    nonce: bigint;
+}, unknown>;
+
+/**
+ * Guardian-only: cancel (veto) one or more pending curator action batches.
+ *
+ * @example
+ * const { mutateAsync } = useVetoActions('0xVAULT', 747)
+ * await mutateAsync({ nonces: [1n, 2n] })
+ */
+declare function useVetoActions(vault: `0x${string}`, chainId: number): _tanstack_react_query.UseMutationResult<{
+    txHash: `0x${string}`;
+}, Error, {
+    nonces: bigint[];
+}, unknown>;
+
+export { AsyncRequestStatusInfo, CuratorAction, CuratorVaultStatus, MultiChainUserPosition, PendingAction, UserPosition, VaultAnalysis, VaultAssetBreakdown, VaultMetadata, VaultStatus, VaultTopology, getRouteTokenDecimals, useAsyncRequestStatus, useCuratorVaultStatus, useDepositSimple, useExecuteActions, useInboundRoutes, useIsCurator, useLzFee, useOmniDeposit, useOmniRedeem, usePendingActions, useProtocolWhitelist, useRedeemShares, useSmartDeposit, useSmartRedeem, useSubmitActions, useUserPosition, useUserPositionMultiChain, useVaultAnalysis, useVaultAssetBreakdown, useVaultDistribution, useVaultMetadata, useVaultStatus, useVaultTopology, useVetoActions };