Mina Python SDK

Python SDK for interacting with Mina Protocol nodes.

Features

• Daemon GraphQL client -- query node status, accounts, blocks; send payments and delegations
• Typed response objects with Currency arithmetic
• Automatic retry with configurable backoff
• Context manager support for clean resource management

Installation

pip install mina-sdk

For archive database support (coming soon):

pip install mina-sdk[archive]

Quick Start

from mina_sdk import MinaDaemonClient, Currency

with MinaDaemonClient() as client:
    # Check sync status
    print(client.get_sync_status())  # "SYNCED"

    # Query an account
    account = client.get_account("B62q...")
    print(f"Balance: {account.balance.total} MINA")

    # Send a payment
    result = client.send_payment(
        sender="B62qsender...",
        receiver="B62qreceiver...",
        amount=Currency("1.5"),
        fee=Currency("0.01"),
    )
    print(f"Tx hash: {result.hash}")

Configuration

client = MinaDaemonClient(
    graphql_uri="http://127.0.0.1:3085/graphql",  # default
    retries=3,        # retry failed requests (must be >= 1)
    retry_delay=5.0,  # seconds between retries (must be >= 0)
    timeout=30.0,     # HTTP timeout in seconds (must be > 0)
)

API Reference

The Mina SDKs have the same API, defined in mina-sdk-spec. spec/ is a copy of it at the tag in spec/VERSION. tests/test_spec.py checks that this SDK's queries are the specification's documents, and CI checks that spec/ is the tag's copy.

Queries

Mutations

ITN server (mina_sdk.itn)

A daemon started with ITN_FEATURES=1, --itn-graphql-port and --itn-keys serves a second GraphQL API, which load testing tools use. ItnClient signs each request with an ed25519 ItnKey whose public half must be in --itn-keys, and it handles the daemon's sequence numbers (a new auth after a daemon restart, HTTP 412). It needs the itn extra:

pip install 'mina-sdk[itn]'

from mina_sdk.itn import ItnClient, ItnKey

key = ItnKey.from_base64(open("itn_sk").read())
print("start the daemon with --itn-keys", key.public_key_base64())

with ItnClient("http://127.0.0.1:3086/graphql", key) as itn:
    logs = itn.internal_logs(0)
    if logs:
        itn.flush_internal_logs(logs[-1].id)

These need a daemon with MinaProtocol/mina#19616; older daemons answer them with a GraphQL error:

A handle is a UUID that the caller chooses and records before the call. A call with the handle of a running scheduler starts nothing and returns that handle, so these calls may be repeated after a transport error.

Requests of one client are sent one at a time, because the daemon accepts only its exact next sequence number; the client is safe to share between threads. A sequenced request is never repeated after a transport error, because the daemon may already have run it. Errors: ItnUnauthorizedError (401), ItnSequencingError (412 after a new auth), InvalidItnKeyError, and DaemonConnectionError whose __cause__ is an ItnHttpError with the status. The documents are those of spec/itn-operations.graphql. Integration tests: set MINA_ITN_URI and MINA_ITN_KEY and run pytest tests/test_itn_integration.py.

Currency

from mina_sdk import Currency

a = Currency(10)              # 10 MINA
b = Currency("1.5")           # 1.5 MINA
c = Currency.from_nanomina(1_000_000_000)  # 1 MINA

print(a + b)        # 11.500000000
print(a.nanomina)   # 10000000000
print(a > b)        # True
print(3 * b)        # 4.500000000

Error Handling

from mina_sdk import MinaDaemonClient, GraphQLError, DaemonConnectionError, CurrencyUnderflow

with MinaDaemonClient(retries=3, retry_delay=2.0) as client:
    try:
        account = client.get_account("B62q...")
    except ValueError as e:
        # Account not found on ledger
        print(f"Account does not exist: {e}")
    except GraphQLError as e:
        # Daemon returned a GraphQL-level error
        print(f"GraphQL error: {e}")
        print(f"Raw errors: {e.errors}")
    except DaemonConnectionError as e:
        # All retry attempts exhausted
        print(f"Cannot reach daemon after retries: {e}")

# Currency underflow
from mina_sdk import Currency, CurrencyUnderflow

try:
    result = Currency(1) - Currency(2)
except CurrencyUnderflow:
    print("Subtraction would result in negative balance")

Data Types

All response types are importable from the top-level package:

from mina_sdk import (
    AccountBalance,    # total, liquid, locked balances, block height
    AccountData,       # public_key, nonce, balance, delegate, timing, permissions, zkApp state
    BlockInfo,         # state_hash, height, slots, creator, epochs, ledger hashes, transactions
    DaemonStatus,      # sync_status, chain height, peers, uptime, addresses
    DaemonMetrics,     # pool sizes and diffs, block production delay
    PeerInfo,          # peer_id, host, port
    PooledUserCommand, # a pending payment or delegation
    SubmittedCommand,  # result of send_payment / send_delegation
    ZkappCommandResult,  # a pending or sent zkApp command
    CompletedWork,     # snark pool entry
    GenesisConstants,
    TrackedAccount,
    TransactionStatus,
    SignatureInput,    # field, scalar
)

Development

git clone https://github.com/MinaProtocol/mina-sdk-python.git
cd mina-sdk-python
python3 -m venv .venv && . .venv/bin/activate
pip install -e ".[dev]"
pytest

Running integration tests

Integration tests require a running Mina daemon:

MINA_GRAPHQL_URI=http://127.0.0.1:3085/graphql \
MINA_TEST_SENDER_KEY=B62q... \
MINA_TEST_RECEIVER_KEY=B62q... \
pytest tests/test_integration.py -v

Troubleshooting

Connection refused / DaemonConnectionError

The daemon is not running or not reachable at the configured URI. Check:

• Is the daemon running? (mina client status)
• Is the GraphQL port open? (default: 3085)
• Is --insecure-rest-server set if connecting from a different host?

GraphQLError: field not found

The SDK's queries may be out of sync with the daemon's GraphQL schema. This can happen after a daemon upgrade. Check the documents against your node with mina-sdk-spec: python3 scripts/check.py --endpoint http://your-node:3085/graphql (in a clone of mina-sdk-spec).

Account not found

get_account() raises AccountNotFoundError (a ValueError) when the account doesn't exist on the ledger. This is normal for new accounts that haven't received any transactions yet.

License

Apache License 2.0