Zenroom for Python: Bindings of Zenroom library for Python.
Project description
Use Zenroom in Python3
zenroom.py 🐍
A Python3 wrapper of Zenroom, a secure and small virtual machine for crypto language processing
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.
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.
💾 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 and macOS machines.
for the edge (syn to the latest commit on master) version please run:
pip install zenroom --pre
The zenroom package is just a wrapper around the zencode-exec utility.
You also need to install zencode-exec, you can download if from the official releases on github
When after downloading you have to move it somewhere in your path:
sudo cp zencode-exec /usr/local/bin/
Warning: on Mac OS, the executable is zencode-exec.command and you have to symlink it to zencode-exec
sudo cp zencode-exec.command /usr/local/bin/
cd /usr/local/bin
sudo ln -s zencode-exec.command zencode-exec
🎮 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
The official documentation is available on https://dev.zenroom.org/zencode/
A good set of examples of zencode contracts could be found on
🐍 Python wrapper
the wrapper exposes two simple calls:
zenroom_execzencode_exec
as the names suggest are the two methods to execute zenroom (lua scripts) and zencode.
args
Both functions accept the same arguments:
scriptstring the lua script or the zencode script to be executedkeysstring the optional keys string to pass in execution as documented in zenroom docs heredatastring the optional data string to pass in execution as documented in zenroom docs hereconfstring the optional conf string to pass according to zen_config here
return
Both functions return the same object result ZenResult that have two attributes:
stdoutstring holds the stdout of the script executionstderrstring holds the stderr of the script execution
Examples
Example usage of zencode_exec(script, keys=None, data=None, conf=None)
from zenroom import zenroom
contract = """Scenario ecdh: Create a keypair"
Given that I am known as 'identifier'
When I create the keypair
Then print my data
"""
result = zenroom.zencode_exec(contract)
print(result.output)
Example usage of zenroom_exec(script, keys=None, data=None, conf=None)
from zenroom import zenroom
script = "print('Hello world')"
result = zenroom.zenroom_exec(script)
print(result.output)
The same arguments and the same result are applied as the zencode_exec call.
📋 Testing
Tests are made with pytests, just run
python setup.py test
in zenroom_test.py file you'll find more usage examples of the wrapper
🌐 Links
😍 Acknowledgements
Copyright (C) 2018-2022 by Dyne.org foundation, Amsterdam
Originally designed and written by Sam Mulube.
Designed, written and maintained by Puria Nafisi Azizi
Rewritten by Danilo Spinella and David Dashyan
This project is receiving funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement nr. 732546 (DECODE).
👥 Contributing
Please first take a look at the Dyne.org - Contributor License Agreement then
- 🔀 FORK IT
- Create your feature branch
git checkout -b feature/branch - Commit your changes
git commit -am 'Add some fooBar' - Push to the branch
git push origin feature/branch - Create a new Pull Request
gh pr create -f - 🙏 Thank you
💼 License
Zenroom.py - a python wrapper of zenroom
Copyright (c) 2018-2022 Dyne.org foundation, Amsterdam
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.
You should have received a copy of the GNU Affero General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file zenroom-3.20.0.tar.gz.
File metadata
- Download URL: zenroom-3.20.0.tar.gz
- Upload date:
- Size: 6.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.5
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3760a6c66662056cdbfaa89f8f4b2e7eb61d5ea87cd7d93bcecf467ad467f722 |
|
| MD5 | 75a858149bdbc14c4e2c37dd388db5a1 |
|
| BLAKE2b-256 | 89a0536c57da5b1af308fd6718f77d547dbaac5cff5c8c5f37e4c03f74b68102 |
