\n\nZenroom and zencode are part of the [DECODE project](https://decodeproject.eu) about data-ownership and [technological sovereignty](https://www.youtube.com/watch?v=RvBRbwBm_nQ). Our effort is that of improving people's awareness of how their data is processed by algorithms, as well facilitate the work of developers to create along [privacy by design principles](https://decodeproject.eu/publications/privacy-design-strategies-decode-architecture) using algorithms that can be deployed in any situation without any change.\n\n\n 🚩 Table of Contents (click to expand)\n\n- [💾 Install](#-install)\n- [🎮 Quick start](#-quick-start)\n - [Step definitions](#step-definitions)\n- [📋 Testing](#-testing)\n- [🐛 Troubleshooting \\& debugging](#-troubleshooting--debugging)\n- [😍 Acknowledgements](#-acknowledgements)\n- [🌐 Links](#-links)\n- [👤 Contributing](#-contributing)\n- [💼 License](#-license)\n\n\n---\n\n## 💾 Install\n\n`pnpm add @dyne/slangroom-chain`\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 🎮 Quick start\n\nIn many use-cases you want to chain execution of different slangroom and\npass the output as keys/data to other slangroom contracts.\nThis small library helps to achieve that by putting your slangroom in an\narray of steps.\n\nin the following example we define two steps and the result of the first\nis passed as `keys` to the second one.\n\n```js\nimport { execute } from '@dyne/slangroom-chain';\n\nconst newAccount = `{\"username\": \"Alice\"}`;\n\nconst steps_definition = `\n verbose: false\n steps: \n - id: 'step1'\n zencode: |\n Scenario ecdh: create the keyring at user creation\n Given that my name is in a 'string' named 'username'\n When I create the ecdh key\n Then print my 'keyring'\n data: ${newAccount}\n - id: 'step2'\n zencode: |\n Scenario 'ecdh': Create and publish public key\n Given that my name is in a 'string' named 'username'\n and I have my 'keyring'\n When I create the ecdh public key\n Then print my 'ecdh public key'\n data: ${newAccount}\n keysFromStep: 'step1'`;\n\nexecute(steps_definition).then((r) => console.log(r));\n```\n\n### Step definitions\n\nAs can be seen the `steps_definition` is written following the \n[yaml format](https://yaml.org/spec/1.2.2/). Internally these steps are\nconverted into a json format that is typed as follow:\n\n```typescript\ntype Steps = {\n readonly steps: readonly Step[]; // an array of step definitions\n readonly conf?: string; // zenroom configuration, could be overridden by each step\n readonly verbose?: boolean;\n};\n```\n\nThe single step definition is an object literal defined as follows:\n\n```typescript\ntype BasicStep = {\n readonly id: string;\n readonly data?: string;\n readonly dataFromStep?: string;\n readonly dataFromFile?: string;\n readonly dataTransform?: string;\n readonly keys?: string;\n readonly keysFromStep?: string;\n readonly keysFromFile?: string;\n readonly keysTransform?: string;\n readonly conf?: string;\n readonly onAfter?: {\n readonly run?: string;\n readonly jsFunction?: string;\n };\n readonly onBefore?: {\n readonly run?: string;\n readonly jsFunction?: string;\n };\n};\n\ntype Step =\n | (BasicStep & {\n readonly zencode: string;\n })\n | (BasicStep & {\n readonly zencodeFromFile: string;\n });\n```\n\nThe list of the attributes are:\n\n- **id** mandatory, a unique string to identify your step\n- **zencode** must be present if *zencodeFromFile* is not present, your slangroom to run\n- **zencodeFromFile** must be present if *zencode* is not present, the path to your slangroom contract to run\n- **data** optional, the data; when you want to pass it directly\n- **dataFromStep** optional, the step.id to get the result as input\n- **dataFromFile** optional, the path to the data file\n- **dataTransform** optional, a body of a js function that has `data` as input string and return a string,\n that will be executed on data just before the execution. This intended to be used\n to mangle your data with some transformation (eg. remove a key, or rename it)\n- **keys** optional, the keys; when you want to pass it directly\n- **keysFromStep** optional, the step.id to get the result as input\n- **keysFromFile** optional, the path to the keys file\n- **keysTransform** optional, a body of a js function that has `keys` as input string and return a string,\n that will be executed on keys just before the execution. This intended to be used\n to mangle your keys with some transformation (eg. remove an attribute, or rename it)\n- **conf** optional, the zenroom conf for the specific slangroom_exec (eg. 'rngseed=hex:...')\n overrides generic one\n- **onBefore** optional, can contains **jsFunction** or **run** attributes where:\n - **jsFunction** optional, the body of a js function that has `zencode, data, keys, conf` as input strings and return a nothing\n - **run** optional, a shell command to run\n \n This will be executed before the contract execution, it can not modify anything, but can be used to\n perform external operations (eg. do a call to an external API, send a email, etc) \n- **onAfter** optional, can contains **jsFunction** or **run** attributes where:\n - **jsFunction** optional, the body of a js function that has `result, zencode, data, keys, conf` as input strings and return a nothing\n - **run** optional, a shell command to run\n \n This will be executed after the contract execution, it can not modify anything, but can be used to\n perform external operations (eg. do a call to an external API, send a email, etc) \n\n**[🔝 back to top](#toc)**\n\n---\n\n## 📋 Testing\n\n`pnpm coverage`\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 🐛 Troubleshooting & debugging\n\nNo known issue by now\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 😍 Acknowledgements\n\n
\n\nCopyleft (ɔ) 2021 by [Dyne.org](https://www.dyne.org) foundation, Amsterdam\n\nDesigned, written and maintained by Puria Nafisi Azizi\nSlangroom added by Matteo Cristino\n\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 🌐 Links\n\nhttps://dev.zenroom.org/\n\nhttps://dyne.org/\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 👤 Contributing\n\nPlease first take a look at the [Dyne.org - Contributor License Agreement](CONTRIBUTING.md) then\n\n1. 🔀 [FORK IT](../../fork)\n2. Create your feature branch `git checkout -b feature/branch`\n3. Commit your changes `git commit -am 'Add some fooBar'`\n4. Push to the branch `git push origin feature/branch`\n5. Create a new Pull Request\n6. 🙏 Thank you\n\n**[🔝 back to top](#toc)**\n\n---\n\n## 💼 License\n\n @dyne/slangroom-chain - Execute chain of slangroom smart contracts\n Copyleft (ɔ) 2021-2024 Dyne.org foundation, Amsterdam\n\n This program is free software: you can redistribute it and/or modify\n it under the terms of the GNU Affero General Public License as\n published by the Free Software Foundation, either version 3 of the\n License, or (at your option) any later version.\n\n This program is distributed in the hope that it will be useful,\n but WITHOUT ANY WARRANTY; without even the implied warranty of\n MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n GNU Affero General Public License for more details.\n\n You should have received a copy of the GNU Affero General Public License\n along with this program. If not, see .\n\n**[🔝 back to top](#toc)**\n","readmeFilename":"README.md"}
![\"Dyne.org\"](\"https://img.shields.io/badge/%3C%2F%3E%20with%20%E2%9D%A4%20by-Dyne.org-blue.svg\"){kind=icon}
\n \n![\"Dyne.org\"](\"https://files.dyne.org/software_by_dyne.png\")
\n \n