@coinbase/agentkit 0.8.0 → 0.8.2

package/README.md

@@ -418,6 +418,19 @@ const agent = createReactAgent({
 </table>
 </details>
 <details>
+<summary><strong>X402</strong></summary>
+<table width="100%">
+<tr>
+    <td width="200"><code>paid_request</code></td>
+    <td width="768">Makes HTTP requests to x402-protected API endpoints with automatic payment handling.</td>
+</tr>
+<tr>
+    <td width="200"><code>fetch_payment_info</code></td>
+    <td width="768">Fetches payment information from x402-protected endpoints without making payments.</td>
+</tr>
+</table>
+</details>
+<details>
 <summary><strong>ZeroDev Wallet</strong></summary>
 <table width="100%">
 <tr>
@@ -1024,7 +1037,7 @@ The `CdpV2SolanaWalletProvider` supports the following Solana networks:
 
 ### SolanaKeypairWalletProvider
 
-The `SolanaKeypairWalletProvider` is a wallet provider that uses the API [Solana web3.js](https://solana-labs.github.io/solana-web3.js/).
+The `SolanaKeypairWalletProvider` is a wallet provider that uses the API [Solana web3.js](https://solana.com/docs/clients/javascript).
 
 NOTE: It is highly recommended to use a dedicated RPC provider. See [here](https://solana.com/rpc) for more info on Solana RPC infrastructure, and see [here](#rpc-url-configuration) for instructions on configuring `SolanaKeypairWalletProvider` with a custom RPC URL.
 

package/dist/action-providers/index.d.ts

@@ -26,4 +26,5 @@ export * from "./allora";
 export * from "./flaunch";
 export * from "./onramp";
 export * from "./vaultsfyi";
+export * from "./x402";
 export * from "./zerodev";

package/dist/action-providers/index.js

@@ -42,4 +42,5 @@ __exportStar(require("./allora"), exports);
 __exportStar(require("./flaunch"), exports);
 __exportStar(require("./onramp"), exports);
 __exportStar(require("./vaultsfyi"), exports);
+__exportStar(require("./x402"), exports);
 __exportStar(require("./zerodev"), exports);

package/dist/action-providers/vaultsfyi/api/historicalData.d.ts

@@ -0,0 +1,31 @@
+import z from "zod";
+import { VaultHistoricalDataActionSchema } from "../schemas";
+import { ApiError } from "./types";
+type ApyData = {
+    timestamp: number;
+    blockNumber: number;
+    apy: {
+        base: number;
+        rewards: number;
+        total: number;
+    };
+};
+type TvlData = {
+    timestamp: number;
+    blockNumber: number;
+    tvlDetails: {
+        tvlUsd: number;
+    };
+};
+/**
+ * Fetch historical data for a vault
+ *
+ * @param args - The arguments for the action
+ * @param apiKey - The API key to use for the request
+ * @returns The historical data for the vault
+ */
+export declare function fetchVaultHistoricalData(args: z.infer<typeof VaultHistoricalDataActionSchema>, apiKey: string): Promise<ApiError | {
+    apy: ApyData;
+    tvl: TvlData;
+}>;
+export {};

package/dist/action-providers/vaultsfyi/api/historicalData.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchVaultHistoricalData = fetchVaultHistoricalData;
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+/**
+ * Fetch historical data for a vault
+ *
+ * @param args - The arguments for the action
+ * @param apiKey - The API key to use for the request
+ * @returns The historical data for the vault
+ */
+async function fetchVaultHistoricalData(args, apiKey) {
+    const params = (0, utils_1.createSearchParams)({
+        interval: args.apyRange ?? "7day",
+    });
+    const timestamp = new Date(args.date).getTime() / 1000;
+    const [tvlResponse, apyResponse] = await Promise.all([
+        fetch(`${constants_1.VAULTS_API_URL}/vaults/${args.network}/${args.vaultAddress}/historical-tvl/${timestamp}?${params}`, {
+            method: "GET",
+            headers: {
+                "x-api-key": apiKey,
+            },
+        }),
+        fetch(`${constants_1.VAULTS_API_URL}/vaults/${args.network}/${args.vaultAddress}/historical-apy/${timestamp}?${params}`, {
+            method: "GET",
+            headers: {
+                "x-api-key": apiKey,
+            },
+        }),
+    ]);
+    const [apy, tvl] = await Promise.all([
+        apyResponse.json(),
+        tvlResponse.json(),
+    ]);
+    if ("error" in apy)
+        return apy;
+    if ("error" in tvl)
+        return tvl;
+    return {
+        apy,
+        tvl,
+    };
+}

package/dist/action-providers/vaultsfyi/api/vaults.d.ts

@@ -1,11 +1,17 @@
 import z from "zod";
-import { VaultsActionSchema } from "../schemas";
+import { VaultDetailsActionSchema, VaultsActionSchema } from "../schemas";
 import { ApiError } from "./types";
+type ApyData = {
+    "1day": number;
+    "7day": number;
+    "30day": number;
+};
 export type ApiVault = {
     name: string;
     address: string;
     network: string;
     protocol: string;
+    isTransactional: boolean;
     tvlDetails: {
         tvlUsd: string;
     };
@@ -16,17 +22,30 @@ export type ApiVault = {
         decimals: number;
     };
     apy: {
-        base: {
-            "7day": number;
-        };
-        rewards: {
-            "7day": number;
-        };
-        total: {
-            "7day": number;
+        base: ApyData;
+        rewards: ApyData;
+        total: ApyData;
+    };
+    numberOfHolders: number;
+    rewards: {
+        apy: ApyData;
+        asset: {
+            name: string;
+            symbol: string;
+            assetAddress: string;
+            decimals: number;
         };
+    }[];
+    description: string;
+    additionalIncentives: string;
+    score: {
+        vaultScore: number;
+        vaultTvlScore: number;
+        protocolTvlScore: number;
+        holderScore: number;
+        networkScore: number;
+        assetScore: number;
     };
-    isTransactional: boolean;
 };
 /**
  * Fetches a list of vaults from the vaultsfyi API.
@@ -36,3 +55,12 @@ export type ApiVault = {
  * @returns The list of vaults
  */
 export declare function fetchVaults(args: z.infer<typeof VaultsActionSchema>, apiKey: string): Promise<ApiVault[] | ApiError>;
+/**
+ * Fetches the details of a specific vault from the vaultsfyi API.
+ *
+ * @param args - The action parameters
+ * @param apiKey - The vaultsfyi API key
+ * @returns The vault details
+ */
+export declare function fetchVault(args: z.infer<typeof VaultDetailsActionSchema>, apiKey: string): Promise<ApiError | ApiVault>;
+export {};

package/dist/action-providers/vaultsfyi/api/vaults.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchVaults = fetchVaults;
+exports.fetchVault = fetchVault;
 const utils_1 = require("../utils");
 const constants_1 = require("../constants");
 /**
@@ -17,7 +18,7 @@ async function fetchVaults(args, apiKey) {
         token: args.token,
         network: args.network,
         tvl_min: args.minTvl ?? 100000,
-        transactional_only: true,
+        transactionalOnly: true,
     });
     for (let i = 0; i < 10; i++) {
         const response = await fetch(`${constants_1.VAULTS_API_URL}/detailed/vaults?${params}`, {
@@ -37,3 +38,20 @@ async function fetchVaults(args, apiKey) {
     }
     return vaults;
 }
+/**
+ * Fetches the details of a specific vault from the vaultsfyi API.
+ *
+ * @param args - The action parameters
+ * @param apiKey - The vaultsfyi API key
+ * @returns The vault details
+ */
+async function fetchVault(args, apiKey) {
+    const response = await fetch(`${constants_1.VAULTS_API_URL}/vaults/${args.network}/${args.vaultAddress}`, {
+        method: "GET",
+        headers: {
+            "x-api-key": apiKey,
+        },
+    });
+    const data = (await response.json());
+    return data;
+}

package/dist/action-providers/vaultsfyi/schemas.d.ts

@@ -3,9 +3,9 @@ import { z } from "zod";
  * Vaults list action schema.
  */
 export declare const VaultsActionSchema: z.ZodObject<{
-    token: z.ZodOptional<z.ZodString>;
-    protocol: z.ZodOptional<z.ZodString>;
-    network: z.ZodOptional<z.ZodEnum<[string, ...string[]]>>;
+    token: z.ZodOptional<z.ZodEffects<z.ZodString, string | undefined, string>>;
+    protocol: z.ZodOptional<z.ZodEffects<z.ZodString, string | undefined, string>>;
+    network: z.ZodEffects<z.ZodOptional<z.ZodUnion<[z.ZodEnum<[string, ...string[]]>, z.ZodEnum<["", "all"]>]>>, string | undefined, string | undefined>;
     minTvl: z.ZodOptional<z.ZodNumber>;
     sort: z.ZodOptional<z.ZodObject<{
         field: z.ZodOptional<z.ZodEnum<["tvl", "apy", "name"]>>;
@@ -17,6 +17,7 @@ export declare const VaultsActionSchema: z.ZodObject<{
         field?: "name" | "tvl" | "apy" | undefined;
         direction?: "asc" | "desc" | undefined;
     }>>;
+    apyRange: z.ZodOptional<z.ZodEnum<["1day", "7day", "30day"]>>;
     take: z.ZodOptional<z.ZodNumber>;
     page: z.ZodOptional<z.ZodNumber>;
 }, "strip", z.ZodTypeAny, {
@@ -28,6 +29,7 @@ export declare const VaultsActionSchema: z.ZodObject<{
     token?: string | undefined;
     protocol?: string | undefined;
     minTvl?: number | undefined;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
     take?: number | undefined;
     page?: number | undefined;
 }, {
@@ -39,9 +41,42 @@ export declare const VaultsActionSchema: z.ZodObject<{
     token?: string | undefined;
     protocol?: string | undefined;
     minTvl?: number | undefined;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
     take?: number | undefined;
     page?: number | undefined;
 }>;
+/**
+ * Vault details action schema.
+ */
+export declare const VaultDetailsActionSchema: z.ZodObject<{
+    vaultAddress: z.ZodString;
+    network: z.ZodEnum<[string, ...string[]]>;
+    apyRange: z.ZodOptional<z.ZodEnum<["1day", "7day", "30day"]>>;
+}, "strip", z.ZodTypeAny, {
+    network: string;
+    vaultAddress: string;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
+}, {
+    network: string;
+    vaultAddress: string;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
+}>;
+export declare const VaultHistoricalDataActionSchema: z.ZodObject<{
+    vaultAddress: z.ZodString;
+    network: z.ZodEnum<[string, ...string[]]>;
+    date: z.ZodString;
+    apyRange: z.ZodOptional<z.ZodEnum<["1day", "7day", "30day"]>>;
+}, "strip", z.ZodTypeAny, {
+    network: string;
+    date: string;
+    vaultAddress: string;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
+}, {
+    network: string;
+    date: string;
+    vaultAddress: string;
+    apyRange?: "1day" | "7day" | "30day" | undefined;
+}>;
 export declare const depositActionSchema: z.ZodObject<{
     vaultAddress: z.ZodString;
     assetAddress: z.ZodString;

package/dist/action-providers/vaultsfyi/schemas.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.claimActionSchema = exports.redeemActionSchema = exports.depositActionSchema = exports.VaultsActionSchema = void 0;
+exports.claimActionSchema = exports.redeemActionSchema = exports.depositActionSchema = exports.VaultHistoricalDataActionSchema = exports.VaultDetailsActionSchema = exports.VaultsActionSchema = void 0;
 const zod_1 = require("zod");
 const constants_1 = require("./constants");
 /**
@@ -16,10 +16,18 @@ const NetworkSchema = zod_1.z.enum(Object.values(constants_1.VAULTSFYI_SUPPORTED
 exports.VaultsActionSchema = zod_1.z.object({
     token: zod_1.z
         .string()
+        .transform(val => (val === "" ? undefined : val))
         .optional()
         .describe("Optional: Name or symbol of the token to filter vaults by"),
-    protocol: zod_1.z.string().optional().describe("Optional: Protocol to filter vaults by"),
-    network: NetworkSchema.optional().describe("Optional: Network name to filter vaults by. Supported networks: mainnet, arbitrum, optimism, polygon, base, gnosis, unichain"),
+    protocol: zod_1.z
+        .string()
+        .transform(val => (val === "" ? undefined : val))
+        .optional()
+        .describe("Optional: Protocol to filter vaults by"),
+    network: NetworkSchema.or(zod_1.z.enum(["", "all"]))
+        .optional()
+        .transform(val => (val === "" || val === "all" ? undefined : val))
+        .describe("Optional: Network name to filter vaults by. Supported networks: mainnet, arbitrum, optimism, polygon, base, gnosis, unichain"),
     minTvl: zod_1.z.number().optional().describe("Optional: Minimum TVL to filter vaults by"),
     sort: zod_1.z
         .object({
@@ -28,9 +36,33 @@ exports.VaultsActionSchema = zod_1.z.object({
     })
         .optional()
         .describe("Sort options"),
+    apyRange: zod_1.z
+        .enum(["1day", "7day", "30day"])
+        .optional()
+        .describe("Optional: APY moving average range (default: 7day)"),
     take: zod_1.z.number().optional().describe("Optional: Limit the number of results"),
     page: zod_1.z.number().optional().describe("Optional: Page number"),
 });
+/**
+ * Vault details action schema.
+ */
+exports.VaultDetailsActionSchema = zod_1.z.object({
+    vaultAddress: zod_1.z.string().describe("The address of the vault to fetch details for"),
+    network: NetworkSchema.describe("The network of the vault"),
+    apyRange: zod_1.z
+        .enum(["1day", "7day", "30day"])
+        .optional()
+        .describe("Optional: APY moving average range (default: 7day)"),
+});
+exports.VaultHistoricalDataActionSchema = zod_1.z.object({
+    vaultAddress: zod_1.z.string().describe("The address of the vault to fetch historical data for"),
+    network: NetworkSchema.describe("The network of the vault"),
+    date: zod_1.z.string().datetime().describe("The date to fetch historical data for"),
+    apyRange: zod_1.z
+        .enum(["1day", "7day", "30day"])
+        .optional()
+        .describe("Optional: APY moving average range (default: 7day)"),
+});
 /**
  * Base transaction params schema.
  */

package/dist/action-providers/vaultsfyi/utils.d.ts

@@ -32,3 +32,67 @@ export declare function createSearchParams(obj: Record<string, string | number |
  * @returns The parsed amount
  */
 export declare function parseAssetAmount(wallet: EvmWalletProvider, assetAddress: string, amount: number): Promise<number>;
+/**
+ * Transform a vault from the API to a format that can be used by the agent
+ *
+ * @param vault - The vault to transform
+ * @param apyRange - The APY range to use
+ * @returns The transformed vault
+ */
+export declare function transformVault(vault: ApiVault, apyRange: "1day" | "7day" | "30day"): {
+    name: string;
+    address: string;
+    network: string;
+    protocol: string;
+    tvlInUsd: number;
+    numberOfHolders: number;
+    apy: {
+        base: number;
+        rewards: number | undefined;
+        total: number;
+    };
+    token: {
+        address: string;
+        name: string;
+        symbol: string;
+    };
+    vaultsFyiScore: number;
+    link: string;
+};
+/**
+ * Transform a detailed vault from the API to a format that can be used by the agent
+ *
+ * @param vault - The vault to transform
+ * @param apyRange - The APY range to use
+ * @returns The transformed vault
+ */
+export declare function transformDetailedVault(vault: ApiVault, apyRange: "1day" | "7day" | "30day"): {
+    rewards: {
+        apy: number;
+        asset: {
+            address: string;
+            name: string;
+            symbol: string;
+        };
+    }[];
+    description: string;
+    additionalIncentives: string;
+    name: string;
+    address: string;
+    network: string;
+    protocol: string;
+    tvlInUsd: number;
+    numberOfHolders: number;
+    apy: {
+        base: number;
+        rewards: number | undefined;
+        total: number;
+    };
+    token: {
+        address: string;
+        name: string;
+        symbol: string;
+    };
+    vaultsFyiScore: number;
+    link: string;
+};

package/dist/action-providers/vaultsfyi/utils.js

@@ -4,6 +4,8 @@ exports.getVaultsLink = getVaultsLink;
 exports.executeActions = executeActions;
 exports.createSearchParams = createSearchParams;
 exports.parseAssetAmount = parseAssetAmount;
+exports.transformVault = transformVault;
+exports.transformDetailedVault = transformDetailedVault;
 const viem_1 = require("viem");
 /**
  * Get the link to the vaults.fyi page for a vault
@@ -67,3 +69,54 @@ async function parseAssetAmount(wallet, assetAddress, amount) {
     });
     return Math.floor(amount * 10 ** decimals);
 }
+/**
+ * Transform a vault from the API to a format that can be used by the agent
+ *
+ * @param vault - The vault to transform
+ * @param apyRange - The APY range to use
+ * @returns The transformed vault
+ */
+function transformVault(vault, apyRange) {
+    return {
+        name: vault.name,
+        address: vault.address,
+        network: vault.network,
+        protocol: vault.protocol,
+        tvlInUsd: Number(vault.tvlDetails.tvlUsd),
+        numberOfHolders: vault.numberOfHolders,
+        apy: {
+            base: vault.apy.base[apyRange] / 100,
+            rewards: vault.apy.rewards?.[apyRange] ? vault.apy.rewards[apyRange] / 100 : undefined,
+            total: vault.apy.total[apyRange] / 100,
+        },
+        token: {
+            address: vault.token.assetAddress,
+            name: vault.token.name,
+            symbol: vault.token.symbol,
+        },
+        vaultsFyiScore: vault.score.vaultScore,
+        link: getVaultsLink(vault),
+    };
+}
+/**
+ * Transform a detailed vault from the API to a format that can be used by the agent
+ *
+ * @param vault - The vault to transform
+ * @param apyRange - The APY range to use
+ * @returns The transformed vault
+ */
+function transformDetailedVault(vault, apyRange) {
+    return {
+        ...transformVault(vault, apyRange),
+        rewards: vault.rewards.map(reward => ({
+            apy: reward.apy[apyRange] / 100,
+            asset: {
+                address: reward.asset.assetAddress,
+                name: reward.asset.name,
+                symbol: reward.asset.symbol,
+            },
+        })),
+        description: vault.description,
+        additionalIncentives: vault.additionalIncentives,
+    };
+}

package/dist/action-providers/vaultsfyi/vaultsfyiActionProvider.d.ts

@@ -10,7 +10,7 @@ import { z } from "zod";
 import { ActionProvider } from "../actionProvider";
 import { Network } from "../../network";
 import { EvmWalletProvider } from "../../wallet-providers";
-import { claimActionSchema, depositActionSchema, redeemActionSchema, VaultsActionSchema } from "./schemas";
+import { claimActionSchema, depositActionSchema, redeemActionSchema, VaultDetailsActionSchema, VaultHistoricalDataActionSchema, VaultsActionSchema } from "./schemas";
 /**
  * Configuration options for the OpenseaActionProvider.
  */
@@ -39,10 +39,26 @@ export declare class VaultsfyiActionProvider extends ActionProvider<EvmWalletPro
      * vaults action
      *
      * @param wallet - The wallet provider instance for blockchain interactions
-     * @param args - Input arguments: token, network, transactionalOnly...
+     * @param args - Input arguments: token, network...
      * @returns A list of vaults.
      */
     vaults(wallet: EvmWalletProvider, args: z.infer<typeof VaultsActionSchema>): Promise<string>;
+    /**
+     * vault details action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: address, network, apyRange
+     * @returns A detailed view of a single vault.
+     */
+    vaultDetails(wallet: EvmWalletProvider, args: z.infer<typeof VaultDetailsActionSchema>): Promise<string>;
+    /**
+     * vault historical data action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: address, network, date, apyRange
+     * @returns A detailed view of a single vault.
+     */
+    vaultHistoricalData(wallet: EvmWalletProvider, args: z.infer<typeof VaultHistoricalDataActionSchema>): Promise<string>;
     /**
      * Deposit action
      *