Solana.py

🐍 The Solana Python SDK 🐍

Solana.py is the base Python library for interacting with Solana. You can use it to build transactions and interact with the Solana JSON RPC API, much like you would do with solana-web3.js

It also covers the SPL Token Program.

Latest Documentation.

Note: This library uses many core types from the Solders package which used to be provided by solana-py itself. If you are upgrading from an old version and you're looking for something that was deleted, it's probably in solders now.

⚓︎ See also: AnchorPy, a Python client for Anchor-based programs on Solana. ⚓︎

⚡ Quickstart

Installation

1. Install Python bindings for the solana-sdk.

pip install solders

2. Install this package to interact with the Solana JSON RPC API.

pip install solana

General Usage

• Python Cookbook
• Solana Cookbook

Async API Client

import asyncio
from solana.rpc.async_api import AsyncClient


async def main():
    async with AsyncClient("https://api.devnet.solana.com") as client:
        res = await client.is_connected()
    print(res)  # True

    # Alternatively, close the client explicitly instead of using a context manager:
    client = AsyncClient("https://api.devnet.solana.com")
    res = await client.is_connected()
    print(res)  # True
    await client.close()


asyncio.run(main())

Websockets Client

import asyncio
from asyncstdlib import enumerate
from solana.rpc.websocket_api import connect


async def main():
    async with connect("wss://api.devnet.solana.com") as websocket:
        await websocket.logs_subscribe()
        first_resp = await websocket.recv()
        subscription_id = first_resp[0].result
        next_resp = await websocket.recv()
        print(next_resp)
        await websocket.logs_unsubscribe(subscription_id)

    # Alternatively, use the client as an infinite asynchronous iterator:
    async with connect("wss://api.devnet.solana.com") as websocket:
        await websocket.logs_subscribe()
        first_resp = await websocket.recv()
        subscription_id = first_resp[0].result
        async for idx, msg in enumerate(websocket):
            if idx == 3:
                break
            print(msg)
        await websocket.logs_unsubscribe(subscription_id)


asyncio.run(main())

*_unsubscribe() takes the server-assigned subscription ID (first_resp[0].result, as above). As a convenience it also accepts the request ID returned by the matching *_subscribe() helper, which is translated once the subscription confirmation has been received. Server-assigned IDs are resolved first, so prefer that form when you have it.

🔨 Development

Setup

1. Install uv
2. Install dev dependencies:

uv sync

3. Activate the virtual environment.

.venv\Scripts\activate   # Windows
source .venv/bin/activate  # Linux/macOS

Lint

make lint

Tests

# All tests
make tests
# Unit tests only
make unit-tests
# Integration tests only
make int-tests

Documentation

To build documentation from source files run:

make build-docs

To serve documentation locally run:

make serve