robonomics-interface 0.10.0

Robonomics wrapper over https://github.com/polkascan/py-substrate-interface created to facilitate programming with Robonomics

robonomics-interface

This is a simple wrapper over https://github.com/polkascan/py-substrate-interface used to facilitate writing code for applications using Robonomics.

Robonomics project: https://robonomics.network/

Robonomics parachain dapp: https://parachain.robonomics.network/

---

Installation

pip3 install robonomics-interface

Usage

More info may be found in docstrings in the source code

import robonomicsinterface as RI

Initialization

interface = RI.RobonomicsInterface()

By default, you will only be able to fetch Chainstate info from Frontier parachain and use PubSub pattern.

You can specify another node address (e.g. local), seed to sign extrinsics (more on that later) and custom registry types.

Address of the device may be obtained using define_address method. If the interface was initialed with a seed/private key this method will return <ss58_addr> of the device whose seed/private key was passed.

Simple case: fetch Chainstate

Here, no need to pass any arguments, by

interface = RI.RobonomicsInterface()

you will be able to read any Chainstate info from the Frontier parachain:

num_dt = interface.custom_chainstate("DigitalTwin", "Total")

you can also specify an argument for the query. Several arguments should be put in a list. Block hash parameter is also available via block_hash argument if you want to make a query as of a specified block.

There is a dedicated function to obtain Datalog:

record = interface.fetch_datalog(<ss58_addr>)

This will give you the latest datalog record of the specified account with its timestamp. You may pass an index argument to fetch specific record. If you create an interface with a provided seed, you'll be able to fetch self-datalog calling fetch_datalog with no arguments (or just the index argument).

Another dedicated function is for Account information:

account_info = interface.account_info(<ss58_addr>)

This will return account information of the specified address. If an interface was created with a seed passed seed, you'll be able to get self-account info calling account_info with no arguments.

Extrinsics

Providing seed (any raw or mnemonic) while initializing will let you create and submit extrinsics:

interface = RI.RobonmicsInterface(seed:str = <seed>)
hash = interface.custom_extrinsic("DigitalTwin", "create")

hash here is the transaction hash of the succeeded extrinsic. You can also specify arguments for the extrinsic as a dictionary.

There are dedicated functions for recording datalog, sending launch commands and sending tokens:

interface.record_datalog("Hello, Robonomics")
interface.send_launch(<target_addr>, "Qmc5gCcjYypU7y28oCALwfSvxCBskLuPKWpK4qpterKC7z")
interface.send_tokens(<target_addr>, <number_of_tokens>)

Current nonce definition and manual nonce setting is also possible.

Subscriptions

There is a subscriptions functional implemented. When initiated, blocks thread and processes new events with a user-passed callback function. Pay attention that this callback may only accept one argument - the event data. Up to now, the only supported events are NewRecord, NewLaunch, Transfer

from robonomicsinterface import RobonomicsInterface, Subscriber, SubEvent

def callback(data):
    print(data)

interface = RobonomicsInterface()
subscriber = Subscriber(interface, SubEvent.NewLaunch, callback, <ss58_addr>)

One may also pass a list of addresses.

Digital Twins

Digital Twins functionality is also supported.

dt_it, tr_hash = interface.dt_create()
topic_hashed, source_tr_hash = interface.dt_set_source(dt_id, <topic_name>, <ss58_source_addr>)
interface.dt_info(dt_id)
interface.dt_owner(dt_id)
interface.dt_total()

One may also find topic source by

interface.dt_get_source(dt_id, <topic_name>)

Liabilities

This package support Robonomics liability functionality. Here is a bit about the concept on Ethereum. It's slightly different in Substrate.

With this package one can create liabilities, sign technical parameters messages, report completed liabilities, sign report messages, fetch information about current and completed liabilities:

promisee = RobonomicsInterface(remote_ws="ws://127.0.0.1:9944", seed="<seed>")
promisor = RobonomicsInterface(remote_ws="ws://127.0.0.1:9944", seed="<seed>")

task = "QmYA2fn8cMbVWo4v95RwcwJVyQsNtnEwHerfWR8UNtEwoE" # task parsing is on user side
reward = 10 * 10 ** 9
promisee = promisee.define_address()
promisor = promisor.define_address()

promisee_task_signature = promisee.sign_create_liability(task, reward)
promisor_task_signature = promisor.sign_create_liability(task, reward)

index, tr_hash = promisee.create_liability(
    task, reward, promisee, promisor, promisee_task_signature, promisor_task_signature
)

print(index)
print(promisee.liability_info(index))

report = "Qmc5gCcjYypU7y28oCALwfSvxCBskLuPKWpK4qpterKC7z" # report parsing is on user side
promisor.finalize_liability(index, report) # this one signs report message automatically if no signature provided
print(promisor.liability_report(index))

More information and functionality may be found in the code.

Robonomics Web Services (RWS)

There are as well dedicated methods for convenient usage of RWS.

• Chainstate functions auctionQueue, auction, devices to examine subscriptions auctions:

interface.rws_auction_queue()
inteface.rws_auction(<auction_index>)
interface.rws_list_devices(<subscription_owner_addr>)

• Extrinsincs: bid, set_devices and, the most important, call

interface.rws_bid(<auction_index>, <amount_weiners>)
interface.rws_set_devices([<ss58_addr>, <ss58_addr>])
interface.rws_custom_call(<subscription_owner_addr>,
                           <call_module>,
                           <call_function>,
                           <params_dict>)

There are as well dedicated datalog, launch and [DigitalTwin](#Digital Twins) functions for RWS-based transactions.

interface.rws_record_datalog(<subscription_owner_addr>, <data>)
interface.rws_send_launch(<subscription_owner_addr>, <target_addr>, True)
interface.rws_dt_create(<subscription_owner_addr>)
interface.rws_dt_set_source(<subscription_owner_addr>, dt_id, <topic_name>, <ss58_source_addr>)

IO

This package provides console prototyping tool such as robonomics io with slight differences:

$ robonomics_interface read datalog
$ echo "Hello, Robonomics" | robonomics_interface write datalog -s <seed>
$ robonomics_interface read launch
$ echo "ON" | robonomics_interface write launch -s <seed> -r <target_addr>

More info may be found with

$ robonomics_interface --help

JSON RPC

WARNING: THIS MODULE IS UNDER CONSTRUCTIONS, USE AT YOUR OWN RISK! TO BE UPDATED SOON.
There is a way to implement robonomics pubsub rpc calls:

interface = RI.RobonomicsInterface()
pubsub = PubSub(interface)
pubsub.peer()

This is an evolving package, it may have errors and lack of functionality, fixes are coming. Feel free to open issues when faced a problem.