From f76cc9cf8ec317389bfe9f733729b4e8d7767e1d Mon Sep 17 00:00:00 2001 From: Arihant Bansal <17180950+arihantbansal@users.noreply.github.com> Date: Sun, 22 Dec 2024 01:33:49 +0530 Subject: [PATCH] fix --- guides/add_your_own_tool.md | 2 +- src/tools/create_image.ts | 2 +- src/tools/create_orca_single_sided_whirlpool.ts | 2 +- src/tools/deploy_collection.ts | 2 +- src/tools/deploy_token.ts | 2 +- src/tools/get_balance.ts | 2 +- src/tools/get_primary_domain.ts | 2 +- src/tools/launch_pumpfun_token.ts | 2 +- src/tools/lend.ts | 2 +- src/tools/mint_nft.ts | 2 +- src/tools/register_domain.ts | 2 +- src/tools/request_faucet_funds.ts | 2 +- src/tools/resolve_sol_domain.ts | 2 +- src/tools/stake_with_jup.ts | 2 +- src/tools/trade.ts | 2 +- src/tools/transfer.ts | 2 +- src/utils/send_tx.ts | 2 +- 17 files changed, 17 insertions(+), 17 deletions(-) diff --git a/guides/add_your_own_tool.md b/guides/add_your_own_tool.md index 47782cb..1bcb200 100644 --- a/guides/add_your_own_tool.md +++ b/guides/add_your_own_tool.md @@ -53,7 +53,7 @@ export class CustomTool extends Tool { ### 3. Add Supporting Functions to SolanaAgentKit ```typescript:src/agent/index.ts -export class SolanaAgent { +export class SolanaAgentKit { // ... existing code ... async customFunction(input: string): Promise { diff --git a/src/tools/create_image.ts b/src/tools/create_image.ts index b1b085d..7fbb2cf 100644 --- a/src/tools/create_image.ts +++ b/src/tools/create_image.ts @@ -3,7 +3,7 @@ import OpenAI from "openai"; /** * Generate an image using OpenAI's DALL-E - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param prompt Text description of the image to generate * @param size Image size ('256x256', '512x512', or '1024x1024') (default: '1024x1024') * @param n Number of images to generate (default: 1) diff --git a/src/tools/create_orca_single_sided_whirlpool.ts b/src/tools/create_orca_single_sided_whirlpool.ts index bed5870..7f3c4a9 100644 --- a/src/tools/create_orca_single_sided_whirlpool.ts +++ b/src/tools/create_orca_single_sided_whirlpool.ts @@ -99,7 +99,7 @@ export const FEE_TIERS = { * * @example * ```typescript - * agent: SolanaAgentKitKit } from "your-sdk"; + * import { SolanaAgentKit } from "your-sdk"; * import { PublicKey } from "@solana/web3.js"; * import { BN } from "@coral-xyz/anchor"; * import Decimal from "decimal.js"; diff --git a/src/tools/deploy_collection.ts b/src/tools/deploy_collection.ts index 91e951c..10fef9d 100644 --- a/src/tools/deploy_collection.ts +++ b/src/tools/deploy_collection.ts @@ -18,7 +18,7 @@ import { createUmi } from "@metaplex-foundation/umi-bundle-defaults"; /** * Deploy a new NFT collection - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param options Collection options including name, URI, royalties, and creators * @returns Object containing collection address and metadata */ diff --git a/src/tools/deploy_token.ts b/src/tools/deploy_token.ts index 812d4b4..5b33a12 100644 --- a/src/tools/deploy_token.ts +++ b/src/tools/deploy_token.ts @@ -15,7 +15,7 @@ import { /** * Deploy a new SPL token - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param name Name of the token * @param uri URI for the token metadata * @param symbol Symbol of the token diff --git a/src/tools/get_balance.ts b/src/tools/get_balance.ts index 9e75daf..36cdfef 100644 --- a/src/tools/get_balance.ts +++ b/src/tools/get_balance.ts @@ -3,7 +3,7 @@ import { SolanaAgentKit } from "../index"; /** * Get the balance of SOL or an SPL token for the agent's wallet - * @param agent - SolanaAgent instance + * @param agent - SolanaAgentKit instance * @param token_address - Optional SPL token mint address. If not provided, returns SOL balance * @returns Promise resolving to the balance as a number (in UI units) or null if account doesn't exist */ diff --git a/src/tools/get_primary_domain.ts b/src/tools/get_primary_domain.ts index d54f294..1a2bd8c 100644 --- a/src/tools/get_primary_domain.ts +++ b/src/tools/get_primary_domain.ts @@ -9,7 +9,7 @@ import { SolanaAgentKit } from "../index"; * a specified Solana public key. If the primary domain is stale or an error occurs during * the resolution, it throws an error. * - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param account The Solana public key for which to retrieve the primary domain * @returns A promise that resolves to the primary .sol domain as a string * @throws Error if the domain is stale or if the domain resolution fails diff --git a/src/tools/launch_pumpfun_token.ts b/src/tools/launch_pumpfun_token.ts index 7cb22cf..0c3e6f5 100644 --- a/src/tools/launch_pumpfun_token.ts +++ b/src/tools/launch_pumpfun_token.ts @@ -140,7 +140,7 @@ async function signAndSendTransaction( /** * Launch a token on Pump.fun - * @param agent - SolanaAgent instance + * @param agent - SolanaAgentKit instance * @param tokenName - Name of the token * @param tokenTicker - Ticker of the token * @param description - Description of the token diff --git a/src/tools/lend.ts b/src/tools/lend.ts index 41107cf..732f00c 100644 --- a/src/tools/lend.ts +++ b/src/tools/lend.ts @@ -3,7 +3,7 @@ import { SolanaAgentKit } from "../index"; /** * Lend tokens for yields using Lulo - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param amount Amount of USDC to lend * @returns Transaction signature */ diff --git a/src/tools/mint_nft.ts b/src/tools/mint_nft.ts index 88b37e4..4c25b91 100644 --- a/src/tools/mint_nft.ts +++ b/src/tools/mint_nft.ts @@ -13,7 +13,7 @@ import { MintCollectionNFTResponse } from "../types"; /** * Mint a new NFT as part of an existing collection - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param collectionMint Address of the collection's master NFT * @param metadata NFT metadata object * @param recipient Optional recipient address (defaults to wallet address) diff --git a/src/tools/register_domain.ts b/src/tools/register_domain.ts index 6140ceb..1348001 100644 --- a/src/tools/register_domain.ts +++ b/src/tools/register_domain.ts @@ -6,7 +6,7 @@ import { TOKENS } from "../constants"; /** * Register a .sol domain name using Bonfida Name Service - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param name Domain name to register (without .sol) * @param spaceKB Space allocation in KB (max 10KB) * @returns Transaction signature diff --git a/src/tools/request_faucet_funds.ts b/src/tools/request_faucet_funds.ts index 40e6f09..bde8eed 100644 --- a/src/tools/request_faucet_funds.ts +++ b/src/tools/request_faucet_funds.ts @@ -3,7 +3,7 @@ import { LAMPORTS_PER_SOL } from "@solana/web3.js"; /** * Request SOL from the Solana faucet (devnet/testnet only) - * @param agent - SolanaAgent instance + * @param agent - SolanaAgentKit instance * @returns Transaction signature * @throws Error if the request fails or times out */ diff --git a/src/tools/resolve_sol_domain.ts b/src/tools/resolve_sol_domain.ts index 47a3419..6969a4c 100644 --- a/src/tools/resolve_sol_domain.ts +++ b/src/tools/resolve_sol_domain.ts @@ -9,7 +9,7 @@ import { SolanaAgentKit } from "../index"; * to the corresponding Solana PublicKey. The domain can be provided with or without * the .sol suffix. * - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param domain The .sol domain to resolve. This can be provided with or without the .sol TLD suffix * @returns A promise that resolves to the corresponding Solana PublicKey * @throws Error if the domain resolution fails diff --git a/src/tools/stake_with_jup.ts b/src/tools/stake_with_jup.ts index 5f41788..c05915b 100644 --- a/src/tools/stake_with_jup.ts +++ b/src/tools/stake_with_jup.ts @@ -3,7 +3,7 @@ import { SolanaAgentKit } from "../index"; /** * Stake SOL with Jup validator - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param amount Amount of SOL to stake * @returns Transaction signature */ diff --git a/src/tools/trade.ts b/src/tools/trade.ts index b391df0..b42cc2a 100644 --- a/src/tools/trade.ts +++ b/src/tools/trade.ts @@ -8,7 +8,7 @@ import { TOKENS, DEFAULT_OPTIONS, JUP_API } from "../constants"; /** * Swap tokens using Jupiter Exchange - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param outputMint Target token mint address * @param inputAmount Amount to swap (in token decimals) * @param inputMint Source token mint address (defaults to USDC) diff --git a/src/tools/transfer.ts b/src/tools/transfer.ts index 1f31f50..9e11dd7 100644 --- a/src/tools/transfer.ts +++ b/src/tools/transfer.ts @@ -9,7 +9,7 @@ import { /** * Transfer SOL or SPL tokens to a recipient - * @param agent SolanaAgent instance + * @param agent SolanaAgentKit instance * @param to Recipient's public key * @param amount Amount to transfer * @param mint Optional mint address for SPL tokens diff --git a/src/utils/send_tx.ts b/src/utils/send_tx.ts index bb232c0..593cbc8 100644 --- a/src/utils/send_tx.ts +++ b/src/utils/send_tx.ts @@ -69,7 +69,7 @@ export async function getPriorityFees(connection: Connection): Promise<{ /** * Send a transaction with priority fees - * @param agent - SolanaAgent instance + * @param agent - SolanaAgentKit instance * @param tx - Transaction to send * @returns Transaction ID */