ouro-sdk

Python SDK for the Ouroboros decentralized blockchain network.

Install

pip install ouro-sdk

# For async support (AsyncOuroClient):
pip install ouro-sdk[async]

Quick Start (sync)

from ouro_sdk import OuroClient

client = OuroClient("http://localhost:8000", api_key="your-api-key")

# Check health
print(client.health())  # {'status': 'healthy', ...}

# Get consensus state
c = client.consensus()
print(f"View: {c['view']}, Leader: {c['leader']}")

# Get balance
bal = client.balance("ouro1myaddress")
print(f"Balance: {bal['balance']} nanoouro")

# Submit a transaction
result = client.submit_transaction({
    "sender": "ouro1abc...",
    "recipient": "ouro1xyz...",
    "amount": 1_000_000_000,  # 1 OURO
    "signature": "hex-encoded-signature",
})
print(f"TX: {result['tx_id']}")

# Combined status snapshot
status = client.status()
print(f"Online: {status['online']}, Block: {status.get('metrics', {}).get('block_height')}")

Quick Start (async)

import asyncio
from ouro_sdk import AsyncOuroClient

async def main():
    client = AsyncOuroClient("http://localhost:8000", api_key="your-api-key")
    health = await client.health()
    consensus = await client.consensus()
    status = await client.status()
    print(status)

asyncio.run(main())

API Reference

Environment Variables

• OURO_API_KEY — API key for protected endpoints

License

MIT