atto.py 0.1.0

A Python API wrapper for the Atto node API.

attopy

A Python API wrapper for the Atto node API.

An instance of AttoClient() represents a connection to an Atto node. Communication with the node happens through AttoClient()’s members.

The methods wrap the information from API responses in the form of Python builtins and classes in this module, such as:

• Account

• Entry

• Receivable

• Transaction

• Block

Typical usage example:

from attopy import AttoClient, address_to_key

ADDRESS = '<your_address>'.removeprefix('atto://')

with AttoClient() as node:
    public_key = address_to_key(ADDRESS)
    account = node.get_account(public_key)
    print(f'balance: {account.balance}')

    # print first 100 transactions
    print('Hash\\tAmount')
    for entry in node.entries_stream(account, from_height=1, to_height=10, timeout=None):
        print(f'{entry.hash_[0:3]}...\\t{entry.amount}')

Example output:

balance: 1349500000
hash        Amount
A5DF...     10000000
BEEF...     49000000000
DEAD...     2500000000
... 97 more lines ...

What’s missing?

AttoClient() is a synchronous client, meaning that all calls are blocking. Generators that access endpoints that stream indefinitely (such as the endpoint to scan for new entries) therefore should not be iterated over using for without a timeout, as they will never end and cannot be interrupted without user intervention.

An asynchronous client, AttoClientAsync(), is in the works. This client would facilitate near-instant updating of UI elements representing balances and lists of new entries, and would be able to wait for transactions to be confirmed, all without blocking the main thread.

Currently, AttoClient() supports some of the GET methods provided by the node API, and none of the POST methods. This means that AttoClient() can only query nodes, and can’t post transactions. This will change once a testing framework has been set up.

All classes and members should be fully documented soon.