@coinbase/agentkit 0.10.2 → 0.10.4

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

@@ -1,13 +1,12 @@
 import { EvmWalletProvider } from "../../wallet-providers";
-import { ApiVault } from "./api/vaults";
-import { Actions } from "./api/actions";
+import { VaultsSdk } from "@vaultsfyi/sdk";
 /**
  * Get the link to the vaults.fyi page for a vault
  *
  * @param vault - The vault
  * @returns The link to the vaults.fyi page
  */
-export declare function getVaultsLink(vault: ApiVault): string;
+export declare function getVaultsLink(vault: Awaited<ReturnType<VaultsSdk["getVault"]>>): string;
 /**
  * Execute a list of actions
  *
@@ -15,84 +14,181 @@ export declare function getVaultsLink(vault: ApiVault): string;
  * @param actions - The list of actions to execute
  * @returns nothing
  */
-export declare function executeActions(wallet: EvmWalletProvider, actions: Actions): Promise<void>;
+export declare function executeActions(wallet: EvmWalletProvider, actions: Awaited<ReturnType<VaultsSdk["getActions"]>>): Promise<void>;
+type Apy = {
+    base: number;
+    reward: number;
+    total: number;
+};
+type ApyObject = {
+    "1day": Apy;
+    "7day": Apy;
+    "30day": Apy;
+    "1hour"?: Apy;
+};
 /**
- * Create a URLSearchParams object from an object
+ * Transform the apy object to a more readable format
  *
- * @param obj - The object to convert
- * @returns The URLSearchParams object
+ * @param apy - The apy
+ * @returns The transformed apy
  */
-export declare function createSearchParams(obj: Record<string, string | number | boolean | undefined>): URLSearchParams;
+export declare function transformApyObject(apy: ApyObject): Record<string, {
+    base: string;
+    reward: string;
+    total: string;
+}>;
 /**
- * Parse an asset amount with decimals
+ * Transform the apy to a more readable format
  *
- * @param wallet - The wallet provider
- * @param assetAddress - The address of the asset
- * @param amount - The amount to parse
- * @returns The parsed amount
+ * @param apy - The apy
+ * @returns The transformed apy
  */
-export declare function parseAssetAmount(wallet: EvmWalletProvider, assetAddress: string, amount: number): Promise<number>;
+export declare function transformApy(apy: Apy): {
+    base: string;
+    reward: string;
+    total: string;
+};
 /**
- * Transform a vault from the API to a format that can be used by the agent
+ * Transform the vault to a more readable format
  *
- * @param vault - The vault to transform
- * @param apyRange - The APY range to use
+ * @param vault - The vault
  * @returns The transformed vault
  */
-export declare function transformVault(vault: ApiVault, apyRange: "1day" | "7day" | "30day"): {
-    name: string;
+export declare function transformVault(vault: Awaited<ReturnType<VaultsSdk["getVault"]>>): {
+    apy: Record<string, {
+        base: string;
+        reward: string;
+        total: string;
+    }>;
+    link: string;
+    lastUpdateTimestamp: string;
     address: string;
-    network: string;
-    protocol: string;
-    tvlInUsd: number;
-    numberOfHolders: number;
-    apy: {
-        base: number;
-        rewards: number | undefined;
-        total: number;
+    network: {
+        name: "mainnet" | "optimism" | "arbitrum" | "polygon" | "gnosis" | "base" | "unichain" | "swellchain" | "celo" | "worldchain" | "berachain" | "ink" | "bsc" | "hyperliquid" | "plasma" | "avalanche";
+        chainId: number;
+        networkCaip: string;
     };
-    token: {
+    asset: {
         address: string;
+        assetCaip: string;
         name: string;
         symbol: string;
+        decimals: number;
+        assetLogo?: string;
+        assetPriceInUsd?: string;
+        assetGroup: string;
+    };
+    isTransactional: boolean;
+    isAppFeatured: boolean;
+    name: string;
+    protocol: {
+        name: string;
+        product?: string;
+        version?: string;
+        protocolUrl?: string;
+        description?: string;
+        protocolLogo?: string;
+    };
+    lendUrl?: string;
+    description?: string;
+    protocolVaultUrl?: string;
+    tags: string[];
+    holdersData: {
+        totalCount?: number;
+        totalBalance?: string;
+        topHolders?: {
+            address: string;
+            lpTokenBalance: string;
+        }[];
+    };
+    tvl: {
+        usd: string;
+        native: 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;
+            assetCaip: string;
             name: string;
             symbol: string;
+            decimals: number;
+            assetLogo?: string;
+            assetPriceInUsd?: string;
+            assetGroup: string;
+        };
+        apy: {
+            "1hour": number;
+            "1day": number;
+            "7day": number;
+            "30day": number;
         };
     }[];
-    description: string;
-    additionalIncentives: string;
-    name: string;
-    address: string;
-    network: string;
-    protocol: string;
-    tvlInUsd: number;
-    numberOfHolders: number;
-    apy: {
-        base: number;
-        rewards: number | undefined;
-        total: number;
+    score?: {
+        vaultScore: number;
+        vaultTvlScore: number;
+        protocolTvlScore: number;
+        holderScore: number;
+        networkScore: number;
+        assetScore: number;
     };
-    token: {
+    additionalIncentives?: string;
+    curator?: {
+        name: string;
+        description?: string;
+        websiteUrl?: string;
+    };
+    lpToken?: {
         address: string;
+        tokenCaip: string;
         name: string;
         symbol: string;
+        decimals: number;
     };
-    vaultsFyiScore: number;
-    link: string;
+    childrenVaults?: {
+        address: string;
+        asset: {
+            address: string;
+            assetCaip: string;
+            name: string;
+            symbol: string;
+            decimals: number;
+            assetLogo?: string;
+            assetPriceInUsd?: string;
+            assetGroup: string;
+        };
+        lpToken?: {
+            address: string;
+            tokenCaip: string;
+            name: string;
+            symbol: string;
+            decimals: number;
+        };
+        additionalAssets?: {
+            address: string;
+            assetCaip: string;
+            name: string;
+            symbol: string;
+            decimals: number;
+            assetLogo?: string;
+            assetPriceInUsd?: string;
+            assetGroup: string;
+        }[];
+    }[];
+    additionalAssets?: {
+        address: string;
+        assetCaip: string;
+        name: string;
+        symbol: string;
+        decimals: number;
+        assetLogo?: string;
+        assetPriceInUsd?: string;
+        assetGroup: string;
+    }[];
+    transactionalProperties?: {
+        depositStepsType: "instant" | "complex";
+        redeemStepsType: "instant" | "complex";
+        rewardsSupported: boolean;
+    };
+    warnings: string[];
 };
+export {};

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

@@ -2,11 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getVaultsLink = getVaultsLink;
 exports.executeActions = executeActions;
-exports.createSearchParams = createSearchParams;
-exports.parseAssetAmount = parseAssetAmount;
+exports.transformApyObject = transformApyObject;
+exports.transformApy = transformApy;
 exports.transformVault = transformVault;
-exports.transformDetailedVault = transformDetailedVault;
-const viem_1 = require("viem");
 /**
  * Get the link to the vaults.fyi page for a vault
  *
@@ -14,12 +12,7 @@ const viem_1 = require("viem");
  * @returns The link to the vaults.fyi page
  */
 function getVaultsLink(vault) {
-    if (vault.isTransactional) {
-        return `https://app.vaults.fyi/opportunity/${vault.network}/${vault.address}`;
-    }
-    else {
-        return `https://analytics.vaults.fyi/vaults/${vault.network}/${vault.address}`;
-    }
+    return `https://app.vaults.fyi/opportunity/${vault.network.name}/${vault.address}`;
 }
 /**
  * Execute a list of actions
@@ -32,91 +25,52 @@ async function executeActions(wallet, actions) {
     for (let i = actions.currentActionIndex; i < actions.actions.length; i++) {
         const action = actions.actions[i];
         const txHash = await wallet.sendTransaction({
-            ...action.tx,
+            to: action.tx.to,
+            data: action.tx.data,
             value: action.tx.value ? BigInt(action.tx.value) : undefined,
         });
         await wallet.waitForTransactionReceipt(txHash);
     }
 }
 /**
- * Create a URLSearchParams object from an object
+ * Transform the apy object to a more readable format
  *
- * @param obj - The object to convert
- * @returns The URLSearchParams object
+ * @param apy - The apy
+ * @returns The transformed apy
  */
-function createSearchParams(obj) {
-    const params = new URLSearchParams();
-    for (const key in obj) {
-        if (obj[key] !== undefined) {
-            params.append(key, obj[key].toString());
+function transformApyObject(apy) {
+    return ["1day", "7day", "30day", "1hour"].reduce((acc, curr) => {
+        if (!(curr in apy)) {
+            return acc;
         }
-    }
-    return params;
-}
-/**
- * Parse an asset amount with decimals
- *
- * @param wallet - The wallet provider
- * @param assetAddress - The address of the asset
- * @param amount - The amount to parse
- * @returns The parsed amount
- */
-async function parseAssetAmount(wallet, assetAddress, amount) {
-    const decimals = await wallet.readContract({
-        address: assetAddress,
-        abi: viem_1.erc20Abi,
-        functionName: "decimals",
-    });
-    return Math.floor(amount * 10 ** decimals);
+        acc[curr] = transformApy(apy[curr]);
+        return acc;
+    }, {});
 }
 /**
- * Transform a vault from the API to a format that can be used by the agent
+ * Transform the apy to a more readable format
  *
- * @param vault - The vault to transform
- * @param apyRange - The APY range to use
- * @returns The transformed vault
+ * @param apy - The apy
+ * @returns The transformed apy
  */
-function transformVault(vault, apyRange) {
+function transformApy(apy) {
     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),
+        base: `${(apy.base * 100).toFixed(2)}%`,
+        reward: `${(apy.reward * 100).toFixed(2)}%`,
+        total: `${(apy.total * 100).toFixed(2)}%`,
     };
 }
 /**
- * Transform a detailed vault from the API to a format that can be used by the agent
+ * Transform the vault to a more readable format
  *
- * @param vault - The vault to transform
- * @param apyRange - The APY range to use
+ * @param vault - The vault
  * @returns The transformed vault
  */
-function transformDetailedVault(vault, apyRange) {
+function transformVault(vault) {
     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,
+        ...vault,
+        apy: transformApyObject(vault.apy),
+        link: getVaultsLink(vault),
+        lastUpdateTimestamp: new Date(vault.lastUpdateTimestamp * 1000).toISOString(),
     };
 }

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

@@ -10,9 +10,9 @@ import { z } from "zod";
 import { ActionProvider } from "../actionProvider";
 import { Network } from "../../network";
 import { EvmWalletProvider } from "../../wallet-providers";
-import { claimActionSchema, depositActionSchema, redeemActionSchema, VaultDetailsActionSchema, VaultHistoricalDataActionSchema, VaultsActionSchema } from "./schemas";
+import { executeStepActionSchema, transactionContextActionSchema, VaultDetailsActionSchema, VaultHistoricalDataActionSchema, VaultsActionSchema, claimRewardsActionSchema, benchmarkActionSchema, historicalBenchmarkActionSchema, totalVaultReturnsActionSchema, userEventsActionSchema } from "./schemas";
 /**
- * Configuration options for the OpenseaActionProvider.
+ * Configuration options for the VaultsfyiActionProvider.
  */
 export interface VaultsfyiActionProviderConfig {
     /**
@@ -60,36 +60,28 @@ export declare class VaultsfyiActionProvider extends ActionProvider<EvmWalletPro
      */
     vaultHistoricalData(wallet: EvmWalletProvider, args: z.infer<typeof VaultHistoricalDataActionSchema>): Promise<string>;
     /**
-     * Deposit action
+     * Transaction context action
      *
      * @param wallet - The wallet provider instance for blockchain interactions
      * @param args - Input arguments
      * @returns A result message
      */
-    deposit(wallet: EvmWalletProvider, args: z.infer<typeof depositActionSchema>): Promise<string>;
+    transactionContext(wallet: EvmWalletProvider, args: z.infer<typeof transactionContextActionSchema>): Promise<string>;
     /**
-     * Redeem action
-     *
-     * @param wallet - The wallet provider instance for blockchain interactions
-     * @param args - Input arguments
-     * @returns A result message
-     */
-    redeem(wallet: EvmWalletProvider, args: z.infer<typeof redeemActionSchema>): Promise<string>;
-    /**
-     * Claim rewards action
+     * Deposit action
      *
      * @param wallet - The wallet provider instance for blockchain interactions
      * @param args - Input arguments
      * @returns A result message
      */
-    claim(wallet: EvmWalletProvider, args: z.infer<typeof claimActionSchema>): Promise<string>;
+    executeStep(wallet: EvmWalletProvider, args: z.infer<typeof executeStepActionSchema>): Promise<string>;
     /**
      * Returns the users wallet token balances.
      *
      * @param wallet - The wallet provider instance for blockchain interactions
      * @returns A record of the users balances
      */
-    balances(wallet: EvmWalletProvider): Promise<string>;
+    idleAssets(wallet: EvmWalletProvider): Promise<string>;
     /**
      * Returns the users positions.
      *
@@ -97,6 +89,53 @@ export declare class VaultsfyiActionProvider extends ActionProvider<EvmWalletPro
      * @returns A record of the users positions
      */
     positions(wallet: EvmWalletProvider): Promise<string>;
+    /**
+     * Rewards context action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @returns A record of rewards that are available to the user each with a unique claim id
+     */
+    rewardsContext(wallet: EvmWalletProvider): Promise<string>;
+    /**
+     * Claim rewards action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: claimIds
+     * @returns A message indicating the success of the claim
+     */
+    claimRewards(wallet: EvmWalletProvider, args: z.infer<typeof claimRewardsActionSchema>): Promise<string>;
+    /**
+     * Benchmark APY action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: network, benchmarkCode
+     * @returns benchmark APY data
+     */
+    benchmarkApy(wallet: EvmWalletProvider, args: z.infer<typeof benchmarkActionSchema>): Promise<string>;
+    /**
+     * Historical benchmark APY action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: network, benchmarkCode, fromDate, toDate, page, perPage
+     * @returns A list of historical benchmark APY data
+     */
+    historicalBenchmarkApy(wallet: EvmWalletProvider, args: z.infer<typeof historicalBenchmarkActionSchema>): Promise<string>;
+    /**
+     * Total vault returns action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: vaultAddress, network, userAddress
+     * @returns An amount of the users total returns
+     */
+    totalVaultReturns(wallet: EvmWalletProvider, args: z.infer<typeof totalVaultReturnsActionSchema>): Promise<string>;
+    /**
+     * User events action
+     *
+     * @param wallet - The wallet provider instance for blockchain interactions
+     * @param args - Input arguments: vaultAddress, network, userAddress
+     * @returns A list of the users actions on a vault
+     */
+    userEvents(wallet: EvmWalletProvider, args: z.infer<typeof userEventsActionSchema>): Promise<string>;
     /**
      * Checks if this provider supports the given network.
      *
@@ -111,4 +150,4 @@ export declare class VaultsfyiActionProvider extends ActionProvider<EvmWalletPro
  * @param config - Configuration options for the provider
  * @returns A new VaultsfyiActionProvider instance
  */
-export declare const vaultsfyiActionProvider: (config: VaultsfyiActionProviderConfig) => VaultsfyiActionProvider;
+export declare const vaultsfyiActionProvider: (config?: VaultsfyiActionProviderConfig) => VaultsfyiActionProvider;