diff --git a/docs/classes/SolanaAgentKit.html b/docs/classes/SolanaAgentKit.html index a4ae6e71..b19a16b1 100644 --- a/docs/classes/SolanaAgentKit.html +++ b/docs/classes/SolanaAgentKit.html @@ -1,7 +1,7 @@ SolanaAgentKit | solana-agent-kit

Class SolanaAgentKit

Main class for interacting with Solana blockchain Provides a unified interface for token operations, NFT management, and trading

SolanaAgentKit

-

Constructors

constructor +

Constructors

constructor

Properties

connection openai_api_key wallet @@ -23,7 +23,7 @@ stake trade transfer -

Constructors

constructor

  • new SolanaAgentKit(private_key, rpc_url?, openai_api_key): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string = "https://api.mainnet-beta.solana.com"
    • openai_api_key: string

    Returns SolanaAgentKit

Properties

connection

connection: Connection

Solana RPC connection

-

openai_api_key

openai_api_key: string

wallet

wallet: Keypair

Wallet keypair for signing transactions

-

wallet_address

wallet_address: PublicKey

Public key of the wallet

-

Methods

deployCollection

deployToken

  • deployToken(name, uri, symbol, decimals?, initialSupply?): Promise<{
        mint: PublicKey;
    }>

  • Parameters

    • name: string
    • uri: string
    • symbol: string
    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
    • OptionalinitialSupply: number

    Returns Promise<{
        mint: PublicKey;
    }>

getBalance

  • getBalance(token_address?): Promise<null | number>

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

getPrimaryDomain

  • getPrimaryDomain(account): Promise<string>

  • Parameters

    • account: PublicKey

    Returns Promise<string>

getTokenDataByAddress

getTokenDataByTicker

getTPS

launchPumpFunToken

  • launchPumpFunToken(tokenName, tokenTicker, description, imageUrl, options?): Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

  • Parameters

    • tokenName: string
    • tokenTicker: string
    • description: string
    • imageUrl: string
    • Optionaloptions: PumpFunTokenOptions

    Returns Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

lendAssets

  • lendAssets(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

mintNFT

  • mintNFT(collectionMint, metadata, recipient?): Promise<MintCollectionNFTResponse>

  • Parameters

    • collectionMint: PublicKey
    • metadata: {
          creators?: {
              address: string;
              share: number;
          }[];
          name: string;
          sellerFeeBasisPoints?: number;
          uri: string;
      }
      • Optionalcreators?: {
            address: string;
            share: number;
        }[]
      • name: string
      • OptionalsellerFeeBasisPoints?: number
      • uri: string
    • Optionalrecipient: PublicKey

    Returns Promise<MintCollectionNFTResponse>

registerDomain

  • registerDomain(name, spaceKB?): Promise<string>

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

  • requestFaucetFunds(): Promise<string>

  • Returns Promise<string>

resolveSolDomain

  • resolveSolDomain(domain): Promise<PublicKey>

  • Parameters

    • domain: string

    Returns Promise<PublicKey>

sendCompressedAirdrop

  • sendCompressedAirdrop(mintAddress, amount, decimals, recipients, priorityFeeInLamports, shouldLog): Promise<string[]>

  • Parameters

    • mintAddress: string
    • amount: number
    • decimals: number
    • recipients: string[]
    • priorityFeeInLamports: number
    • shouldLog: boolean

    Returns Promise<string[]>

stake

  • stake(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

trade

  • trade(outputMint, inputAmount, inputMint?, slippageBps?): Promise<string>

  • Parameters

    • outputMint: PublicKey
    • inputAmount: number
    • OptionalinputMint: PublicKey
    • slippageBps: number = DEFAULT_OPTIONS.SLIPPAGE_BPS

    Returns Promise<string>

transfer

  • transfer(to, amount, mint?): Promise<string>

  • Parameters

    • to: PublicKey
    • amount: number
    • Optionalmint: PublicKey

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Constructors

constructor

  • new SolanaAgentKit(private_key, rpc_url?, openai_api_key): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string = "https://api.mainnet-beta.solana.com"
    • openai_api_key: string

    Returns SolanaAgentKit

Properties

connection

connection: Connection

Solana RPC connection

+

openai_api_key

openai_api_key: string

wallet

wallet: Keypair

Wallet keypair for signing transactions

+

wallet_address

wallet_address: PublicKey

Public key of the wallet

+

Methods

deployCollection

deployToken

  • deployToken(name, uri, symbol, decimals?, initialSupply?): Promise<{
        mint: PublicKey;
    }>

  • Parameters

    • name: string
    • uri: string
    • symbol: string
    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
    • OptionalinitialSupply: number

    Returns Promise<{
        mint: PublicKey;
    }>

getBalance

  • getBalance(token_address?): Promise<null | number>

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

getPrimaryDomain

  • getPrimaryDomain(account): Promise<string>

  • Parameters

    • account: PublicKey

    Returns Promise<string>

getTokenDataByAddress

getTokenDataByTicker

getTPS

launchPumpFunToken

  • launchPumpFunToken(tokenName, tokenTicker, description, imageUrl, options?): Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

  • Parameters

    • tokenName: string
    • tokenTicker: string
    • description: string
    • imageUrl: string
    • Optionaloptions: PumpFunTokenOptions

    Returns Promise<{
        metadataUri: any;
        mint: string;
        signature: string;
    }>

lendAssets

  • lendAssets(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

mintNFT

  • mintNFT(collectionMint, metadata, recipient?): Promise<MintCollectionNFTResponse>

  • Parameters

    • collectionMint: PublicKey
    • metadata: {
          creators?: {
              address: string;
              share: number;
          }[];
          name: string;
          sellerFeeBasisPoints?: number;
          uri: string;
      }
      • Optionalcreators?: {
            address: string;
            share: number;
        }[]
      • name: string
      • OptionalsellerFeeBasisPoints?: number
      • uri: string
    • Optionalrecipient: PublicKey

    Returns Promise<MintCollectionNFTResponse>

registerDomain

  • registerDomain(name, spaceKB?): Promise<string>

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

  • requestFaucetFunds(): Promise<string>

  • Returns Promise<string>

resolveSolDomain

  • resolveSolDomain(domain): Promise<PublicKey>

  • Parameters

    • domain: string

    Returns Promise<PublicKey>

sendCompressedAirdrop

  • sendCompressedAirdrop(mintAddress, amount, decimals, recipients, priorityFeeInLamports, shouldLog): Promise<string[]>

  • Parameters

    • mintAddress: string
    • amount: number
    • decimals: number
    • recipients: string[]
    • priorityFeeInLamports: number
    • shouldLog: boolean

    Returns Promise<string[]>

stake

  • stake(amount): Promise<string>

  • Parameters

    • amount: number

    Returns Promise<string>

trade

  • trade(outputMint, inputAmount, inputMint?, slippageBps?): Promise<string>

  • Parameters

    • outputMint: PublicKey
    • inputAmount: number
    • OptionalinputMint: PublicKey
    • slippageBps: number = DEFAULT_OPTIONS.SLIPPAGE_BPS

    Returns Promise<string>

transfer

  • transfer(to, amount, mint?): Promise<string>

  • Parameters

    • to: PublicKey
    • amount: number
    • Optionalmint: PublicKey

    Returns Promise<string>

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/docs/functions/createSolanaTools.html b/docs/functions/createSolanaTools.html index c2aab1d3..a298f910 100644 --- a/docs/functions/createSolanaTools.html +++ b/docs/functions/createSolanaTools.html @@ -1 +1 @@ -createSolanaTools | solana-agent-kit

Function createSolanaTools

  • createSolanaTools(solanaKit): (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool
        | SolanaCompressedAirdropTool)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool
        | SolanaCompressedAirdropTool)[]

Settings

Member Visibility
+createSolanaTools | solana-agent-kit

Function createSolanaTools

  • createSolanaTools(solanaKit): (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool
        | SolanaCompressedAirdropTool)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaResolveDomainTool
        | SolanaGetDomainTool
        | SolanaGetWalletAddressTool
        | SolanaPumpfunTokenLaunchTool
        | SolanaCreateImageTool
        | SolanaLendAssetTool
        | SolanaTPSCalculatorTool
        | SolanaStakeTool
        | SolanaFetchPriceTool
        | SolanaTokenDataTool
        | SolanaTokenDataByTickerTool
        | SolanaCompressedAirdropTool)[]

Settings

Member Visibility
diff --git a/docs/interfaces/CollectionDeployment.html b/docs/interfaces/CollectionDeployment.html index 0d71e309..f1e8d56b 100644 --- a/docs/interfaces/CollectionDeployment.html +++ b/docs/interfaces/CollectionDeployment.html @@ -1,3 +1,3 @@ -CollectionDeployment | solana-agent-kit

Interface CollectionDeployment

interface CollectionDeployment {
    collectionAddress: PublicKey;
    signature: Uint8Array<ArrayBufferLike>;
}

Properties

collectionAddress +CollectionDeployment | solana-agent-kit

Interface CollectionDeployment

interface CollectionDeployment {
    collectionAddress: PublicKey;
    signature: Uint8Array<ArrayBufferLike>;
}

Properties

collectionAddress signature -

Properties

collectionAddress

collectionAddress: PublicKey

signature

signature: Uint8Array<ArrayBufferLike>

Settings

Member Visibility

On This Page

Properties
+

Properties

collectionAddress

collectionAddress: PublicKey

signature

signature: Uint8Array<ArrayBufferLike>

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/CollectionOptions.html b/docs/interfaces/CollectionOptions.html index 903d39fb..37af4191 100644 --- a/docs/interfaces/CollectionOptions.html +++ b/docs/interfaces/CollectionOptions.html @@ -1,5 +1,5 @@ -CollectionOptions | solana-agent-kit

Interface CollectionOptions

interface CollectionOptions {
    creators?: Creator[];
    name: string;
    royaltyBasisPoints?: number;
    uri: string;
}

Properties

creators? +CollectionOptions | solana-agent-kit

Interface CollectionOptions

interface CollectionOptions {
    creators?: Creator[];
    name: string;
    royaltyBasisPoints?: number;
    uri: string;
}

Properties

creators? name royaltyBasisPoints? uri -

Properties

Optionalcreators

creators?: Creator[]

name

name: string

OptionalroyaltyBasisPoints

royaltyBasisPoints?: number

uri

uri: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalcreators

creators?: Creator[]

name

name: string

OptionalroyaltyBasisPoints

royaltyBasisPoints?: number

uri

uri: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/Creator.html b/docs/interfaces/Creator.html index 34aa17cd..e9bed73b 100644 --- a/docs/interfaces/Creator.html +++ b/docs/interfaces/Creator.html @@ -1,3 +1,3 @@ -Creator | solana-agent-kit

Interface Creator

interface Creator {
    address: string;
    percentage: number;
}

Properties

address +Creator | solana-agent-kit

Interface Creator

interface Creator {
    address: string;
    percentage: number;
}

Properties

address percentage -

Properties

address

address: string

percentage

percentage: number

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: string

percentage

percentage: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/FetchPriceResponse.html b/docs/interfaces/FetchPriceResponse.html index e48f8af2..8deda05e 100644 --- a/docs/interfaces/FetchPriceResponse.html +++ b/docs/interfaces/FetchPriceResponse.html @@ -1,6 +1,6 @@ -FetchPriceResponse | solana-agent-kit

Interface FetchPriceResponse

interface FetchPriceResponse {
    code?: string;
    message?: string;
    priceInUSDC?: string;
    status: "success" | "error";
    tokenId?: string;
}

Properties

code? +FetchPriceResponse | solana-agent-kit

Interface FetchPriceResponse

interface FetchPriceResponse {
    code?: string;
    message?: string;
    priceInUSDC?: string;
    status: "success" | "error";
    tokenId?: string;
}

Properties

code? message? priceInUSDC? status tokenId? -

Properties

Optionalcode

code?: string

Optionalmessage

message?: string

OptionalpriceInUSDC

priceInUSDC?: string

status

status: "success" | "error"

OptionaltokenId

tokenId?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalcode

code?: string

Optionalmessage

message?: string

OptionalpriceInUSDC

priceInUSDC?: string

status

status: "success" | "error"

OptionaltokenId

tokenId?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/JupiterTokenData.html b/docs/interfaces/JupiterTokenData.html index 180f3f43..48a70a02 100644 --- a/docs/interfaces/JupiterTokenData.html +++ b/docs/interfaces/JupiterTokenData.html @@ -1,4 +1,4 @@ -JupiterTokenData | solana-agent-kit

Interface JupiterTokenData

interface JupiterTokenData {
    address: string;
    daily_volume: number;
    decimals: number;
    extensions: {
        coingeckoId?: string;
    };
    freeze_authority: null | string;
    logoURI: string;
    mint_authority: null | string;
    name: string;
    permanent_delegate: null | string;
    symbol: string;
    tags: string[];
}

Properties

address +JupiterTokenData | solana-agent-kit

Interface JupiterTokenData

interface JupiterTokenData {
    address: string;
    daily_volume: number;
    decimals: number;
    extensions: {
        coingeckoId?: string;
    };
    freeze_authority: null | string;
    logoURI: string;
    mint_authority: null | string;
    name: string;
    permanent_delegate: null | string;
    symbol: string;
    tags: string[];
}

Properties

address daily_volume decimals extensions @@ -9,4 +9,4 @@ permanent_delegate symbol tags -

Properties

address

address: string

daily_volume

daily_volume: number

decimals

decimals: number

extensions

extensions: {
    coingeckoId?: string;
}

freeze_authority

freeze_authority: null | string

logoURI

logoURI: string

mint_authority

mint_authority: null | string

name

name: string

permanent_delegate

permanent_delegate: null | string

symbol

symbol: string

tags

tags: string[]

Settings

Member Visibility

On This Page

Properties
+

Properties

address

address: string

daily_volume

daily_volume: number

decimals

decimals: number

extensions

extensions: {
    coingeckoId?: string;
}

freeze_authority

freeze_authority: null | string

logoURI

logoURI: string

mint_authority

mint_authority: null | string

name

name: string

permanent_delegate

permanent_delegate: null | string

symbol

symbol: string

tags

tags: string[]

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/LuloAccountDetailsResponse.html b/docs/interfaces/LuloAccountDetailsResponse.html index d5d3038d..fbbd7961 100644 --- a/docs/interfaces/LuloAccountDetailsResponse.html +++ b/docs/interfaces/LuloAccountDetailsResponse.html @@ -1,6 +1,6 @@ LuloAccountDetailsResponse | solana-agent-kit

Interface LuloAccountDetailsResponse

Lulo Account Details response format

-
interface LuloAccountDetailsResponse {
    interestEarned: number;
    realtimeApy: number;
    settings: {
        allowedProtocols: null | string;
        homebase: null | string;
        minimumRate: string;
        owner: string;
    };
    totalValue: number;
}

Properties

interestEarned +
interface LuloAccountDetailsResponse {
    interestEarned: number;
    realtimeApy: number;
    settings: {
        allowedProtocols: null | string;
        homebase: null | string;
        minimumRate: string;
        owner: string;
    };
    totalValue: number;
}

Properties

interestEarned realtimeApy settings totalValue -

Properties

interestEarned

interestEarned: number

realtimeApy

realtimeApy: number

settings

settings: {
    allowedProtocols: null | string;
    homebase: null | string;
    minimumRate: string;
    owner: string;
}

totalValue

totalValue: number

Settings

Member Visibility

On This Page

Properties
+

Properties

interestEarned

interestEarned: number

realtimeApy

realtimeApy: number

settings

settings: {
    allowedProtocols: null | string;
    homebase: null | string;
    minimumRate: string;
    owner: string;
}

totalValue

totalValue: number

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/MintCollectionNFTResponse.html b/docs/interfaces/MintCollectionNFTResponse.html index 735a455b..340e4478 100644 --- a/docs/interfaces/MintCollectionNFTResponse.html +++ b/docs/interfaces/MintCollectionNFTResponse.html @@ -1,3 +1,3 @@ -MintCollectionNFTResponse | solana-agent-kit

Interface MintCollectionNFTResponse

interface MintCollectionNFTResponse {
    metadata: PublicKey;
    mint: PublicKey;
}

Properties

metadata +MintCollectionNFTResponse | solana-agent-kit

Interface MintCollectionNFTResponse

interface MintCollectionNFTResponse {
    metadata: PublicKey;
    mint: PublicKey;
}

Properties

metadata mint -

Properties

metadata

metadata: PublicKey

mint

mint: PublicKey

Settings

Member Visibility

On This Page

Properties
+

Properties

metadata

metadata: PublicKey

mint

mint: PublicKey

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PumpFunTokenOptions.html b/docs/interfaces/PumpFunTokenOptions.html index 69c03879..4a914f55 100644 --- a/docs/interfaces/PumpFunTokenOptions.html +++ b/docs/interfaces/PumpFunTokenOptions.html @@ -1,7 +1,7 @@ -PumpFunTokenOptions | solana-agent-kit

Interface PumpFunTokenOptions

interface PumpFunTokenOptions {
    initialLiquiditySOL?: number;
    priorityFee?: number;
    slippageBps?: number;
    telegram?: string;
    twitter?: string;
    website?: string;
}

Properties

initialLiquiditySOL? +PumpFunTokenOptions | solana-agent-kit

Interface PumpFunTokenOptions

interface PumpFunTokenOptions {
    initialLiquiditySOL?: number;
    priorityFee?: number;
    slippageBps?: number;
    telegram?: string;
    twitter?: string;
    website?: string;
}

Properties

initialLiquiditySOL? priorityFee? slippageBps? telegram? twitter? website? -

Properties

OptionalinitialLiquiditySOL

initialLiquiditySOL?: number

OptionalpriorityFee

priorityFee?: number

OptionalslippageBps

slippageBps?: number

Optionaltelegram

telegram?: string

Optionaltwitter

twitter?: string

Optionalwebsite

website?: string

Settings

Member Visibility

On This Page

Properties
+

Properties

OptionalinitialLiquiditySOL

initialLiquiditySOL?: number

OptionalpriorityFee

priorityFee?: number

OptionalslippageBps

slippageBps?: number

Optionaltelegram

telegram?: string

Optionaltwitter

twitter?: string

Optionalwebsite

website?: string

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/interfaces/PumpfunLaunchResponse.html b/docs/interfaces/PumpfunLaunchResponse.html index 0e86c5bc..f8db0072 100644 --- a/docs/interfaces/PumpfunLaunchResponse.html +++ b/docs/interfaces/PumpfunLaunchResponse.html @@ -1,5 +1,5 @@ -PumpfunLaunchResponse | solana-agent-kit

Interface PumpfunLaunchResponse

interface PumpfunLaunchResponse {
    error?: string;
    metadataUri?: string;
    mint: string;
    signature: string;
}

Properties

error? +PumpfunLaunchResponse | solana-agent-kit

Interface PumpfunLaunchResponse

interface PumpfunLaunchResponse {
    error?: string;
    metadataUri?: string;
    mint: string;
    signature: string;
}

Properties

error? metadataUri? mint signature -

Properties

Optionalerror

error?: string

OptionalmetadataUri

metadataUri?: string

mint

mint: string

signature

signature: string

Settings

Member Visibility

On This Page

Properties
+

Properties

Optionalerror

error?: string

OptionalmetadataUri

metadataUri?: string

mint

mint: string

signature

signature: string

Settings

Member Visibility

On This Page

Properties