Querying Gateway

digital-world-py-sdk gives you access to all the endpoints exposed by Gateway.

Building requests

digital-world-py-sdk uses the Builder pattern to create the requests to send to Gateway. Starting with a GatewayServer object, you can chain methods together to generate a query. (See the Gateway reference documentation for what methods are possible.)

"""
See: https://digital-world-sdk.docs.digitalworld.global/en/latest/querying_gateway.html#building-requests
"""

from digital_world_sdk import GatewayServer

server = GatewayServer(gateway_url="https://dex.digitalworld.global")
account = "GB6NVEN5HSUBKMYCE5ZOWSK5K23TBWRUQLZY3KNMXUZ3AQ2ESC4MY4AQ"

# get a list of transactions that occurred in ledger 1400
transactions = server.transactions().for_ledger(1400).call()
print(transactions)

# get a list of transactions submitted by a particular account
transactions = server.transactions().for_account(account_id=account).call()
print(transactions)

# The following example will show you how to handle paging
print(f"Gets all payment operations associated with {account}.")
payments_records = []
payments_call_builder = (
    server.payments().for_account(account).order(desc=False).limit(10)
)  # limit can be set to a maximum of 200
payments_records += payments_call_builder.call()["_embedded"]["records"]
page_count = 0
while page_records := payments_call_builder.next()["_embedded"]["records"]:
    payments_records += page_records
    print(f"Page {page_count} fetched")
    print(f"data: {page_records}")
    page_count += 1
print(f"Payments count: {len(payments_records)}")

Once the request is built, it can be invoked with call() or with stream(). call() will return the response given by Gateway.

Streaming requests

Many requests can be invoked with stream(). Instead of returning a result like call() does, stream() will return an EventSource. Gateway will start sending responses from either the beginning of time or from the point specified with cursor(). (See the Gateway reference documentation to learn which endpoints support streaming.)

For example, to log instances of transactions from a particular account:

"""
See: https://digital-world-sdk.docs.digitalworld.global/en/latest/querying_gateway.html#streaming-requests
"""

from digital_world_sdk import GatewayServer

server = GatewayServer(gateway_url="https://dex-testnet.digitalworld.global")
account_id = "GASOCNHNNLYFNMDJYQ3XFMI7BYHIOCFW3GJEOWRPEGK2TDPGTG2E5EDW"
last_cursor = "now"  # or load where you left off


def tx_handler(tx_response):
    print(tx_response)


for tx in server.transactions().for_account(account_id).cursor(last_cursor).stream():
    tx_handler(tx)