diff --git a/docs/classes/SolanaAgentKit.html b/docs/classes/SolanaAgentKit.html index b197b99..313b7e5 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, trading and more

SolanaAgentKit

-

Constructors

constructor +

Constructors

constructor

Properties

config connection wallet @@ -67,14 +67,14 @@ Please use the new constructor with Config object instead:

Example

const agent = new SolanaAgentKit(privateKey, rpcUrl, {
  OPENAI_API_KEY: 'your-key'
});
-
  • new SolanaAgentKit(
        private_key: string,
        rpc_url: string,
        config: Config,
    ): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string
    • config: Config

    Returns SolanaAgentKit

    • Properties

    config

    config: Config

    Configuration object

    -

    connection

    connection: Connection

    Solana RPC connection

    -

    wallet

    wallet: Keypair

    Wallet keypair for signing transactions

    -

    wallet_address

    wallet_address: PublicKey

    Public key of the wallet

    -

    Methods

    batchOrder

    cancelAllOrders

    • cancelAllOrders(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    closePerpTradeLong

    • closePerpTradeLong(
          args: Omit<
              { agent: SolanaAgentKit; price: number; tradeMint: PublicKey },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<{ agent: SolanaAgentKit; price: number; tradeMint: PublicKey }, "agent">

      Returns Promise<string>

    closePerpTradeShort

    • closePerpTradeShort(
          args: Omit<
              { agent: SolanaAgentKit; price: number; tradeMint: PublicKey },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<{ agent: SolanaAgentKit; price: number; tradeMint: PublicKey }, "agent">

      Returns Promise<string>

    createGibworkTask

    • createGibworkTask(
          title: string,
          content: string,
          requirements: string,
          tags: string[],
          tokenMintAddress: string,
          tokenAmount: number,
          payer?: string,
      ): Promise<GibworkCreateTaskReponse>

    • Parameters

      • title: string
      • content: string
      • requirements: string
      • tags: string[]
      • tokenMintAddress: string
      • tokenAmount: number
      • Optionalpayer: string

      Returns Promise<GibworkCreateTaskReponse>

    createTiplink

    • createTiplink(
          amount: number,
          splmintAddress?: PublicKey,
      ): Promise<{ signature: string; url: string }>

    • Parameters

      • amount: number
      • OptionalsplmintAddress: PublicKey

      Returns Promise<{ signature: string; url: string }>

    deployCollection

    deployToken

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

    • Parameters

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

      Returns Promise<{ mint: PublicKey }>

    fetchTokenDetailedReport

    fetchTokenPrice

    • fetchTokenPrice(mint: string): Promise<string>

    • Parameters

      • mint: string

      Returns Promise<string>

    fetchTokenReportSummary

    flashCloseTrade

    • flashCloseTrade(params: FlashCloseTradeParams): Promise<string>

    • Closes an existing trading position on Flash.Trade

      +
  • new SolanaAgentKit(
        private_key: string,
        rpc_url: string,
        config: Config,
    ): SolanaAgentKit

  • Parameters

    • private_key: string
    • rpc_url: string
    • config: Config

    Returns SolanaAgentKit

    • Properties

    config

    config: Config

    Configuration object

    +

    connection

    connection: Connection

    Solana RPC connection

    +

    wallet

    wallet: Keypair

    Wallet keypair for signing transactions

    +

    wallet_address

    wallet_address: PublicKey

    Public key of the wallet

    +

    Methods

    batchOrder

    cancelAllOrders

    • cancelAllOrders(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    closePerpTradeLong

    • closePerpTradeLong(
          args: Omit<
              { agent: SolanaAgentKit; price: number; tradeMint: PublicKey },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<{ agent: SolanaAgentKit; price: number; tradeMint: PublicKey }, "agent">

      Returns Promise<string>

    closePerpTradeShort

    • closePerpTradeShort(
          args: Omit<
              { agent: SolanaAgentKit; price: number; tradeMint: PublicKey },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<{ agent: SolanaAgentKit; price: number; tradeMint: PublicKey }, "agent">

      Returns Promise<string>

    createGibworkTask

    • createGibworkTask(
          title: string,
          content: string,
          requirements: string,
          tags: string[],
          tokenMintAddress: string,
          tokenAmount: number,
          payer?: string,
      ): Promise<GibworkCreateTaskReponse>

    • Parameters

      • title: string
      • content: string
      • requirements: string
      • tags: string[]
      • tokenMintAddress: string
      • tokenAmount: number
      • Optionalpayer: string

      Returns Promise<GibworkCreateTaskReponse>

    createTiplink

    • createTiplink(
          amount: number,
          splmintAddress?: PublicKey,
      ): Promise<{ signature: string; url: string }>

    • Parameters

      • amount: number
      • OptionalsplmintAddress: PublicKey

      Returns Promise<{ signature: string; url: string }>

    deployCollection

    deployToken

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

    • Parameters

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

      Returns Promise<{ mint: PublicKey }>

    fetchTokenDetailedReport

    fetchTokenPrice

    • fetchTokenPrice(mint: string): Promise<string>

    • Parameters

      • mint: string

      Returns Promise<string>

    fetchTokenReportSummary

    flashCloseTrade

    • flashCloseTrade(params: FlashCloseTradeParams): Promise<string>

    • Closes an existing trading position on Flash.Trade

      Parameters

      • params: FlashCloseTradeParams

        Flash trade close parameters

      Returns Promise<string>

      Transaction signature

      -

    flashOpenTrade

    • flashOpenTrade(params: FlashTradeParams): Promise<string>

    • Opens a new trading position on Flash.Trade

      +

    flashOpenTrade

    • flashOpenTrade(params: FlashTradeParams): Promise<string>

    • Opens a new trading position on Flash.Trade

      Parameters

      • params: FlashTradeParams

        Flash trade parameters including market, side, collateral, leverage, and pool name

      Returns Promise<string>

      Transaction signature

      -

    getAllDomainsTLDs

    • getAllDomainsTLDs(): Promise<string[]>

    • Returns Promise<string[]>

    getAllRegisteredAllDomains

    • getAllRegisteredAllDomains(): Promise<string[]>

    • Returns Promise<string[]>

    getBalance

    • getBalance(token_address?: PublicKey): Promise<number>

    • Parameters

      • Optionaltoken_address: PublicKey

      Returns Promise<number>

    getBalanceOther

    • getBalanceOther(
          walletAddress: PublicKey,
          tokenAddress?: PublicKey,
      ): Promise<number>

    • Parameters

      • walletAddress: PublicKey
      • OptionaltokenAddress: PublicKey

      Returns Promise<number>

    getMainAllDomainsDomain

    • getMainAllDomainsDomain(owner: PublicKey): Promise<null | string>

    • Parameters

      • owner: PublicKey

      Returns Promise<null | string>

    getOwnedAllDomains

    • getOwnedAllDomains(owner: PublicKey): Promise<string[]>

    • Parameters

      • owner: PublicKey

      Returns Promise<string[]>

    getOwnedDomainsForTLD

    • getOwnedDomainsForTLD(tld: string): Promise<string[]>

    • Parameters

      • tld: string

      Returns Promise<string[]>

    getPrimaryDomain

    • getPrimaryDomain(account: PublicKey): Promise<string>

    • Parameters

      • account: PublicKey

      Returns Promise<string>

    getPythPrice

    • getPythPrice(priceFeedID: string): Promise<string>

    • Parameters

      • priceFeedID: string

      Returns Promise<string>

    getPythPriceFeedID

    • getPythPriceFeedID(tokenSymbol: string): Promise<string>

    • Parameters

      • tokenSymbol: string

      Returns Promise<string>

    getTokenDataByAddress

    getTokenDataByTicker

    getTPS

    launchPumpFunToken

    lendAssets

    • lendAssets(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    limitOrder

    • limitOrder(
          marketId: PublicKey,
          quantity: number,
          side: string,
          price: number,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • quantity: number
      • side: string
      • price: number

      Returns Promise<string>

    manifestCreateMarket

    • manifestCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey

      Returns Promise<string[]>

    mintNFT

    • mintNFT(
          collectionMint: PublicKey,
          metadata: {
              creators?: { address: string; share: number }[];
              name: string;
              sellerFeeBasisPoints?: number;
              uri: string;
          },
          recipient?: PublicKey,
      ): Promise<MintCollectionNFTResponse>

    • Parameters

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

      Returns Promise<MintCollectionNFTResponse>

    openbookCreateMarket

    • openbookCreateMarket(
          baseMint: PublicKey,
          quoteMint: PublicKey,
          lotSize?: number,
          tickSize?: number,
      ): Promise<string[]>

    • Parameters

      • baseMint: PublicKey
      • quoteMint: PublicKey
      • lotSize: number = 1
      • tickSize: number = 0.01

      Returns Promise<string[]>

    openPerpTradeLong

    • openPerpTradeLong(
          args: Omit<
              {
                  agent: SolanaAgentKit;
                  collateralAmount: number;
                  collateralMint?: PublicKey;
                  leverage?: number;
                  price: number;
                  slippage?: number;
                  tradeMint?: PublicKey;
              },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<
            {
                agent: SolanaAgentKit;
                collateralAmount: number;
                collateralMint?: PublicKey;
                leverage?: number;
                price: number;
                slippage?: number;
                tradeMint?: PublicKey;
            },
            "agent",
        >

      Returns Promise<string>

    openPerpTradeShort

    • openPerpTradeShort(
          args: Omit<
              {
                  agent: SolanaAgentKit;
                  collateralAmount: number;
                  collateralMint?: PublicKey;
                  leverage?: number;
                  price: number;
                  slippage?: number;
                  tradeMint?: PublicKey;
              },
              "agent",
          >,
      ): Promise<string>

    • Parameters

      • args: Omit<
            {
                agent: SolanaAgentKit;
                collateralAmount: number;
                collateralMint?: PublicKey;
                leverage?: number;
                price: number;
                slippage?: number;
                tradeMint?: PublicKey;
            },
            "agent",
        >

      Returns Promise<string>

    orcaClosePosition

    • orcaClosePosition(positionMintAddress: PublicKey): Promise<string>

    • Parameters

      • positionMintAddress: PublicKey

      Returns Promise<string>

    orcaCreateCLMM

    • orcaCreateCLMM(
          mintDeploy: PublicKey,
          mintPair: PublicKey,
          initialPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • mintDeploy: PublicKey
      • mintPair: PublicKey
      • initialPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaCreateSingleSidedLiquidityPool

    • orcaCreateSingleSidedLiquidityPool(
          depositTokenAmount: number,
          depositTokenMint: PublicKey,
          otherTokenMint: PublicKey,
          initialPrice: Decimal,
          maxPrice: Decimal,
          feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200,
      ): Promise<string>

    • Parameters

      • depositTokenAmount: number
      • depositTokenMint: PublicKey
      • otherTokenMint: PublicKey
      • initialPrice: Decimal
      • maxPrice: Decimal
      • feeTier: 1 | 2 | 4 | 5 | 16 | 30 | 65 | 100 | 200

      Returns Promise<string>

    orcaFetchPositions

    orcaOpenCenteredPositionWithLiquidity

    • orcaOpenCenteredPositionWithLiquidity(
          whirlpoolAddress: PublicKey,
          priceOffsetBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • priceOffsetBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    orcaOpenSingleSidedPosition

    • orcaOpenSingleSidedPosition(
          whirlpoolAddress: PublicKey,
          distanceFromCurrentPriceBps: number,
          widthBps: number,
          inputTokenMint: PublicKey,
          inputAmount: Decimal,
      ): Promise<string>

    • Parameters

      • whirlpoolAddress: PublicKey
      • distanceFromCurrentPriceBps: number
      • widthBps: number
      • inputTokenMint: PublicKey
      • inputAmount: Decimal

      Returns Promise<string>

    raydiumCreateAmmV4

    • raydiumCreateAmmV4(
          marketId: PublicKey,
          baseAmount: BN,
          quoteAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • marketId: PublicKey
      • baseAmount: BN
      • quoteAmount: BN
      • startTime: BN

      Returns Promise<string>

    raydiumCreateClmm

    • raydiumCreateClmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          initialPrice: Decimal,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • initialPrice: Decimal
      • startTime: BN

      Returns Promise<string>

    raydiumCreateCpmm

    • raydiumCreateCpmm(
          mint1: PublicKey,
          mint2: PublicKey,
          configId: PublicKey,
          mintAAmount: BN,
          mintBAmount: BN,
          startTime: BN,
      ): Promise<string>

    • Parameters

      • mint1: PublicKey
      • mint2: PublicKey
      • configId: PublicKey
      • mintAAmount: BN
      • mintBAmount: BN
      • startTime: BN

      Returns Promise<string>

    registerDomain

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

    • Parameters

      • name: string
      • OptionalspaceKB: number

      Returns Promise<string>

    requestFaucetFunds

    resolveAllDomains

    • resolveAllDomains(domain: string): Promise<undefined | PublicKey>

    • Parameters

      • domain: string

      Returns Promise<undefined | PublicKey>

    resolveSolDomain

    • resolveSolDomain(domain: string): Promise<PublicKey>

    • Parameters

      • domain: string

      Returns Promise<PublicKey>

    restake

    • restake(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    rockPaperScissors

    • rockPaperScissors(
          amount: number,
          choice: "rock" | "paper" | "scissors",
      ): Promise<string>

    • Parameters

      • amount: number
      • choice: "rock" | "paper" | "scissors"

      Returns Promise<string>

    sendCompressedAirdrop

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

    • Parameters

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

      Returns Promise<string[]>

    stake

    • stake(amount: number): Promise<string>

    • Parameters

      • amount: number

      Returns Promise<string>

    tensorCancelListing

    • tensorCancelListing(nftMint: PublicKey): Promise<string>

    • Parameters

      • nftMint: PublicKey

      Returns Promise<string>

    tensorListNFT

    • tensorListNFT(nftMint: PublicKey, price: number): Promise<string>

    • Parameters

      • nftMint: PublicKey
      • price: number

      Returns Promise<string>

    trade

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

    • Parameters

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

      Returns Promise<string>

    transfer

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

    • Parameters

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

      Returns Promise<string>

    withdrawAll

    • withdrawAll(marketId: PublicKey): Promise<string>

    • Parameters

      • marketId: PublicKey

      Returns Promise<string>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    batchOrdercancelAllOrdersclosePerpTradeLongclosePerpTradeShortcreateGibworkTaskcreateTiplinkdeployCollectiondeployTokenfetchTokenDetailedReportfetchTokenPricefetchTokenReportSummaryflashCloseTradeflashOpenTradegetAllDomainsTLDsgetAllRegisteredAllDomainsgetBalancegetBalanceOthergetMainAllDomainsDomaingetOwnedAllDomainsgetOwnedDomainsForTLDgetPrimaryDomaingetPythPricegetPythPriceFeedIDgetTokenDataByAddressgetTokenDataByTickergetTPSlaunchPumpFunTokenlendAssetslimitOrdermanifestCreateMarketmintNFTopenbookCreateMarketopenPerpTradeLongopenPerpTradeShortorcaClosePositionorcaCreateCLMMorcaCreateSingleSidedLiquidityPoolorcaFetchPositionsorcaOpenCenteredPositionWithLiquidityorcaOpenSingleSidedPositionraydiumCreateAmmV4raydiumCreateClmmraydiumCreateCpmmregisterDomainrequestFaucetFundsresolveAllDomainsresolveSolDomainrestakerockPaperScissorssendCompressedAirdropstaketensorCancelListingtensorListNFTtradetransferwithdrawAll
    +

    getAllDomainsTLDs

    getAllRegisteredAllDomains

    getBalance

    getBalanceOther

    getMainAllDomainsDomain

    getOwnedAllDomains

    getOwnedDomainsForTLD

    getPrimaryDomain

    getPythPrice

    getPythPriceFeedID

    getTokenDataByAddress

    getTokenDataByTicker

    getTPS

    launchPumpFunToken

    lendAssets

    limitOrder

    manifestCreateMarket

    mintNFT

    openbookCreateMarket

    openPerpTradeLong

    openPerpTradeShort

    orcaClosePosition

    orcaCreateCLMM

    orcaCreateSingleSidedLiquidityPool

    orcaFetchPositions

    orcaOpenCenteredPositionWithLiquidity

    orcaOpenSingleSidedPosition

    raydiumCreateAmmV4

    raydiumCreateClmm

    raydiumCreateCpmm

    registerDomain

    requestFaucetFunds

    resolveAllDomains

    resolveSolDomain

    restake

    rockPaperScissors

    sendCompressedAirdrop

    stake

    tensorCancelListing

    tensorListNFT

    trade

    transfer

    withdrawAll

    Settings

    Member Visibility

    On This Page

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

    Function createSolanaTools

    • createSolanaTools(
          solanaKit: SolanaAgentKit,
      ): (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaPerpCloseTradeTool
          | SolanaPerpOpenTradeTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaBatchOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaFlashOpenTrade
          | SolanaFlashCloseTrade
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaRestakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
          | SolanaFetchTokenReportSummaryTool
          | SolanaFetchTokenDetailedReportTool
      )[]

    • Parameters

      Returns (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaPerpCloseTradeTool
          | SolanaPerpOpenTradeTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaBatchOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaFlashOpenTrade
          | SolanaFlashCloseTrade
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaRestakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
          | SolanaFetchTokenReportSummaryTool
          | SolanaFetchTokenDetailedReportTool
      )[]

    Settings

    Member Visibility
    +createSolanaTools | solana-agent-kit

    Function createSolanaTools

    • createSolanaTools(
          solanaKit: SolanaAgentKit,
      ): (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaPerpCloseTradeTool
          | SolanaPerpOpenTradeTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaBatchOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaFlashOpenTrade
          | SolanaFlashCloseTrade
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaRestakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
          | SolanaFetchTokenReportSummaryTool
          | SolanaFetchTokenDetailedReportTool
      )[]

    • Parameters

      Returns (
          | SolanaBalanceTool
          | SolanaBalanceOtherTool
          | SolanaTransferTool
          | SolanaDeployTokenTool
          | SolanaDeployCollectionTool
          | SolanaMintNFTTool
          | SolanaPerpCloseTradeTool
          | SolanaPerpOpenTradeTool
          | SolanaTradeTool
          | SolanaLimitOrderTool
          | SolanaBatchOrderTool
          | SolanaCancelAllOrdersTool
          | SolanaWithdrawAllTool
          | SolanaRequestFundsTool
          | SolanaRegisterDomainTool
          | SolanaResolveDomainTool
          | SolanaGetDomainTool
          | SolanaGetWalletAddressTool
          | SolanaFlashOpenTrade
          | SolanaFlashCloseTrade
          | SolanaPumpfunTokenLaunchTool
          | SolanaCreateImageTool
          | SolanaLendAssetTool
          | SolanaTPSCalculatorTool
          | SolanaStakeTool
          | SolanaRestakeTool
          | SolanaFetchPriceTool
          | SolanaTokenDataTool
          | SolanaTokenDataByTickerTool
          | SolanaCompressedAirdropTool
          | SolanaClosePosition
          | SolanaOrcaCreateCLMM
          | SolanaOrcaCreateSingleSideLiquidityPool
          | SolanaOrcaFetchPositions
          | SolanaOrcaOpenCenteredPosition
          | SolanaOrcaOpenSingleSidedPosition
          | SolanaRaydiumCreateAmmV4
          | SolanaRaydiumCreateClmm
          | SolanaRaydiumCreateCpmm
          | SolanaOpenbookCreateMarket
          | SolanaManifestCreateMarket
          | SolanaPythFetchPrice
          | SolanaResolveAllDomainsTool
          | SolanaGetOwnedDomains
          | SolanaGetOwnedTldDomains
          | SolanaGetAllTlds
          | SolanaGetMainDomain
          | SolanaCreateGibworkTask
          | SolanaRockPaperScissorsTool
          | SolanaTipLinkTool
          | SolanaListNFTForSaleTool
          | SolanaCancelNFTListingTool
          | SolanaFetchTokenReportSummaryTool
          | SolanaFetchTokenDetailedReportTool
      )[]

    Settings

    Member Visibility
    diff --git a/docs/functions/createVercelAITools.html b/docs/functions/createVercelAITools.html index 52ea314..4c35c1c 100644 --- a/docs/functions/createVercelAITools.html +++ b/docs/functions/createVercelAITools.html @@ -1 +1 @@ -createVercelAITools | solana-agent-kit

    Function createVercelAITools

    Settings

    Member Visibility
    +createVercelAITools | solana-agent-kit

    Function createVercelAITools

    Settings

    Member Visibility
    diff --git a/docs/functions/executeAction.html b/docs/functions/executeAction.html index 1667fa0..59e086c 100644 --- a/docs/functions/executeAction.html +++ b/docs/functions/executeAction.html @@ -1,2 +1,2 @@ executeAction | solana-agent-kit

    Function executeAction

    • executeAction(
          action: Action,
          agent: SolanaAgentKit,
          input: Record<string, any>,
      ): Promise<Record<string, any>>

    • Execute an action with the given input

      -

      Parameters

      Returns Promise<Record<string, any>>

    Settings

    Member Visibility
    +

    Parameters

    Returns Promise<Record<string, any>>

    Settings

    Member Visibility
    diff --git a/docs/functions/findAction.html b/docs/functions/findAction.html index 90b280e..9797012 100644 --- a/docs/functions/findAction.html +++ b/docs/functions/findAction.html @@ -1,2 +1,2 @@ findAction | solana-agent-kit

    Function findAction

    • findAction(query: string): Action | undefined

    • Find an action by its name or one of its similes

      -

      Parameters

      • query: string

      Returns Action | undefined

    Settings

    Member Visibility
    +

    Parameters

    Returns Action | undefined

    Settings

    Member Visibility
    diff --git a/docs/functions/getActionExamples.html b/docs/functions/getActionExamples.html index d8b9d1c..46d7eec 100644 --- a/docs/functions/getActionExamples.html +++ b/docs/functions/getActionExamples.html @@ -1,2 +1,2 @@ getActionExamples | solana-agent-kit

    Function getActionExamples

    • getActionExamples(action: Action): string

    • Get examples for an action

      -

      Parameters

      • action: Action

      Returns string

    Settings

    Member Visibility
    +

    Parameters

    Returns string

    Settings

    Member Visibility
    diff --git a/docs/interfaces/Action.html b/docs/interfaces/Action.html index 2acfea9..aeb60a1 100644 --- a/docs/interfaces/Action.html +++ b/docs/interfaces/Action.html @@ -1,16 +1,16 @@ Action | solana-agent-kit

    Interface Action

    Main Action interface inspired by ELIZA This interface makes it easier to implement actions across different frameworks

    -
    interface Action {
        description: string;
        examples: ActionExample[][];
        handler: Handler;
        name: string;
        schema: ZodType;
        similes: string[];
    }

    Properties

    description +
    interface Action {
        description: string;
        examples: ActionExample[][];
        handler: Handler;
        name: string;
        schema: ZodType;
        similes: string[];
    }

    Properties

    description examples handler name schema similes

    Properties

    description

    description: string

    Detailed description of what the action does

    -

    examples

    examples: ActionExample[][]

    Array of example inputs and outputs for the action +

    examples

    examples: ActionExample[][]

    Array of example inputs and outputs for the action Each inner array represents a group of related examples

    -

    handler

    handler: Handler

    Function that executes the action

    -

    name

    name: string

    Unique name of the action

    -

    schema

    schema: ZodType

    Zod schema for input validation

    -

    similes

    similes: string[]

    Alternative names/phrases that can trigger this action

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    handler

    handler: Handler

    Function that executes the action

    +

    name

    name: string

    Unique name of the action

    +

    schema

    schema: ZodType

    Zod schema for input validation

    +

    similes

    similes: string[]

    Alternative names/phrases that can trigger this action

    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/ActionExample.html b/docs/interfaces/ActionExample.html index de5901b..f3bf81b 100644 --- a/docs/interfaces/ActionExample.html +++ b/docs/interfaces/ActionExample.html @@ -1,5 +1,5 @@ ActionExample | solana-agent-kit

    Interface ActionExample

    Example of an action with input and output

    -
    interface ActionExample {
        explanation: string;
        input: Record<string, any>;
        output: Record<string, any>;
    }

    Properties

    explanation +
    interface ActionExample {
        explanation: string;
        input: Record<string, any>;
        output: Record<string, any>;
    }

    Properties

    explanation input output -

    Properties

    explanation

    explanation: string

    input

    input: Record<string, any>

    output

    output: Record<string, any>

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    explanation

    explanation: string

    input

    input: Record<string, any>

    output

    output: Record<string, any>

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/BatchOrderPattern.html b/docs/interfaces/BatchOrderPattern.html index e878ad4..946021a 100644 --- a/docs/interfaces/BatchOrderPattern.html +++ b/docs/interfaces/BatchOrderPattern.html @@ -1,7 +1,7 @@ -BatchOrderPattern | solana-agent-kit

    Interface BatchOrderPattern

    interface BatchOrderPattern {
        individualQuantity?: number;
        numberOfOrders?: number;
        priceRange?: { max?: number; min?: number };
        side: string;
        spacing?: { type: "percentage" | "fixed"; value: number };
        totalQuantity?: number;
    }

    Properties

    individualQuantity? +BatchOrderPattern | solana-agent-kit

    Interface BatchOrderPattern

    interface BatchOrderPattern {
        individualQuantity?: number;
        numberOfOrders?: number;
        priceRange?: { max?: number; min?: number };
        side: string;
        spacing?: { type: "percentage" | "fixed"; value: number };
        totalQuantity?: number;
    }

    Properties

    individualQuantity? numberOfOrders? priceRange? side spacing? totalQuantity? -

    Properties

    OptionalindividualQuantity

    individualQuantity?: number

    OptionalnumberOfOrders

    numberOfOrders?: number

    OptionalpriceRange

    priceRange?: { max?: number; min?: number }

    side

    side: string

    Optionalspacing

    spacing?: { type: "percentage" | "fixed"; value: number }

    OptionaltotalQuantity

    totalQuantity?: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalindividualQuantity

    individualQuantity?: number

    OptionalnumberOfOrders

    numberOfOrders?: number

    OptionalpriceRange

    priceRange?: { max?: number; min?: number }

    side

    side: string

    Optionalspacing

    spacing?: { type: "percentage" | "fixed"; value: number }

    OptionaltotalQuantity

    totalQuantity?: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/CollectionDeployment.html b/docs/interfaces/CollectionDeployment.html index aad01cf..a392a7d 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;
    }

    Properties

    collectionAddress +CollectionDeployment | solana-agent-kit

    Interface CollectionDeployment

    interface CollectionDeployment {
        collectionAddress: PublicKey;
        signature: Uint8Array;
    }

    Properties

    collectionAddress signature -

    Properties

    collectionAddress

    collectionAddress: PublicKey

    signature

    signature: Uint8Array

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    collectionAddress

    collectionAddress: PublicKey

    signature

    signature: Uint8Array

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/CollectionOptions.html b/docs/interfaces/CollectionOptions.html index 691cad1..4cb12ab 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/Config.html b/docs/interfaces/Config.html index de0cf1d..ba902c0 100644 --- a/docs/interfaces/Config.html +++ b/docs/interfaces/Config.html @@ -1,4 +1,4 @@ -Config | solana-agent-kit

    Interface Config

    interface Config {
        JUPITER_FEE_BPS?: number;
        JUPITER_REFERRAL_ACCOUNT?: string;
        OPENAI_API_KEY?: string;
    }

    Properties

    JUPITER_FEE_BPS? +Config | solana-agent-kit

    Interface Config

    interface Config {
        JUPITER_FEE_BPS?: number;
        JUPITER_REFERRAL_ACCOUNT?: string;
        OPENAI_API_KEY?: string;
    }

    Properties

    JUPITER_FEE_BPS? JUPITER_REFERRAL_ACCOUNT? OPENAI_API_KEY? -

    Properties

    OptionalJUPITER_FEE_BPS

    JUPITER_FEE_BPS?: number

    OptionalJUPITER_REFERRAL_ACCOUNT

    JUPITER_REFERRAL_ACCOUNT?: string

    OptionalOPENAI_API_KEY

    OPENAI_API_KEY?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    OptionalJUPITER_FEE_BPS

    JUPITER_FEE_BPS?: number

    OptionalJUPITER_REFERRAL_ACCOUNT

    JUPITER_REFERRAL_ACCOUNT?: string

    OptionalOPENAI_API_KEY

    OPENAI_API_KEY?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/Creator.html b/docs/interfaces/Creator.html index 5ba7578..5ef3e97 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 dc5f168..f2a0b9e 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/GibworkCreateTaskReponse.html b/docs/interfaces/GibworkCreateTaskReponse.html index 6ee732f..5689ddc 100644 --- a/docs/interfaces/GibworkCreateTaskReponse.html +++ b/docs/interfaces/GibworkCreateTaskReponse.html @@ -1,4 +1,4 @@ -GibworkCreateTaskReponse | solana-agent-kit

    Interface GibworkCreateTaskReponse

    interface GibworkCreateTaskReponse {
        signature?: string;
        status: "success" | "error";
        taskId?: string;
    }

    Properties

    signature? +GibworkCreateTaskReponse | solana-agent-kit

    Interface GibworkCreateTaskReponse

    interface GibworkCreateTaskReponse {
        signature?: string;
        status: "success" | "error";
        taskId?: string;
    }

    Properties

    signature? status taskId? -

    Properties

    Optionalsignature

    signature?: string

    status

    status: "success" | "error"

    OptionaltaskId

    taskId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalsignature

    signature?: string

    status

    status: "success" | "error"

    OptionaltaskId

    taskId?: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/JupiterTokenData.html b/docs/interfaces/JupiterTokenData.html index 904e265..c7d497b 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 c7d0ea0..8e5b319 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 c08a446..e34b942 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/OrderParams.html b/docs/interfaces/OrderParams.html index 215537b..edfca61 100644 --- a/docs/interfaces/OrderParams.html +++ b/docs/interfaces/OrderParams.html @@ -1,4 +1,4 @@ -OrderParams | solana-agent-kit

    Interface OrderParams

    interface OrderParams {
        price: number;
        quantity: number;
        side: string;
    }

    Properties

    price +OrderParams | solana-agent-kit

    Interface OrderParams

    interface OrderParams {
        price: number;
        quantity: number;
        side: string;
    }

    Properties

    price quantity side -

    Properties

    price

    price: number

    quantity

    quantity: number

    side

    side: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    price

    price: number

    quantity

    quantity: number

    side

    side: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PumpFunTokenOptions.html b/docs/interfaces/PumpFunTokenOptions.html index 085151e..a6f761f 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 cb76516..de81320 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
    diff --git a/docs/interfaces/PythFetchPriceResponse.html b/docs/interfaces/PythFetchPriceResponse.html index ec9c7f5..68a3a4d 100644 --- a/docs/interfaces/PythFetchPriceResponse.html +++ b/docs/interfaces/PythFetchPriceResponse.html @@ -1,7 +1,7 @@ -PythFetchPriceResponse | solana-agent-kit

    Interface PythFetchPriceResponse

    interface PythFetchPriceResponse {
        code?: string;
        message?: string;
        price?: string;
        priceFeedID?: string;
        status: "success" | "error";
        tokenSymbol: string;
    }

    Properties

    code? +PythFetchPriceResponse | solana-agent-kit

    Interface PythFetchPriceResponse

    interface PythFetchPriceResponse {
        code?: string;
        message?: string;
        price?: string;
        priceFeedID?: string;
        status: "success" | "error";
        tokenSymbol: string;
    }

    Properties

    code? message? price? priceFeedID? status tokenSymbol -

    Properties

    Optionalcode

    code?: string

    Optionalmessage

    message?: string

    Optionalprice

    price?: string

    OptionalpriceFeedID

    priceFeedID?: string

    status

    status: "success" | "error"

    tokenSymbol

    tokenSymbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    Optionalcode

    code?: string

    Optionalmessage

    message?: string

    Optionalprice

    price?: string

    OptionalpriceFeedID

    priceFeedID?: string

    status

    status: "success" | "error"

    tokenSymbol

    tokenSymbol: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PythPriceFeedIDItem.html b/docs/interfaces/PythPriceFeedIDItem.html index 8fe5270..9bf6726 100644 --- a/docs/interfaces/PythPriceFeedIDItem.html +++ b/docs/interfaces/PythPriceFeedIDItem.html @@ -1,3 +1,3 @@ -PythPriceFeedIDItem | solana-agent-kit

    Interface PythPriceFeedIDItem

    interface PythPriceFeedIDItem {
        attributes: { asset_type: string; base: string };
        id: string;
    }

    Properties

    attributes +PythPriceFeedIDItem | solana-agent-kit

    Interface PythPriceFeedIDItem

    interface PythPriceFeedIDItem {
        attributes: { asset_type: string; base: string };
        id: string;
    }

    Properties

    attributes id -

    Properties

    attributes

    attributes: { asset_type: string; base: string }

    id

    id: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    attributes

    attributes: { asset_type: string; base: string }

    id

    id: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/PythPriceItem.html b/docs/interfaces/PythPriceItem.html index 9591b0b..c18784d 100644 --- a/docs/interfaces/PythPriceItem.html +++ b/docs/interfaces/PythPriceItem.html @@ -1,3 +1,3 @@ -PythPriceItem | solana-agent-kit

    Interface PythPriceItem

    interface PythPriceItem {
        binary: { data: string[]; encoding: string };
        parsed: [
            {
                ema_price: {
                    conf: string;
                    expo: number;
                    price: string;
                    publish_time: number;
                };
                id: string;
                metadata: {
                    prev_publish_time: number;
                    proof_available_time: number;
                    slot: number;
                };
                price: {
                    conf: string;
                    expo: number;
                    price: string;
                    publish_time: number;
                };
            }[],
        ];
    }

    Properties

    binary +PythPriceItem | solana-agent-kit

    Interface PythPriceItem

    interface PythPriceItem {
        binary: { data: string[]; encoding: string };
        parsed: [
            {
                ema_price: {
                    conf: string;
                    expo: number;
                    price: string;
                    publish_time: number;
                };
                id: string;
                metadata: {
                    prev_publish_time: number;
                    proof_available_time: number;
                    slot: number;
                };
                price: {
                    conf: string;
                    expo: number;
                    price: string;
                    publish_time: number;
                };
            }[],
        ];
    }

    Properties

    binary parsed -

    Properties

    binary

    binary: { data: string[]; encoding: string }

    parsed

    parsed: [
        {
            ema_price: {
                conf: string;
                expo: number;
                price: string;
                publish_time: number;
            };
            id: string;
            metadata: {
                prev_publish_time: number;
                proof_available_time: number;
                slot: number;
            };
            price: { conf: string; expo: number; price: string; publish_time: number };
        }[],
    ]

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    binary

    binary: { data: string[]; encoding: string }

    parsed

    parsed: [
        {
            ema_price: {
                conf: string;
                expo: number;
                price: string;
                publish_time: number;
            };
            id: string;
            metadata: {
                prev_publish_time: number;
                proof_available_time: number;
                slot: number;
            };
            price: { conf: string; expo: number; price: string; publish_time: number };
        }[],
    ]

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/interfaces/TokenCheck.html b/docs/interfaces/TokenCheck.html index 5c3520f..109c5d1 100644 --- a/docs/interfaces/TokenCheck.html +++ b/docs/interfaces/TokenCheck.html @@ -1,5 +1,5 @@ -TokenCheck | solana-agent-kit

    Interface TokenCheck

    interface TokenCheck {
        risks: {
            description: string;
            level: string;
            name: string;
            score: number;
        }[];
        score: number;
        tokenProgram: string;
        tokenType: string;
    }

    Properties

    risks +TokenCheck | solana-agent-kit

    Interface TokenCheck

    interface TokenCheck {
        risks: {
            description: string;
            level: string;
            name: string;
            score: number;
        }[];
        score: number;
        tokenProgram: string;
        tokenType: string;
    }

    Properties

    risks score tokenProgram tokenType -

    Properties

    risks

    risks: { description: string; level: string; name: string; score: number }[]

    score

    score: number

    tokenProgram

    tokenProgram: string

    tokenType

    tokenType: string

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    risks

    risks: { description: string; level: string; name: string; score: number }[]

    score

    score: number

    tokenProgram

    tokenProgram: string

    tokenType

    tokenType: string

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/docs/types/Handler.html b/docs/types/Handler.html index dcfcf14..116b609 100644 --- a/docs/types/Handler.html +++ b/docs/types/Handler.html @@ -1,2 +1,2 @@ Handler | solana-agent-kit

    Type Alias Handler

    Handler: (
        agent: SolanaAgentKit,
        input: Record<string, any>,
    ) => Promise<Record<string, any>>

    Handler function type for executing the action

    -

    Type declaration

      • (
            agent: SolanaAgentKit,
            input: Record<string, any>,
        ): Promise<Record<string, any>>

      • Parameters

        Returns Promise<Record<string, any>>

    Settings

    Member Visibility
    +

    Type declaration

    Settings

    Member Visibility
    diff --git a/docs/variables/actions.html b/docs/variables/actions.html index b9c85c6..0b64780 100644 --- a/docs/variables/actions.html +++ b/docs/variables/actions.html @@ -1 +1 @@ -ACTIONS | solana-agent-kit

    Variable ACTIONSConst

    ACTIONS: {
        BALANCE_ACTION: Action;
        CREATE_GIBWORK_TASK_ACTION: Action;
        CREATE_IMAGE_ACTION: Action;
        CREATE_ORCA_SINGLE_SIDED_WHIRLPOOL_ACTION: Action;
        DEPLOY_COLLECTION_ACTION: Action;
        DEPLOY_TOKEN_ACTION: Action;
        FETCH_PRICE_ACTION: Action;
        GET_ALL_DOMAINS_TLDS_ACTION: Action;
        GET_ALL_REGISTERED_ALL_DOMAINS_ACTION: Action;
        GET_MAIN_ALL_DOMAINS_DOMAIN_ACTION: Action;
        GET_OWNED_ALL_DOMAINS_ACTION: Action;
        GET_OWNED_DOMAINS_FOR_TLD_ACTION: Action;
        GET_PRIMARY_DOMAIN_ACTION: Action;
        GET_TOKEN_DATA_ACTION: Action;
        GET_TPS_ACTION: Action;
        LAUNCH_PUMPFUN_TOKEN_ACTION: Action;
        LEND_ASSET_ACTION: Action;
        MINT_NFT_ACTION: Action;
        PYTH_FETCH_PRICE_ACTION: Action;
        RAYDIUM_CREATE_AMM_V4_ACTION: Action;
        RAYDIUM_CREATE_CPMM_ACTION: Action;
        REGISTER_DOMAIN_ACTION: Action;
        REQUEST_FUNDS_ACTION: Action;
        RESOLVE_DOMAIN_ACTION: Action;
        RESOLVE_SOL_DOMAIN_ACTION: Action;
        STAKE_WITH_JUP_ACTION: Action;
        STAKE_WITH_SOLAYER_ACTION: Action;
        TRADE_ACTION: Action;
        TRANSFER_ACTION: Action;
        WALLET_ADDRESS_ACTION: Action;
    } = ...

    Type declaration

    • BALANCE_ACTION: Action
    • CREATE_GIBWORK_TASK_ACTION: Action
    • CREATE_IMAGE_ACTION: Action
    • CREATE_ORCA_SINGLE_SIDED_WHIRLPOOL_ACTION: Action
    • DEPLOY_COLLECTION_ACTION: Action
    • DEPLOY_TOKEN_ACTION: Action
    • FETCH_PRICE_ACTION: Action
    • GET_ALL_DOMAINS_TLDS_ACTION: Action
    • GET_ALL_REGISTERED_ALL_DOMAINS_ACTION: Action
    • GET_MAIN_ALL_DOMAINS_DOMAIN_ACTION: Action
    • GET_OWNED_ALL_DOMAINS_ACTION: Action
    • GET_OWNED_DOMAINS_FOR_TLD_ACTION: Action
    • GET_PRIMARY_DOMAIN_ACTION: Action
    • GET_TOKEN_DATA_ACTION: Action
    • GET_TPS_ACTION: Action
    • LAUNCH_PUMPFUN_TOKEN_ACTION: Action
    • LEND_ASSET_ACTION: Action
    • MINT_NFT_ACTION: Action
    • PYTH_FETCH_PRICE_ACTION: Action
    • RAYDIUM_CREATE_AMM_V4_ACTION: Action
    • RAYDIUM_CREATE_CPMM_ACTION: Action
    • REGISTER_DOMAIN_ACTION: Action
    • REQUEST_FUNDS_ACTION: Action
    • RESOLVE_DOMAIN_ACTION: Action
    • RESOLVE_SOL_DOMAIN_ACTION: Action
    • STAKE_WITH_JUP_ACTION: Action
    • STAKE_WITH_SOLAYER_ACTION: Action
    • TRADE_ACTION: Action
    • TRANSFER_ACTION: Action
    • WALLET_ADDRESS_ACTION: Action

    Settings

    Member Visibility
    +ACTIONS | solana-agent-kit

    Variable ACTIONSConst

    ACTIONS: {
        BALANCE_ACTION: Action;
        CREATE_GIBWORK_TASK_ACTION: Action;
        CREATE_IMAGE_ACTION: Action;
        CREATE_ORCA_SINGLE_SIDED_WHIRLPOOL_ACTION: Action;
        DEPLOY_COLLECTION_ACTION: Action;
        DEPLOY_TOKEN_ACTION: Action;
        FETCH_PRICE_ACTION: Action;
        GET_ALL_DOMAINS_TLDS_ACTION: Action;
        GET_ALL_REGISTERED_ALL_DOMAINS_ACTION: Action;
        GET_MAIN_ALL_DOMAINS_DOMAIN_ACTION: Action;
        GET_OWNED_ALL_DOMAINS_ACTION: Action;
        GET_OWNED_DOMAINS_FOR_TLD_ACTION: Action;
        GET_PRIMARY_DOMAIN_ACTION: Action;
        GET_TOKEN_DATA_ACTION: Action;
        GET_TPS_ACTION: Action;
        LAUNCH_PUMPFUN_TOKEN_ACTION: Action;
        LEND_ASSET_ACTION: Action;
        MINT_NFT_ACTION: Action;
        PYTH_FETCH_PRICE_ACTION: Action;
        RAYDIUM_CREATE_AMM_V4_ACTION: Action;
        RAYDIUM_CREATE_CPMM_ACTION: Action;
        REGISTER_DOMAIN_ACTION: Action;
        REQUEST_FUNDS_ACTION: Action;
        RESOLVE_DOMAIN_ACTION: Action;
        RESOLVE_SOL_DOMAIN_ACTION: Action;
        STAKE_WITH_JUP_ACTION: Action;
        STAKE_WITH_SOLAYER_ACTION: Action;
        TRADE_ACTION: Action;
        TRANSFER_ACTION: Action;
        WALLET_ADDRESS_ACTION: Action;
    } = ...

    Type declaration

    • BALANCE_ACTION: Action
    • CREATE_GIBWORK_TASK_ACTION: Action
    • CREATE_IMAGE_ACTION: Action
    • CREATE_ORCA_SINGLE_SIDED_WHIRLPOOL_ACTION: Action
    • DEPLOY_COLLECTION_ACTION: Action
    • DEPLOY_TOKEN_ACTION: Action
    • FETCH_PRICE_ACTION: Action
    • GET_ALL_DOMAINS_TLDS_ACTION: Action
    • GET_ALL_REGISTERED_ALL_DOMAINS_ACTION: Action
    • GET_MAIN_ALL_DOMAINS_DOMAIN_ACTION: Action
    • GET_OWNED_ALL_DOMAINS_ACTION: Action
    • GET_OWNED_DOMAINS_FOR_TLD_ACTION: Action
    • GET_PRIMARY_DOMAIN_ACTION: Action
    • GET_TOKEN_DATA_ACTION: Action
    • GET_TPS_ACTION: Action
    • LAUNCH_PUMPFUN_TOKEN_ACTION: Action
    • LEND_ASSET_ACTION: Action
    • MINT_NFT_ACTION: Action
    • PYTH_FETCH_PRICE_ACTION: Action
    • RAYDIUM_CREATE_AMM_V4_ACTION: Action
    • RAYDIUM_CREATE_CPMM_ACTION: Action
    • REGISTER_DOMAIN_ACTION: Action
    • REQUEST_FUNDS_ACTION: Action
    • RESOLVE_DOMAIN_ACTION: Action
    • RESOLVE_SOL_DOMAIN_ACTION: Action
    • STAKE_WITH_JUP_ACTION: Action
    • STAKE_WITH_SOLAYER_ACTION: Action
    • TRADE_ACTION: Action
    • TRANSFER_ACTION: Action
    • WALLET_ADDRESS_ACTION: Action

    Settings

    Member Visibility