@digicatapult/sqnc-process-management 2.2.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright © 2017 Digital Catapult
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,213 @@
+# sqnc-process-management
+
+A Library for managing restricted process flows in the `Sequence` (SQNC) ledger-based system.
+
+## Getting started
+
+For the basic application to work and for locally run tests to work `docker-compose up` must be run.
+
+The build command should be run first to create the converted ts files.
+
+```shell
+npm run build
+```
+
+To start the basic application
+
+```shell
+npm run local
+```
+
+To install npm CLI tool. It will be linked to local binaries so can be executed as `process-management`
+
+```shell
+npm i -g
+```
+
+## using CLI
+
+```sh
+process-management help
+```
+
+### Options
+
+`sqnc-process-management` takes the following arguments to configure the `Polkadot.js` API connection:
+
+| variable | required |   default   | description                                                                                                           |
+| :------- | :------: | :---------: | :-------------------------------------------------------------------------------------------------------------------- |
+| `host`   |    N     | `localhost` | The hostname of the `sqnc-node` the API should connect to                                                             |
+| `port`   |    N     |   `9944`    | The port of the `sqnc-node` the API should connect to                                                                 |
+| `user`   |    Y     |      -      | The Substrate `URI` representing the private key to use when making `sqnc-node` transactions. `//Alice` for dev chain |
+
+For the full list of available restrictions see [`sqnc-node`](https://github.com/digicatapult/sqnc-node/blob/main/pallets/process-validation/src/restrictions.rs)
+
+### Help
+
+Returns all available commands
+
+```sh
+$ process-management
+Usage: process management [options] [command]
+
+a command line interface for managing chain processes
+
+Options:
+  -v, --version                     output current version
+  --help                            display help for command
+
+Commands:
+  list [options]                    A command for listing all active process flows
+  create [options] <json>           A command for persisting process flows onto the chain
+  disable [options] <id> <version>  A command for disabling an existing process flows. Required process ID and version
+  help [command]                    display help for command
+```
+
+### Create Process Command
+
+```sh
+$ process-management help create
+Usage: process management create [options] <json>
+
+A command for persisting process flows onto the chain
+
+Options:
+  --dryRun           to validate process and response locally before persisting on the chain, default - false
+  --verbose          Returns all information about the transation, default - false
+  -h, --host <host>  substrate blockchain host address or FQDM, default - "localhost" (default: "localhost")
+  -p, --port <port>  specify host port number if it is not a default, default - 9944 (default: "9944")
+  -f, --file <file>  path to file containing process flows to loads
+  -u, --user <user>  specify substrate blockchain user URI
+  --help             display help for command
+
+#
+# example
+#
+
+$ process-management create -h localhost -p 9944 -u //Alice '[{"name":"A test","version":1,"program":[{"restriction":{"FixedNumberOfOutputs":{"numOutputs":1}}},{"restriction":{"None":{}}},{"op":"Or"}]}]'
+
+{
+  'A test': {
+    message: 'Transaction for new process A test has been successfully submitted',
+    process: {
+      id: 'A test',
+      version: 1,
+      status: 'Enabled',
+      program: [
+        { restriction: { FixedNumberOfOutputs: { numOutputs: 1 } } },
+        { restriction: { None: {} } },
+        { op: 'Or' }
+      ]
+    }
+  }
+}
+```
+
+Or use a `.json` file
+
+```
+process-management create -h localhost -p 9944 -u //Alice "$(cat exampleProcess.json)"
+```
+
+### Disable Process Command
+
+```sh
+$ process-management help disable
+Usage: process management disable [options] <id> <version>
+
+A command for disabling an existing process flows. Required process ID and version
+
+Arguments:
+  id                 a valid process id that you would like to disable
+  version            a version number of a process
+
+Options:
+  --dryRun           to validate process and response locally before persisting on the chain, default - false
+  -h, --host <host>  substrate blockchain host address or FQDM, default - "localhost" (default: "localhost")
+  -p, --port <port>  specify host port number if it is not a default, default - 9944 (default: "9944")
+  --print            print debugging info
+  -u, --user <user>  specify substrate blockchain user URI
+  --help             display help for command
+
+#
+# example
+#
+
+# let's create so we have something to disable
+$ process-management create -u //Alice -f ./exampleProcess.json
+
+{
+  'B test': {
+    message: 'Transaction for new process B test has been successfully submitted',
+    process: {
+      id: 'B test',
+      version: 1,
+      status: 'Enabled',
+      program: [
+        { restriction: { FixedNumberOfOutputs: { numOutputs: 1 } } },
+        { restriction: { None: {} } },
+        { op: 'Or' }
+      ]
+    }
+  }
+}
+
+$ process-management disable -u //Alice 'B test' '1'
+
+{
+  message: 'Process has been disabled',
+  process: { id: 'B test', version: 1, status: 'Disabled' }
+}
+```
+
+### List Processes Command
+
+```sh
+$ process-management list --help
+Usage: process management list [options]
+
+A command for listing all active process flows
+
+Options:
+  -h, --host <host>  substrate blockchain host address or FQDM, default - "localhost" (default: "localhost")
+  -p, --port <port>  specify host port number if it is not a default, default - 9944 (default: "9944")
+  --raw              print processes with hex values and extra keys such as "createdAtHash"
+  --active           returns only active process flows
+  --disabled         returns only disabled process flows
+  --print            print debugging info
+  --help             display help for command
+
+#
+# example
+#
+
+$ process-management list --active
+[
+  {
+    id: 'default',
+    version: 1,
+    status: 'Enabled',
+    program: [ { restriction: { none: null } } ]
+  }
+]
+```
+
+## Running tests
+
+Unit tests can be run without docker using:
+
+```shell
+npm run test:unit
+```
+
+To run the integration test suite first bring up the test dependency services using docker
+
+```shell
+docker compose -f ./docker-compose-test.yaml up -d
+```
+
+And then to run the tests
+
+```shell
+npm run test
+```

package/build/package.json

@@ -0,0 +1,64 @@
+{
+    "name": "@digicatapult/sqnc-process-management",
+    "version": "2.2.0",
+    "description": "SQNC Process Management Flow",
+    "main": "./lib/index.js",
+    "bin": {
+        "process-management": "./build/src/index.js"
+    },
+    "type": "module",
+    "scripts": {
+        "start": "node --loader ts-node/esm src/index.ts",
+        "local": "npm i -g && process-management",
+        "dev": "nodemon --watch 'src/**/*.ts' --exec node --loader ts-node/esm src/index.ts",
+        "lint": "eslint . --ext .ts",
+        "build": "tsc --build",
+        "depcheck": "depcheck",
+        "test": "ts-mocha --config ./tests/mocharc.json -n  loader=ts-node/esm -p tsconfig.json tests/**/*.test.ts --exit",
+        "test:unit": "ts-mocha --config ./tests/mocharc.json -n loader=ts-node/esm -p tsconfig.json src/**/*.test.ts --exit",
+        "prettier": "npx prettier --write ."
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/digicatapult/sqnc-process-management.git"
+    },
+    "files": [
+        "/build"
+    ],
+    "engines": {
+        "node": ">=20.x.x",
+        "npm": ">=10.x.x"
+    },
+    "author": "Digital Catapult",
+    "license": "Apache-2.0",
+    "bugs": {
+        "url": "https://github.com/digicatapult/sqnc-process-management/issues"
+    },
+    "homepage": "https://github.com/digicatapult/sqnc-process-management#readme",
+    "devDependencies": {
+        "@types/chai": "^4.3.11",
+        "@types/chai-as-promised": "^7.1.8",
+        "@types/mocha": "^10.0.6",
+        "@types/node": "^18.19.4",
+        "@typescript-eslint/eslint-plugin": "^6.17.0",
+        "@typescript-eslint/parser": "^6.17.0",
+        "chai": "^4.3.10",
+        "chai-as-promised": "^7.1.1",
+        "depcheck": "^1.4.7",
+        "eslint": "^8.56.0",
+        "eslint-config-prettier": "^9.1.0",
+        "eslint-plugin-prettier": "^5.1.2",
+        "mocha": "^10.2.0",
+        "nodemon": "^3.0.2",
+        "prettier": "^3.1.1",
+        "ts-mocha": "^10.0.0",
+        "ts-node": "^10.9.2"
+    },
+    "dependencies": {
+        "@polkadot/api": "^10.11.2",
+        "chalk": "^5.3.0",
+        "commander": "^11.1.0",
+        "typescript": "^5.3.3",
+        "zod": "^3.22.4"
+    }
+}

package/build/src/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env -S node --no-warnings
+export {};

package/build/src/index.js

@@ -0,0 +1,127 @@
+#!/usr/bin/env -S node --no-warnings
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import fs from 'fs/promises';
+import chalk from 'chalk';
+import { Command } from 'commander';
+import { loadProcesses, disableProcess, listTransforming } from './lib/process/index.js';
+import { getAll } from './lib/process/api.js';
+import cliVersion from './version.js';
+const unwrap = (res) => {
+    if (res.type === 'ok')
+        return res.result;
+    else
+        throw res.error;
+};
+const { log, dir } = console;
+const program = new Command();
+const { red: r, blue: b } = {
+    red: (txt) => chalk.redBright(txt),
+    blue: (txt) => chalk.blueBright(txt),
+};
+const mapOptions = (options) => ({
+    API_HOST: options.host,
+    API_PORT: parseInt(options.port),
+    USER_URI: options.user,
+});
+// TODO nice to have, a local config file for substrate host details e.g. name, port, address
+// so no need to parse every time calling a command, or ability to set
+program
+    .name('process management')
+    .description('a command line interface for managing chain processes')
+    .version(cliVersion, '-v, --version', 'output current version')
+    .helpOption('--help', 'display help for command'); //override -h
+program
+    .command('list')
+    .description('A command for listing all active process flows')
+    .option('-v, --verbose', 'Returns all information about the transation, default - false')
+    .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
+    .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
+    .option('--raw', 'print processes with hex values and extra keys such as "createdAtHash"')
+    .option('--active', 'returns only active process flows')
+    .option('--disabled', 'returns only disabled process flows')
+    .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (options.print)
+        log(`
+      retrieving all process flows from a chain...
+      options: ${b(JSON.stringify(options))}
+    `);
+    try {
+        const res = yield getAll(mapOptions(options));
+        const transformed = listTransforming(res, options);
+        dir(transformed, { depth: null });
+        process.exit(0);
+    }
+    catch (err) {
+        log(err);
+        process.exit(1);
+    }
+}));
+program
+    .command('create')
+    .description('A command for persisting process flows onto the chain')
+    .option('--dryRun', 'to validate process and response locally before persisting on the chain, default - false')
+    .option('--verbose', 'Returns all information about the transation, default - false')
+    .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
+    .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
+    .requiredOption('-f, --file <file>', 'path to file containing process flows to loads')
+    .requiredOption('-u, --user <user>', 'specify substrate blockchain user URI')
+    .action((options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (options.print)
+        log(`
+      attempting to create a process...
+      options: ${b(JSON.stringify(options))}
+    `);
+    const { dryRun, verbose } = options;
+    try {
+        const data = (yield fs.readFile(options.file)).toString('utf8');
+        const loadResult = yield loadProcesses({ data, dryRun, options: mapOptions(options), verbose });
+        dir(loadResult.message, { depth: null });
+        dir(unwrap(loadResult), { depth: null });
+        process.exit(0);
+    }
+    catch (err) {
+        log(err);
+        process.exit(1);
+    }
+}));
+program
+    .command('disable')
+    .description('A command for disabling an existing process flows. Required process ID and version')
+    .option('--dryRun', 'to validate process and response locally before persisting on the chain, default - false')
+    .option('-h, --host <host>', 'substrate blockchain host address or FQDM, default - "localhost"', 'localhost')
+    .option('-p, --port <port>', 'specify host port number if it is not a default, default - 9944', '9944')
+    .requiredOption('-u, --user <user>', 'specify substrate blockchain user URI')
+    .argument('<id>', 'a valid process id that you would like to disable')
+    .argument('<version>', 'a version number of a process')
+    .action((id, version, options) => __awaiter(void 0, void 0, void 0, function* () {
+    if (options.print)
+        log(`attempting to disable:\nID:${b(id)}\nVersion:${b(version)}`);
+    try {
+        const { dryRun } = options;
+        const res = unwrap(yield disableProcess(id, parseInt(version), dryRun, mapOptions(options)));
+        dir(res, { depth: null });
+        process.exit(0);
+    }
+    catch (err) {
+        log(err);
+        process.exit(1);
+    }
+}));
+program.parse();
+if (!program.option) {
+    program.help();
+}
+program.on('command:*', function () {
+    log(`
+    ${r('Invalid command: %s\nSee --help for a list of available commands.')}
+    ${program.args.join(' ')}`);
+    process.exit(127);
+});

package/build/src/lib/process/_tests_/unit.test.d.ts

@@ -0,0 +1 @@
+export {};