API Reference¶

This document provides a comprehensive reference for the evrmore-rpc Python package.

Core Classes¶

EvrmoreClient¶

The main client class for interacting with the Evrmore blockchain.

from evrmore_rpc import EvrmoreClient

client = EvrmoreClient()

Configuration¶

client = EvrmoreClient(
    url="http://localhost:8819",      # RPC URL
    rpcuser="user",                   # RPC username
    rpcpassword="pass",               # RPC password
    rpcport=8819,                     # RPC port
    testnet=True,                     # Use testnet
    timeout=30,                       # Request timeout
    async_mode=None                   # Auto-detect or force sync/async
)

Key Methods¶

Blockchain¶

# Get blockchain info
info = client.getblockchaininfo()

# Get block by height
block_hash = client.getblockhash(height)
block = client.getblock(block_hash)

# Get mempool info
mempool = client.getmempoolinfo()

Assets¶

# Get asset data
info = client.getassetdata("ASSET_NAME")

# Transfer asset
txid = client.transfer("ASSET_NAME", amount, "ADDRESS")

# Issue asset
txid = client.issue(
    "ASSET_NAME",
    qty=1000,
    to_address="ADDRESS",
    units=0,
    reissuable=True
)

Transactions¶

# Get transaction
tx = client.getrawtransaction("TXID", True)

# Send transaction
txid = client.sendrawtransaction("HEX")

# Create transaction
raw_tx = client.createrawtransaction(
    [{"txid": "TXID", "vout": 0}],
    {"ADDRESS": 0.1}
)

Wallet¶

# Get balance
balance = client.getbalance()

# Send to address
txid = client.sendtoaddress("ADDRESS", 0.1)

# Get new address
address = client.getnewaddress()

EvrmoreZMQClient¶

Client for receiving real-time blockchain notifications via ZMQ.

from evrmore_rpc.zmq import EvrmoreZMQClient, ZMQTopic

zmq = EvrmoreZMQClient(
    zmq_host="127.0.0.1",
    zmq_port=28332,
    topics=[ZMQTopic.BLOCK, ZMQTopic.TX],
    rpc_client=client,
    auto_decode=True
)

Event Handlers¶

@zmq.on(ZMQTopic.BLOCK)
def handle_block(notification):
    print(f"Block #{notification.height}")

@zmq.on(ZMQTopic.TX)
def handle_tx(notification):
    print(f"TX {notification.tx['txid']}")

Data Models¶

All RPC responses are automatically parsed into Pydantic models for type safety and validation.

Block Model¶

class Block(BaseModel):
    hash: str
    height: int
    time: int
    size: int
    tx: List[str]
    # ... other fields

Transaction Model¶

class Transaction(BaseModel):
    txid: str
    size: int
    vsize: int
    version: int
    locktime: int
    vin: List[Vin]
    vout: List[Vout]
    # ... other fields

Asset Model¶

class Asset(BaseModel):
    name: str
    amount: int
    units: int
    reissuable: bool
    has_ipfs: bool
    ipfs_hash: Optional[str]
    # ... other fields

Error Handling¶

The client raises specific exceptions for different error types:

from evrmore_rpc import EvrmoreRPCError

try:
    client.getblockchaininfo()
except EvrmoreRPCError as e:
    print(f"RPC error: {e}")
except Exception as e:
    print(f"Unexpected error: {e}")

Performance Optimization¶

Connection reuse and batching¶

EvrmoreClient reuses underlying HTTP connections via its internal sessions. For best performance, create a client once and reuse it for many calls, and batch work where possible:

For processing multiple blocks or transactions:

async def process_blocks(start_height, end_height):
    async with EvrmoreClient() as client:
        for height in range(start_height, end_height):
            block_hash = await client.getblockhash(height)
            block = await client.getblock(block_hash)
            # Process block