Skip to main content

A Python toolkit for Solana agents

Project description

Solana Agent Kit

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

Features

  • 🪙 Token Operations

    • Deploy new SPL tokens
    • Transfer SOL and SPL tokens
    • Check token balances
    • Stake SOL
  • 💱 Trading

    • Integrated Jupiter Exchange support
    • Token swaps with customizable slippage
    • Direct routing options
  • 🏦 Yield Farming

    • Lend idle assets to earn interest with Lulo
  • 🔗 LangChain Integration

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

Installation

pip install agentipy

Quick Start

from solana_agent_kit import SolanaAgentKit, create_solana_tools

# Initialize with private key and optional RPC URL
agent = SolanaAgentKit(
    "your-wallet-private-key-as-base58",
    "https://api.mainnet-beta.solana.com",
    "your-openai-api-key"
)

# Create LangChain tools
tools = create_solana_tools(agent)

Usage Examples

Deploy a New Token

from solana_agent_kit import deploy_token

result = deploy_token(
    agent,
    decimals=9,  # decimals
    initial_supply=1000000  # initial supply
)

print("Token Mint Address:", result["mint"].to_base58())

Create NFT Collection

from solana_agent_kit import deploy_collection

collection = deploy_collection(agent, {
    "name": "My NFT Collection",
    "uri": "https://arweave.net/metadata.json",
    "royalty_basis_points": 500,  # 5%
    "creators": [
        {
            "address": "creator-wallet-address",
            "percentage": 100,
        },
    ],
})

Swap Tokens

from solana_agent_kit import trade
from solana.publickey import PublicKey

signature = trade(
    agent,
    output_mint=PublicKey("target-token-mint"),
    input_amount=100,  # amount
    input_mint=PublicKey("source-token-mint"),
    slippage_bps=300  # 3% slippage
)

Lend Tokens

from solana_agent_kit import lend_asset

signature = lend_asset(
    agent,
    amount=100  # amount
)

Stake SOL

from solana_agent_kit import stake_with_jup

signature = stake_with_jup(
    agent,
    amount=1  # amount in SOL
)

Fetch Token Price

from solana_agent_kit import fetch_price

price = fetch_price(
    agent,
    "JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN"  # Token mint address
)

print("Price in USDC:", price)

Send an SPL Token Airdrop via ZK Compression

from solana_agent_kit import send_compressed_airdrop, get_airdrop_cost_estimate
from solana.publickey import PublicKey

print(
    "~Airdrop cost estimate:",
    get_airdrop_cost_estimate(
        recipients=1000,  # recipients
        priority_fee_in_lamports=30000  # priority fee in lamports
    )
)

signature = send_compressed_airdrop(
    agent,
    mint_address=PublicKey("JUPyiwrYJFskUPiHa7hkeR8VUtAeFoSYbKedZNsDvCN"),  # mint
    amount_per_recipient=42,  # amount per recipient
    recipients=[
        PublicKey("1nc1nerator11111111111111111111111111111111"),
        # ... add more recipients
    ],
    priority_fee_in_lamports=30000  # priority fee in lamports
)

API Reference

Core Functions

deploy_token(agent, decimals?, name, uri, symbol, initial_supply?)

Deploy a new SPL token with optional initial supply. If not specified, decimals default to 9.

deploy_collection(agent, options)

Create a new NFT collection with customizable metadata and royalties.

mint_collection_nft(agent, collection_mint, metadata, recipient?)

Mint a new NFT as part of an existing collection.

transfer(agent, to, amount, mint?)

Transfer SOL or SPL tokens to a recipient.

trade(agent, output_mint, input_amount, input_mint?, slippage_bps?)

Swap tokens using Jupiter Exchange integration.

get_balance(agent, token_address)

Check SOL or token balance for the agent's wallet.

lend_asset(agent, asset_mint, amount)

Lend idle assets to earn interest with Lulo.

stake_with_jup(agent, amount)

Stake SOL with Jupiter to earn rewards.

send_compressed_airdrop(agent, mint_address, amount, recipients, priority_fee_in_lamports?, should_log?)

Send an SPL token airdrop to many recipients at low cost via ZK Compression.

Dependencies

The toolkit relies on several key Solana and Metaplex libraries:

  • solana-py
  • spl-token-py
  • metaplex-foundation
  • lightprotocol

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

ISC License

Security

This toolkit handles private keys and transactions. Always ensure you're using it in a secure environment and never share your private keys.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

agentipy-1.1.5.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

agentipy-1.1.5-py3-none-any.whl (26.3 kB view details)

Uploaded Python 3

File details

Details for the file agentipy-1.1.5.tar.gz.

File metadata

  • Download URL: agentipy-1.1.5.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for agentipy-1.1.5.tar.gz
Algorithm Hash digest
SHA256 cd1417d5bce185ef7946e1fe4e3b186876d97c3270bef4bc32201d70d19f748b
MD5 1625ffb2b8341860a760ec28ddf59da2
BLAKE2b-256 9b0335aab771740b1a4eafdb40dd79dbca6afd4f7d570b9b870539652ecd35ff

See more details on using hashes here.

File details

Details for the file agentipy-1.1.5-py3-none-any.whl.

File metadata

  • Download URL: agentipy-1.1.5-py3-none-any.whl
  • Upload date:
  • Size: 26.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.0

File hashes

Hashes for agentipy-1.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 d6c9307aace755a45d8fe39a0c244c5b86b80c0a695a06a70843ce280b2333ad
MD5 c181b095b9543fe2de93ccb342a3f983
BLAKE2b-256 875b34aad9d2736a2639280c40f15c24ddc1e82a36b8f952fb813390b47f78dd

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page