Class SolanaAgentKit

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

SolanaAgentKit

Constructors

constructor

new SolanaAgentKit(
    private_key: string,
    rpc_url: string,
    openai_api_key: null | string,
): SolanaAgentKit
Parameters
- private_key: string
- rpc_url: string
- openai_api_key: null | string
Returns SolanaAgentKit
Deprecated
Using openai_api_key directly in constructor is deprecated. Please use the new constructor with Config object instead:
Example
```
const agent = new SolanaAgentKit(privateKey, rpcUrl, { 
  OPENAI_API_KEY: 'your-key'
});
```
- Defined in agent/index.ts:86
new SolanaAgentKit(
    private_key: string,
    rpc_url: string,
    config: Config,
): SolanaAgentKit
Parameters
- private_key: string
- rpc_url: string
- config: Config
Returns SolanaAgentKit
- Defined in agent/index.ts:87

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

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>
- Defined in agent/index.ts:404

createTiplink

createTiplink(
amount: number,
splmintAddress?: PublicKey,
): Promise<{ signature: string; url: string }>
Parameters
- amount: number
- OptionalsplmintAddress: PublicKey
Returns Promise<{ signature: string; url: string }>
- Defined in agent/index.ts:431

deployCollection

deployCollection(options: CollectionOptions): Promise<CollectionDeployment>
Parameters
- options: CollectionOptions
Returns Promise<CollectionDeployment>
- Defined in agent/index.ts:120

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 }>
- Defined in agent/index.ts:110

fetchTokenPrice

fetchTokenPrice(mint: string): Promise<string>
Parameters
- mint: string
Returns Promise<string>
- Defined in agent/index.ts:194

getAllDomainsTLDs

getAllDomainsTLDs(): Promise<string[]>
Returns Promise<string[]>
- Defined in agent/index.ts:318

getAllRegisteredAllDomains

getAllRegisteredAllDomains(): Promise<string[]>
Returns Promise<string[]>
- Defined in agent/index.ts:322

getBalance

getBalance(token_address?: PublicKey): Promise<number>
Parameters
- Optionaltoken_address: PublicKey
Returns Promise<number>
- Defined in agent/index.ts:126

getBalanceOther

getBalanceOther(
walletAddress: PublicKey,
tokenAddress?: PublicKey,
): Promise<number>
Parameters
- walletAddress: PublicKey
- OptionaltokenAddress: PublicKey
Returns Promise<number>
- Defined in agent/index.ts:130

getMainAllDomainsDomain

getMainAllDomainsDomain(owner: PublicKey): Promise<null | string>
Parameters
- owner: PublicKey
Returns Promise<null | string>
- Defined in agent/index.ts:326

getOwnedAllDomains

getOwnedAllDomains(owner: PublicKey): Promise<string[]>
Parameters
- owner: PublicKey
Returns Promise<string[]>
- Defined in agent/index.ts:310

getOwnedDomainsForTLD

getOwnedDomainsForTLD(tld: string): Promise<string[]>
Parameters
- tld: string
Returns Promise<string[]>
- Defined in agent/index.ts:314

getPrimaryDomain

getPrimaryDomain(account: PublicKey): Promise<string>
Parameters
- account: PublicKey
Returns Promise<string>
- Defined in agent/index.ts:161

getTokenDataByAddress

getTokenDataByAddress(mint: string): Promise<undefined | JupiterTokenData>
Parameters
- mint: string
Returns Promise<undefined | JupiterTokenData>
- Defined in agent/index.ts:182

getTokenDataByTicker

getTokenDataByTicker(ticker: string): Promise<undefined | JupiterTokenData>
Parameters
- ticker: string
Returns Promise<undefined | JupiterTokenData>
- Defined in agent/index.ts:188

getTPS

getTPS(): Promise<number>
Returns Promise<number>
- Defined in agent/index.ts:178

launchPumpFunToken

launchPumpFunToken(
    tokenName: string,
    tokenTicker: string,
    description: string,
    imageUrl: string,
    options?: PumpFunTokenOptions,
): Promise<PumpfunLaunchResponse>
Parameters
- tokenName: string
- tokenTicker: string
- description: string
- imageUrl: string
- Optionaloptions: PumpFunTokenOptions
Returns Promise<PumpfunLaunchResponse>
- Defined in agent/index.ts:198

lendAssets

lendAssets(amount: number): Promise<string>
Parameters
- amount: number
Returns Promise<string>
- Defined in agent/index.ts:174

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>
- Defined in agent/index.ts:137

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[]>
- Defined in agent/index.ts:384

orcaClosePosition

orcaClosePosition(positionMintAddress: PublicKey): Promise<string>
Parameters
- positionMintAddress: PublicKey
Returns Promise<string>
- Defined in agent/index.ts:238

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>
- Defined in agent/index.ts:242

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>
- Defined in agent/index.ts:251

orcaFetchPositions

orcaFetchPositions(): Promise<string>
Returns Promise<string>
- Defined in agent/index.ts:270

orcaOpenCenteredPositionWithLiquidity

orcaOpenCenteredPositionWithLiquidity(
    whirlpoolAddress: PublicKey,
    priceOffsetBps: number,
    inputTokenMint: PublicKey,
    inputAmount: Decimal,
): Promise<string>
Parameters
- whirlpoolAddress: PublicKey
- priceOffsetBps: number
- inputTokenMint: PublicKey
- inputAmount: Decimal
Returns Promise<string>
- Defined in agent/index.ts:274

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>
- Defined in agent/index.ts:289

pythFetchPrice

pythFetchPrice(priceFeedID: string): Promise<string>
Parameters
- priceFeedID: string
Returns Promise<string>
- Defined in agent/index.ts:400

raydiumCreateAmmV4

raydiumCreateAmmV4(
    marketId: PublicKey,
    baseAmount: BN,
    quoteAmount: BN,
    startTime: BN,
): Promise<string>
Parameters
- marketId: PublicKey
- baseAmount: BN
- quoteAmount: BN
- startTime: BN
Returns Promise<string>
- Defined in agent/index.ts:330

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>
- Defined in agent/index.ts:347

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>
- Defined in agent/index.ts:364

registerDomain

registerDomain(name: string, spaceKB?: number): Promise<string>
Parameters
- name: string
- OptionalspaceKB: number
Returns Promise<string>
- Defined in agent/index.ts:153

requestFaucetFunds

requestFaucetFunds(): Promise<string>
Returns Promise<string>
- Defined in agent/index.ts:106

resolveAllDomains

resolveAllDomains(domain: string): Promise<undefined | PublicKey>
Parameters
- domain: string
Returns Promise<undefined | PublicKey>
- Defined in agent/index.ts:306

resolveSolDomain

resolveSolDomain(domain: string): Promise<PublicKey>
Parameters
- domain: string
Returns Promise<PublicKey>
- Defined in agent/index.ts:157

rockPaperScissors

rockPaperScissors(
amount: number,
choice: "rock" | "paper" | "scissors",
): Promise<string>
Parameters
- amount: number
- choice: "rock" | "paper" | "scissors"
Returns Promise<string>
- Defined in agent/index.ts:425

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[]>
- Defined in agent/index.ts:219

stake

stake(amount: number): Promise<string>
Parameters
- amount: number
Returns Promise<string>
- Defined in agent/index.ts:215

tensorCancelListing

tensorCancelListing(nftMint: PublicKey): Promise<string>
Parameters
- nftMint: PublicKey
Returns Promise<string>
- Defined in agent/index.ts:439

tensorListNFT

tensorListNFT(nftMint: PublicKey, price: number): Promise<string>
Parameters
- nftMint: PublicKey
- price: number
Returns Promise<string>
- Defined in agent/index.ts:435

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>
- Defined in agent/index.ts:165

transfer

transfer(to: PublicKey, amount: number, mint?: PublicKey): Promise<string>
Parameters
- to: PublicKey
- amount: number
- Optionalmint: PublicKey
Returns Promise<string>
- Defined in agent/index.ts:145

Class SolanaAgentKit

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns SolanaAgentKit

Deprecated

Example

Parameters

Returns SolanaAgentKit

Properties

config

connection

wallet

wallet_address

Methods

createGibworkTask

Parameters

Returns Promise<GibworkCreateTaskReponse>

createTiplink

Parameters

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

deployCollection

Parameters

Returns Promise<CollectionDeployment>

deployToken

Parameters

Returns Promise<{ mint: PublicKey }>

fetchTokenPrice

Parameters

Returns Promise<string>

getAllDomainsTLDs

Returns Promise<string[]>

getAllRegisteredAllDomains

Returns Promise<string[]>

getBalance

Parameters

Returns Promise<number>

getBalanceOther

Parameters

Returns Promise<number>

getMainAllDomainsDomain

Parameters

Returns Promise<null | string>

getOwnedAllDomains

Parameters

Returns Promise<string[]>

getOwnedDomainsForTLD

Parameters

Returns Promise<string[]>

getPrimaryDomain

Parameters

Returns Promise<string>

getTokenDataByAddress

Parameters

Returns Promise<undefined | JupiterTokenData>

getTokenDataByTicker

Parameters

Returns Promise<undefined | JupiterTokenData>

getTPS

Returns Promise<number>

launchPumpFunToken

Parameters

Returns Promise<PumpfunLaunchResponse>

lendAssets

Parameters

Returns Promise<string>

mintNFT

Parameters

Returns Promise<MintCollectionNFTResponse>

openbookCreateMarket

Parameters

Returns Promise<string[]>

orcaClosePosition

Parameters

Returns Promise<string>

orcaCreateCLMM