Class SolanaAgentKit

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

connection

openai_api_key

wallet

wallet_address

createGibworkTask

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

• Parameters

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

  Returns Promise<GibworkCreateTaskReponse>

createOrcaSingleSidedWhirlpool

• createOrcaSingleSidedWhirlpool(depositTokenAmount, depositTokenMint, otherTokenMint, initialPrice, maxPrice, feeTier): Promise<string>

• Parameters

  • depositTokenAmount: BN
  • depositTokenMint: PublicKey
  • otherTokenMint: PublicKey
  • initialPrice: Decimal
  • maxPrice: Decimal
  • feeTier:
        | 0.01
        | 0.02
        | 0.04
        | 0.05
        | 0.16
        | 0.3
        | 0.65
        | 1
        | 2

  Returns Promise<string>

createTiplink

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

• Parameters

  • amount: number
  • OptionalsplmintAddress: PublicKey

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

deployCollection

• deployCollection(options): Promise<CollectionDeployment>

• Parameters

  • options: CollectionOptions

  Returns Promise<CollectionDeployment>

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;
  }>

fetchTokenPrice

• fetchTokenPrice(mint): Promise<string>

• Parameters

  • mint: string

  Returns Promise<string>

getAllDomainsTLDs

• getAllDomainsTLDs(): Promise<String[]>

• Returns Promise<String[]>

getAllRegisteredAllDomains

• getAllRegisteredAllDomains(): Promise<string[]>

• Returns Promise<string[]>

getBalance

• getBalance(token_address?): Promise<number>

• Parameters

  • Optionaltoken_address: PublicKey

  Returns Promise<number>

getMainAllDomainsDomain

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

• Parameters

  • owner: PublicKey

  Returns Promise<null | string>

getOwnedAllDomains

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

• Parameters

  • owner: PublicKey

  Returns Promise<string[]>

getOwnedDomainsForTLD

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

• Parameters

  • tld: string

  Returns Promise<string[]>

getPrimaryDomain

• getPrimaryDomain(account): Promise<string>

• Parameters

  • account: PublicKey

  Returns Promise<string>

getTokenDataByAddress

• getTokenDataByAddress(mint): Promise<undefined | JupiterTokenData>

• Parameters

  • mint: string

  Returns Promise<undefined | JupiterTokenData>

getTokenDataByTicker

• getTokenDataByTicker(ticker): Promise<undefined | JupiterTokenData>

• Parameters

  • ticker: string

  Returns Promise<undefined | JupiterTokenData>

getTPS

• getTPS(): Promise<number>

• Returns Promise<number>

launchPumpFunToken

• launchPumpFunToken(tokenName, tokenTicker, description, imageUrl, options?): Promise<PumpfunLaunchResponse>

• Parameters

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

  Returns Promise<PumpfunLaunchResponse>

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>

openbookCreateMarket

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

• Parameters

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

  Returns Promise<string[]>

pythFetchPrice

• pythFetchPrice(priceFeedID): Promise<string>

• Parameters

  • priceFeedID: string

  Returns Promise<string>

raydiumCreateAmmV4

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

• Parameters

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

  Returns Promise<string>

raydiumCreateClmm

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

• Parameters

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

  Returns Promise<string>

raydiumCreateCpmm

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

• Parameters

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

  Returns Promise<string>

registerDomain

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

• Parameters

  • name: string
  • OptionalspaceKB: number

  Returns Promise<string>

requestFaucetFunds

• requestFaucetFunds(): Promise<string>

• Returns Promise<string>

resolveAllDomains

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

• Parameters

  • domain: string

  Returns Promise<undefined | PublicKey>

resolveSolDomain

• resolveSolDomain(domain): Promise<PublicKey>

• Parameters

  • domain: string

  Returns Promise<PublicKey>

rockPaperScissors

• rockPaperScissors(amount, choice): Promise<string>

• Parameters

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

  Returns Promise<string>

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>