Skip to content

Latest commit

 

History

History
137 lines (105 loc) · 3.68 KB

README.md

File metadata and controls

137 lines (105 loc) · 3.68 KB
Raw

abieos-python

PyPI version codecov Python package

Python bindings for abieos library. Implements Binary <> JSON conversion of EOS action data using ABIs.

Building

Prerequisites

abieos C++ library depends on a recent version of CMake (>=3.11) and GCC8. Please make sure these are available in your system.

Statically linked

This is the most comfortable to use, as we can just package the library as a wheel file and ship it. Patch to CMakeLists.txt is required to be able to build abieos as a static library.

First you need to build abieos library itself:

$ git submodule update --init-recursive
$ mkdir external/abieos/build
$ cd external/abieos/build
$ cmake ..
$ make

Then you can simply build the package using setuptools.

$ python setup.py build --static

Dynamically linked

If you really want to dynamically link the bindings to the version of abieos installed on your system, you also can. At the time of writing these instructions (24.02.2020), EOSIO does not release a binary packages for any OS nor even supports installing the built library using make command. Assuming you've built the library and copied it manually into correct paths, you can simply build the bindings using setuptools.

$ python setup.py build

Running tests

When running tests you can run into problems because a version without C extensions will be used. As a workaround, you can copy the built file to abieos/:

cp build/lib.*/abieos/_private* abieos  # workaround
flake8
mypy
pytest

Usage

If you're running Python on Linux or macOS, you can skip building and use a wheel instead.

$ pip install abieos-python

It is recommended to use EosAbiSerializer class if possible, but if your use case requires access the original abieos API, it is available under abieos.private.

With ABI in binary format (bytes)

from abieos import EosAbiSerializer

s = EosAbiSerializer()
s.set_abi_from_bin('eosio.token', abi)

With ABI in hex format (str)

from abieos import EosAbiSerializer

s = EosAbiSerializer()
s.set_abi_from_hex('eosio.token', abi)

With ABI in JSON format (dict)

from abieos import EosAbiSerializer

s = EosAbiSerializer()
s.set_abi_from_json('eosio.token', abi)

dict -> bytes

s.json_to_bin(
    'eosio.token',
    s.get_type_for_action('eosio.token', 'transfer'),
    {
        'from': 'useraaaaaaaa',
        'to': 'useraaaaaaab',
        'quantity': '0.0001 SYS',
        'memo': '',
    }
)

dict -> hex string

s.json_to_hex(
    'eosio.token',
    s.get_type_for_action('eosio.token', 'transfer'),
    {
        'from': 'useraaaaaaaa',
        'to': 'useraaaaaaab',
        'quantity': '0.0001 SYS',
        'memo': '',
    }
)

bytes -> dict

s.bin_to_json(
    'eosio.token',
    s.get_type_for_action('eosio.token', 'transfer'),
    b'`\x8c1\xc6\x18s\x15\xd6p\x8c1\xc6\x18s\x15\xd6\x01\x00\x00\x00\x00'
    b'\x00\x00\x00\x04SYS\x00\x00\x00\x00\x00'
)

hex string -> dict

s.hex_to_json(
    'eosio.token',
    s.get_type_for_action('eosio.token', 'transfer'),
    '608C31C6187315D6708C31C6187315D60100000000000000045359530000000000'
)

With custom JSON encoder/decoder

from abieos import EosAbiSerializer

s = EosAbiSerializer(loads=simplejson.loads, dumps=simplejson.dumps)