Skip to main content

Solana Python API

Project description

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

Solana.py

Solana Python API built on the JSON RPC API.

Python version of solana-web3.js for interacting with Solana.

Read the Documentation.

Also check out anchorpy, a Python client for Anchor based programs on Solana.

Quickstart

Installation

pip install solana

General Usage

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("ws://api.devnet.solana.com") as websocket:
        await websocket.logs_subscribe()
        first_resp = await websocket.recv()
        subscription_id = first_resp.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("ws://api.devnet.solana.com") as websocket:
        await websocket.logs_subscribe()
        first_resp = await websocket.recv()
        subscription_id = first_resp.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

Start a Solana Localnet

Install docker.

# Update/pull latest docker image
make update-localnet
# Start localnet instance
make start-localnet

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.20.0.tar.gz (69.6 kB view details)

Uploaded Source

Built Distribution

solana-0.20.0-py3-none-any.whl (85.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: solana-0.20.0.tar.gz
  • Upload date:
  • Size: 69.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.9 Darwin/21.1.0

File hashes

Hashes for solana-0.20.0.tar.gz
Algorithm Hash digest
SHA256 4dfb2ce0f361ab75da41257f81d5e54dbadd78ef11028e48183baad450f87de5
MD5 92e2bf36eb0cf2f8b854dd1bd947e0e8
BLAKE2b-256 cc47f164e6e4cc6db0384df51015faaa498a47a605aea5584ef40fc0b3e24edb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: solana-0.20.0-py3-none-any.whl
  • Upload date:
  • Size: 85.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.7.9 Darwin/21.1.0

File hashes

Hashes for solana-0.20.0-py3-none-any.whl
Algorithm Hash digest
SHA256 20b34291a542425edae26643ed529293c806d7f70b216246f1cf46d3512308c3
MD5 20df875a8864af5da3c3505db8bd880e
BLAKE2b-256 52b1a63297f6351a869a89d794801a6e11615d1350c91f7ccf02f2a5bdafb677

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