Zenroom for Python: Bindings of Zenroom library for Python.
Project description
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 crypto virtual machine developed as part of the DECODE project, 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
[!NOTE] The
zenroom
package is just a wrapper around thezencode-exec
utility. You also need to installzencode-exec
, you can download if from the official releases on github. After downloading it, you have to move it somewhere in your path, like/usr/local/bin/
** Linux **
# install zenroom wrapper
pip install zenroom
# install zencode-exec and copy it into PATH
wget https://github.com/dyne/zenroom/releases/latest/download/zencode-exec
chmod +x zencode-exec
sudo cp zencode-exec /usr/local/bin/
** MacOS **
[!WARNING] On Mac OS, the executable is
zencode-exec.command
and you have to symlink it tozencode-exec
# install zenroom wrapper
pip install zenroom
# install zencode-exec and copy it into PATH
wget https://github.com/dyne/zenroom/releases/latest/download/zencode-exec.command
chmod +x zencode-exec.command
sudo cp zencode-exec.command /usr/local/bin/
sudo ln -s /usr/local/bin/zencode-exec.command /usr/local/bin/zencode-exec
** Windows **
[!WARNING] On Windows, the executable is
zencode-exec.exe
, and you need to place it in a directory listed in yourPATH
environment variable.
Open PowerShell (press 🪟 + r, type powershell and press enter), then:
# Install zenroom wrapper
pip install zenroom
# Download zencode-exec and move it to a directory in PATH
Invoke-WebRequest -Uri "https://github.com/dyne/zenroom/releases/latest/download/zencode-exec.exe" -OutFile "zencode-exec.exe"
# Move the executable to a directory in PATH (e.g., C:\Windows or another suitable directory)
Move-Item -Path "zencode-exec.exe" -Destination "C:\Windows\" -Force
🎮 Usage
If you don't know what zencode
is, you can start with the official documentation.
The wrapper exposes one simple calls: zencode_exec
args
script
string the zencode script to be executedconf
string the optional conf string to pass according to zenroom configkeys
string the optional keys string to pass in execution as documented in zenroom docsdata
string the optional data string to pass in execution as documented in zenroom docs
return
output
string holds the stdout of the script executionlogs
string holds the stderr of the script executionresult
(dictionary or None) holds the JSON parsed output if output contains valid JSON, otherwise it is None.
Examples
Example usage of zencode_exec(script, keys=None, data=None, conf=None)
from zenroom import zenroom
contract = """Scenario ecdh: Create a ecdh key
Given that I am known as 'Alice'
When I create the ecdh key
Then print the 'keyring'
"""
result = zenroom.zencode_exec(contract)
print(result.output)
Next, we show a more complex example involving an ethereum signature
from zenroom import zenroom
import json
conf = ""
keys = {
"participant": {
"keyring": {
"ethereum": "6b4f32fc48ff19f0c184f1b7c593fbe26633421798191931c210a3a9bb46ae22"
}
}
}
data = {
"myString": "I love the Beatles, all but 3",
"participant ethereum address": "0x2B8070975AF995Ef7eb949AE28ee7706B9039504"
}
contract = """Scenario ethereum: sign ethereum message
# Here we are loading the private key and the message to be signed
Given I am 'participant'
Given I have my 'keyring'
Given I have a 'string' named 'myString'
Given I have a 'ethereum address' named 'participant ethereum address'
# Here we are creating the signature according to EIP712
When I create the ethereum signature of 'myString'
When I rename the 'ethereum signature' to 'myString.ethereum-signature'
# Here we copy the signature, which we'll print in a different format
When I copy 'myString.ethereum-signature' to 'myString.ethereum-signature.rsv'
# Here we print the signature in the regular 65 bytes long 'signaure hash' format
When I create ethereum address from ethereum signature 'myString.ethereum-signature' of 'myString'
When I copy 'ethereum address' to 'newEthereumAddress'
If I verify 'newEthereumAddress' is equal to 'participant ethereum address'
Then print string 'all good, the recovered ethereum address matches the original one'
Endif
Then print the 'myString.ethereum-signature'
Then print the 'newEthereumAddress'
# Here we print the copy of the signature in the [r,s,v], simply printing it as 'hex'
Then print the 'myString.ethereum-signature.rsv' as 'hex'
"""
result = zenroom.zencode_exec(contract, conf, json.dumps(keys), json.dumps(data))
print(result.output)
📋 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-2025 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-2025 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/>.
Project details
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-5.10.2.tar.gz
.
File metadata
- Download URL: zenroom-5.10.2.tar.gz
- Upload date:
- Size: 7.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.12.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5d9f2710d7d4cb4cb9a89ba141ce77863b819426caecdb5b24fb814092719d00 |
|
MD5 | 629ac4473e648789e504329f36bfab44 |
|
BLAKE2b-256 | 1ab1693372111d841a5881bb111e9b53938359761d9c5f47b9dca84e7dcbf37c |