diff --git a/docs/classes/SolanaAgentKit.html b/docs/classes/SolanaAgentKit.html index 7e06b3d..305d064 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 wallet wallet_address @@ -13,7 +13,7 @@ Provides a unified interface for token operations, NFT management, and tradingrequestFaucetFunds trade transfer -

Constructors

constructor

  • new SolanaAgentKit(private_key, rpc_url?): SolanaAgentKit

  • Parameters

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

    Returns SolanaAgentKit

Properties

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

deployCollection

deployToken

  • deployToken(decimals?, initialSupply?): Promise<{
        mint: PublicKey;
        tokenAccount: undefined | PublicKey;
    }>

  • Parameters

    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
    • OptionalinitialSupply: number

    Returns Promise<{
        mint: PublicKey;
        tokenAccount: undefined | PublicKey;
    }>

getBalance

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

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

mintNFT

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

  • Parameters

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

    Returns Promise<MintCollectionNFTResponse>

registerDomain

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

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

  • requestFaucetFunds(): Promise<void>

  • Returns Promise<void>

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

Properties

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

deployCollection

deployToken

  • deployToken(decimals?, initialSupply?): Promise<{
        mint: PublicKey;
        tokenAccount: undefined | PublicKey;
    }>

  • Parameters

    • decimals: number = DEFAULT_OPTIONS.TOKEN_DECIMALS
    • OptionalinitialSupply: number

    Returns Promise<{
        mint: PublicKey;
        tokenAccount: undefined | PublicKey;
    }>

getBalance

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

  • Parameters

    • Optionaltoken_address: PublicKey

    Returns Promise<null | number>

mintNFT

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

  • Parameters

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

    Returns Promise<MintCollectionNFTResponse>

registerDomain

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

  • Parameters

    • name: string
    • OptionalspaceKB: number

    Returns Promise<string>

requestFaucetFunds

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 c98ea81..95edd43 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)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool)[]

Settings

Member Visibility
+createSolanaTools | solana-agent-kit

Function createSolanaTools

  • createSolanaTools(solanaKit): (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaGetWalletAddressTool)[]

  • Parameters

    Returns (
        | SolanaBalanceTool
        | SolanaTransferTool
        | SolanaDeployTokenTool
        | SolanaDeployCollectionTool
        | SolanaMintNFTTool
        | SolanaTradeTool
        | SolanaRequestFundsTool
        | SolanaRegisterDomainTool
        | SolanaGetWalletAddressTool)[]

Settings

Member Visibility
diff --git a/docs/index.html b/docs/index.html index c876df2..a1b3de6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,4 +1,4 @@ -solana-agent-kit

solana-agent-kit

Solana Agent Kit

A powerful toolkit for interacting with the Solana blockchain, providing easy-to-use functions for token operations, NFT management, and trading.

+solana-agent-kit

solana-agent-kit

Solana Agent Kit

A powerful toolkit for interacting with the Solana blockchain, providing easy-to-use functions for token operations, NFT management, and trading. Now integrated with LangChain for enhanced functionality.

Features

  • 🪙 Token Operations

    @@ -24,11 +24,18 @@
  • Direct routing options
+
  • +

    🔗 LangChain Integration

    +
      +
    • Utilize LangChain tools for enhanced blockchain interactions
      • +
    • Access a suite of tools for balance checks, transfers, token deployments, and more
      • +
    +

    • Installation

    npm install solana-agent-kit
    -

    Quick Start

    import { SolanaAgentKit } from 'solana-agent-kit';

    // Initialize with private key and optional RPC URL
    const agent = new SolanaAgentKit(
      'your-private-key',
      'https://api.mainnet-beta.solana.com'
    );
+
    Quick Start
    import { SolanaAgentKit, createSolanaTools } from 'solana-agent-kit';

    // Initialize with private key and optional RPC URL
    const agent = new SolanaAgentKit(
      'your-private-key',
      'https://api.mainnet-beta.solana.com'
    );

    // Create LangChain tools
    const tools = createSolanaTools(agent);
 
    
 
 
    Usage Examples
    Deploy a New Token
    import { deploy_token } from 'solana-agent-kit';

    const result = await deploy_token(
      agent,
      9, // decimals
      1000000 // initial supply
    );

    console.log('Token Mint Address:', result.mint.toString());
diff --git a/docs/interfaces/CollectionDeployment.html b/docs/interfaces/CollectionDeployment.html
index c36da7b..bf45e82 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 7c99c76..715536a 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 e40897c..aa26557 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/MintCollectionNFTResponse.html b/docs/interfaces/MintCollectionNFTResponse.html
index 9eae721..0175b95 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