@coinbase/agentkit/dist/action-providers/vaultsfyi/schemas.d.ts

Coinbase AgentKit core primitives

import { z } from "zod";
/**
 * Vaults list action schema.
 */
export declare const VaultsActionSchema: z.ZodObject<{
    allowedAssets: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
    allowedProtocols: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
    allowedNetworks: z.ZodOptional<z.ZodArray<z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>, "many">>;
    minTvl: z.ZodOptional<z.ZodNumber>;
    sort: z.ZodOptional<z.ZodObject<{
        field: z.ZodOptional<z.ZodEnum<["tvl", "apy1day", "apy7day", "apy30day"]>>;
        direction: z.ZodOptional<z.ZodEnum<["asc", "desc"]>>;
    }, "strip", z.ZodTypeAny, {
        field?: "tvl" | "apy1day" | "apy7day" | "apy30day" | undefined;
        direction?: "asc" | "desc" | undefined;
    }, {
        field?: "tvl" | "apy1day" | "apy7day" | "apy30day" | undefined;
        direction?: "asc" | "desc" | undefined;
    }>>;
    perPage: z.ZodOptional<z.ZodNumber>;
    page: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
    sort?: {
        field?: "tvl" | "apy1day" | "apy7day" | "apy30day" | undefined;
        direction?: "asc" | "desc" | undefined;
    } | undefined;
    allowedAssets?: string[] | undefined;
    allowedProtocols?: string[] | undefined;
    allowedNetworks?: ("arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid")[] | undefined;
    minTvl?: number | undefined;
    perPage?: number | undefined;
    page?: number | undefined;
}, {
    sort?: {
        field?: "tvl" | "apy1day" | "apy7day" | "apy30day" | undefined;
        direction?: "asc" | "desc" | undefined;
    } | undefined;
    allowedAssets?: string[] | undefined;
    allowedProtocols?: string[] | undefined;
    allowedNetworks?: ("arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid")[] | undefined;
    minTvl?: number | undefined;
    perPage?: number | undefined;
    page?: number | undefined;
}>;
/**
 * Vault details action schema.
 */
export declare const VaultDetailsActionSchema: z.ZodObject<{
    vaultAddress: z.ZodString;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
}>;
export declare const VaultHistoricalDataActionSchema: z.ZodObject<{
    vaultAddress: z.ZodString;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
    fromDate: z.ZodString;
    toDate: z.ZodString;
    granularity: z.ZodEnum<["1hour", "1day", "1week"]>;
    apyInterval: z.ZodEnum<["1day", "7day", "30day"]>;
    page: z.ZodOptional<z.ZodNumber>;
    perPage: z.ZodOptional<z.ZodNumber>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    granularity: "1hour" | "1day" | "1week";
    fromDate: string;
    toDate: string;
    apyInterval: "1day" | "7day" | "30day";
    perPage?: number | undefined;
    page?: number | undefined;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    granularity: "1hour" | "1day" | "1week";
    fromDate: string;
    toDate: string;
    apyInterval: "1day" | "7day" | "30day";
    perPage?: number | undefined;
    page?: number | undefined;
}>;
/**
 * Base transaction params schema.
 */
export declare const transactionContextActionSchema: z.ZodObject<{
    vaultAddress: z.ZodString;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
}>;
export declare const executeStepActionSchema: z.ZodObject<z.objectUtil.extendShape<{
    vaultAddress: z.ZodString;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
}, {
    action: z.ZodEnum<["deposit", "redeem", "request-redeem", "request-deposit", "claim-redeem", "claim-deposit", "claim-rewards", "start-redeem-cooldown"]>;
    assetAddress: z.ZodString;
    amount: z.ZodOptional<z.ZodUnion<[z.ZodBigInt, z.ZodLiteral<"all">]>>;
}>, "strip", z.ZodTypeAny, {
    action: "deposit" | "redeem" | "request-redeem" | "request-deposit" | "claim-redeem" | "claim-deposit" | "claim-rewards" | "start-redeem-cooldown";
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    assetAddress: string;
    amount?: bigint | "all" | undefined;
}, {
    action: "deposit" | "redeem" | "request-redeem" | "request-deposit" | "claim-redeem" | "claim-deposit" | "claim-rewards" | "start-redeem-cooldown";
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    assetAddress: string;
    amount?: bigint | "all" | undefined;
}>;
export declare const claimRewardsActionSchema: z.ZodObject<{
    claimIds: z.ZodArray<z.ZodString, "many">;
}, "strip", z.ZodTypeAny, {
    claimIds: string[];
}, {
    claimIds: string[];
}>;
export declare const benchmarkActionSchema: z.ZodObject<{
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
    benchmarkCode: z.ZodEnum<["eth", "usd"]>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    benchmarkCode: "eth" | "usd";
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    benchmarkCode: "eth" | "usd";
}>;
export declare const historicalBenchmarkActionSchema: z.ZodObject<z.objectUtil.extendShape<{
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
    benchmarkCode: z.ZodEnum<["eth", "usd"]>;
}, {
    fromDate: z.ZodString;
    toDate: z.ZodString;
    page: z.ZodOptional<z.ZodNumber>;
    perPage: z.ZodOptional<z.ZodNumber>;
}>, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    fromDate: string;
    toDate: string;
    benchmarkCode: "eth" | "usd";
    perPage?: number | undefined;
    page?: number | undefined;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    fromDate: string;
    toDate: string;
    benchmarkCode: "eth" | "usd";
    perPage?: number | undefined;
    page?: number | undefined;
}>;
export declare const totalVaultReturnsActionSchema: z.ZodObject<{
    vaultAddress: z.ZodString;
    userAddress: z.ZodOptional<z.ZodString>;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    userAddress?: string | undefined;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    userAddress?: string | undefined;
}>;
export declare const userEventsActionSchema: z.ZodObject<{
    vaultAddress: z.ZodString;
    userAddress: z.ZodOptional<z.ZodString>;
    network: z.ZodEnum<["mainnet", "optimism", "arbitrum", "polygon", "gnosis", "base", "unichain", "swellchain", "celo", "worldchain", "berachain", "ink", "bsc", "hyperliquid", "plasma", "avalanche"]>;
}, "strip", z.ZodTypeAny, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    userAddress?: string | undefined;
}, {
    network: "arbitrum" | "avalanche" | "base" | "berachain" | "bsc" | "celo" | "gnosis" | "ink" | "mainnet" | "optimism" | "plasma" | "polygon" | "swellchain" | "unichain" | "worldchain" | "hyperliquid";
    vaultAddress: string;
    userAddress?: string | undefined;
}>;