Skip to content
Python facilitation wrapper to embed Zenroom
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs
zenroom
.gitignore
LICENSE
README.md
setup.cfg
setup.py

README.md


Zenroom
zenroom.py
A python wrapper for Zenroom


This library attempts to provide a very simple wrapper around the Zenroom (https://zenroom.dyne.org/) crypto virtual machine developed as part of the DECODE project (https://decodeproject.eu/), that aims to make the Zenroom virtual machine easier to call from normal Python code.

This library has been developed for a specific deliverable within the project, and as such will likely not be suitable for most people's needs. Here we directly include a binary build of Zenroom compiled only for Linux (amd64), so any other platforms will be unable to use this library. This library has also only been tested under Python 3.

Zenroom itself does have good cross platform functionality, so if you are interested in finding out more about the functionalities offered by Zenroom, then please visit the website linked to above to find out more.

🚩 Table of Contents (click to expand)

💾 Installation

pip install zenroom

NOTE - the above command attempts to install the zenroom package, pulling in the Zenroom VM as a precompiled binary, so will only work on Linux (amd64) machines.


🎮 Usage

Two main calls are exposed, one to run zencode and one for zenroom scripts.

If you don't know what zencode is, you can start with this blogpost https://decodeproject.eu/blog/smart-contracts-english-speaker

A good set of examples of zencode contracts could be found here https://github.com/DECODEproject/dddc-pilot-contracts

ZENCODE

Here a quick usage example:

from zenroom import zenroom

contract = """Scenario 'coconut': "To run over the mobile wallet the first time and store the output as keypair.keys"
Given that I am known as 'identifier'
When I create my new keypair
Then print all data
    """

result, errors = zenroom.zencode(contract)
print(result.decode())

NOTE The result is in bytes and not string if you want a string you want to .decode() it

The zencode function accepts the following:

  • script (str): Required byte string or string containing script which Zenroom will execute
  • keys (str): Optional byte string or string containing keys which Zenroom will use
  • data (str): Optional byte string or string containing data upon which Zenroom will operate
  • conf (str): Optional byte string or string containing conf data for Zenroom
  • verbosity (int): Optional int which controls Zenroom's log verbosity ranging from 1 (least verbose) up to 3 (most verbose)

Returns

  • tuple: The output from Zenroom expressed as a byte string, the eventual errors generated as a string

ZENROOM SCRIPTS

from zenroom import zenroom

script = "print('Hello world')"
output, errors = zenroom.execute(script)

The same arguments and the same result are applied as the zencode call.


📋 Testing

Tests are made wuth pytests, just run

python setup.py test


🌐 Links

https://decodeproject.eu/

https://zenroom.dyne.org/

You can’t perform that action at this time.