Skip to main content

Solana Python API

Project description


Actions Status PyPI version Codecov License: MIT Code style: black

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
  1. Install this package to interact with the Solana JSON RPC API.
pip install solana

General Usage

Note: check out the Solana Cookbook for more detailed examples!

import solana

API Client

from solana.rpc.api import Client

http_client = Client("https://api.devnet.solana.com")

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())

🔨 Development

Setup

  1. Install poetry
  2. Install dev dependencies:
poetry install
  1. Activate the poetry shell.
poetry shell

Lint

make lint

Tests

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

Project details


Download files

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

Source Distribution

solana-0.34.0.tar.gz (53.3 kB view details)

Uploaded Source

Built Distribution

solana-0.34.0-py3-none-any.whl (65.1 kB view details)

Uploaded Python 3

File details

Details for the file solana-0.34.0.tar.gz.

File metadata

  • Download URL: solana-0.34.0.tar.gz
  • Upload date:
  • Size: 53.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.9.19 Linux/6.5.0-1018-azure

File hashes

Hashes for solana-0.34.0.tar.gz
Algorithm Hash digest
SHA256 0914c7b5dd480e7c2bfb3bc296a64ea6bf069542cda3d96f460769fccc116a10
MD5 a9c88818e2cd66a10921a8ec498d4996
BLAKE2b-256 34d506219d41625791e056ce1a09bac144c5cd130ae3e4271a9df6bb1fab9ada

See more details on using hashes here.

File details

Details for the file solana-0.34.0-py3-none-any.whl.

File metadata

  • Download URL: solana-0.34.0-py3-none-any.whl
  • Upload date:
  • Size: 65.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.3.2 CPython/3.9.19 Linux/6.5.0-1018-azure

File hashes

Hashes for solana-0.34.0-py3-none-any.whl
Algorithm Hash digest
SHA256 13b08b995db60c67959e08396267b15a9f46af6ed65596625f27b361cb83d067
MD5 71f8377ea8a00c2a94eaa069583702ef
BLAKE2b-256 6b81ffefab210a73952bb2f93c0bd24225efef58c556031073f9b70b0e27aa94

See more details on using hashes here.

Supported by

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