# Zenroom js bindings 🧰 ### Zenroom js bindings provides a javascript wrapper of Zenroom, a secure and small virtual machine for crypto language processing.

---

## 💾 Install Stable releases are published on https://www.npmjs.com/package/zenroom that have a slow pace release schedule that you can install with ```bash npm install zenroom # or using yarn yarn add zenroom # or using pnpm pnpm add zenroom # or using bun bun add zenroom ``` --- ## 🎮 Usage The bindings are composed of two main functions: - **zencode_exec** to execute [Zencode](https://dev.zenroom.org/#/pages/zencode-intro?id=smart-contracts-in-human-language). To learn more about zencode syntax look [here](https://dev.zenroom.org/#/pages/zencode-cookbook-intro) - **zenroom_exec** to execute our special flavor of Lua enhanced with Zenroom's [special effects](https://dev.zenroom.org/#/pages/lua) Both of this functions accepts a mandatory **SCRIPT** to be executed and some optional parameters: - DATA - KEYS - EXTRA - CONTEXT - [CONF](https://dev.zenroom.org/#/pages/zenroom-config) **All in form of strings.** This means that if you want to pass a JSON you have to `JSON.stringify` it before. Both functions return a [Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise). To start using the zenroom vm just ```js import { zenroom_exec, zencode_exec, introspection } from "zenroom"; // or if you don't use >ES6 // const { zenroom_exec, zencode_exec } = require('zenroom') // Zencode: generate a random array. This script takes no extra input const zencodeRandom = ` Given nothing When I create the random array with '16' elements each of '32' bits Then print all data `; zencode_exec(zencodeRandom) .then((result) => { console.log(result); }) .catch((error) => { console.error(error); }); // Zencode: encrypt a message. // This script takes the options' object as the second parameter: you can include data and/or keys as input. // The "config" parameter is also optional. const zencodeEncrypt = ` Scenario 'ecdh': Encrypt a message with the password Given that I have a 'string' named 'password' Given that I have a 'string' named 'message' Given that I have a 'string' named 'extra' When I append 'extra' to 'message' When I encrypt the secret message 'message' with 'password' Then print the 'secret message'`; const zenKeys = ` { "password": "myVerySecretPassword" } `; const zenData = ` { "message": "HELLO WORLD" } `; const zenExtra = ` { "extra": "!!!" } `; zencode_exec(zencodeEncrypt, { data: zenData, keys: zenKeys, extra: zenExtra, conf: `debug=1`, }) .then((result) => { console.log(result); }) .catch((error) => { console.error(error); }); // Lua Hello World! const lua = `print("Hello World!")`; zenroom_exec(lua) .then((result) => { console.log(result); }) .catch((error) => { console.error(error); }); // to pass the optional parameters you pass an object literal eg. try { const result = await zenroom_exec(`print(DATA..KEYS..EXTRA..CONTEXT)`, { data: "Hello ", keys: "from ", extra: "Zenroom ", context: "developers", conf: `debug=1`, }); console.log(result); // => Hello from Zenroom developers } catch (e) { console.error(e); } // code inspection is done via the `zencode_valid_input` primitive function or by a utility `introspect` const introspection = await introspection( `Given I have a 'string' named 'missing' Then print the codec` ); console.log(introspection); // => an object described as https://dev.zenroom.org/#/pages/how-to-embed?id=input-validation ``` ## 😍 Acknowledgements Copyright (C) 2018-2026 by [Dyne.org](https://www.dyne.org) foundation, Amsterdam Designed, written and maintained by Puria Nafisi Azizi. Project funded by the European Commission

Project funded by the European Commission

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](CONTRIBUTING.md) then 1. [FORK IT](https://github.com/puria/zenroomjs/fork) 2. Create your feature branch `git checkout -b feature/branch` 3. Commit your changes `git commit -am 'Add some fooBar'` 4. Push to the branch `git push origin feature/branch` 5. Create a new Pull Request 6. Thank you --- ## 💼 License Zenroom js - a javascript wrapper of zenroom Copyright (c) 2018-2026 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 .