@digicatapult/sqnc-process-management 2.2.0

package/build/src/lib/types/validation.js

@@ -0,0 +1,128 @@
+import { z } from 'zod';
+import { Constants } from '../process/constants.js';
+const tokenMetadataKey = z.string();
+const tokenId = z.number();
+const file = z.string();
+const metadataValue = z.union([
+    z.object({ File: file }),
+    z.object({ Literal: z.string() }),
+    z.object({ TokenId: tokenId }),
+    z.object({ None: z.null() }),
+]);
+const metadataValueType = z.enum(['File', 'Literal', 'TokenId', 'None']);
+const role = z.string();
+const binaryOperator = z.enum([
+    'Identity',
+    'TransferL',
+    'TransferR',
+    'NotL',
+    'NotR',
+    'And',
+    'Nand',
+    'Or',
+    'Nor',
+    'Xor',
+    'Xnor',
+    'ImplicationL',
+    'ImplicationR',
+    'InhibitionL',
+    'InhibitionR',
+]);
+const senderHasInputRole = z.object({
+    index: z.number(),
+    role_key: role,
+});
+const senderHasOutputRole = z.object({
+    index: z.number(),
+    role_key: role,
+});
+const outputHasRole = z.object({
+    index: z.number(),
+    role_key: role,
+});
+const outputHasMetadata = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+});
+const inputHasRole = z.object({
+    index: z.number(),
+    role_key: role,
+});
+const inputHasMetadata = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+});
+const matchInputOutputRole = z.object({
+    input_index: z.number(),
+    input_role_key: role,
+    output_index: z.number(),
+    output_role_key: role,
+});
+const matchInputOutputMetadataValue = z.object({
+    input_index: z.number(),
+    input_metadata_key: tokenMetadataKey,
+    output_index: z.number(),
+    output_metadata_key: tokenMetadataKey,
+});
+const matchInputIdOutputMetadataValue = z.object({
+    input_index: z.number(),
+    output_index: z.number(),
+    output_metadata_key: tokenMetadataKey,
+});
+const fixedNumberOfInputs = z.object({
+    num_inputs: z.number(),
+});
+const fixedNumberOfOutputs = z.object({
+    num_outputs: z.number(),
+});
+const fixedInputMetadataValue = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+    metadata_value: metadataValue,
+});
+const fixedOutputMetadataValue = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+    metadata_value: metadataValue,
+});
+const fixedInputMetadataValueType = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+    metadata_value_type: metadataValueType,
+});
+const fixedOutputMetadataValueType = z.object({
+    index: z.number(),
+    metadata_key: tokenMetadataKey,
+    metadata_value_type: metadataValueType,
+});
+export const restrictionValidation = z.union([
+    z.literal('None'),
+    z.literal('Fail'),
+    z.object({ SenderHasInputRole: senderHasInputRole }).strict(),
+    z.object({ SenderHasOutputRole: senderHasOutputRole }).strict(),
+    z.object({ OutputHasRole: outputHasRole }).strict(),
+    z.object({ OutputHasMetadata: outputHasMetadata }).strict(),
+    z.object({ InputHasRole: inputHasRole }).strict(),
+    z.object({ InputHasMetadata: inputHasMetadata }).strict(),
+    z.object({ MatchInputOutputRole: matchInputOutputRole }).strict(),
+    z.object({ MatchInputOutputMetadataValue: matchInputOutputMetadataValue }).strict(),
+    z.object({ MatchInputIdOutputMetadataValue: matchInputIdOutputMetadataValue }).strict(),
+    z.object({ FixedNumberOfInputs: fixedNumberOfInputs }).strict(),
+    z.object({ FixedNumberOfOutputs: fixedNumberOfOutputs }).strict(),
+    z.object({ FixedInputMetadataValue: fixedInputMetadataValue }).strict(),
+    z.object({ FixedOutputMetadataValue: fixedOutputMetadataValue }).strict(),
+    z.object({ FixedInputMetadataValueType: fixedInputMetadataValueType }).strict(),
+    z.object({ FixedOutputMetadataValueType: fixedOutputMetadataValueType }).strict(),
+]);
+export const stepValidation = z.union([
+    z.object({ Op: binaryOperator }),
+    z.object({ Restriction: restrictionValidation }),
+]);
+export const programValidation = z.array(stepValidation);
+export const processValidation = z.object({
+    name: z.string().max(Constants.PROCESS_ID_LENGTH),
+    version: z.number(),
+    program: programValidation,
+});
+export const simpleProcesssValidation = z.array(z.object({ name: z.string() }).passthrough());
+export const processesValidation = z.array(processValidation);

package/build/src/lib/utils/polkadot.d.ts

@@ -0,0 +1 @@
+export declare const createNodeApi: (options: Polkadot.Options) => Promise<Polkadot.Polkadot>;

package/build/src/lib/utils/polkadot.js

@@ -0,0 +1,25 @@
+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 { ApiPromise, WsProvider, Keyring } from '@polkadot/api';
+export const createNodeApi = (options) => __awaiter(void 0, void 0, void 0, function* () {
+    const provider = new WsProvider(`ws://${options.API_HOST}:${options.API_PORT}`);
+    const api = new ApiPromise({ provider });
+    api.isReadyOrError.catch(() => { }); // prevent unhandled promise rejection errors
+    yield api.isReady;
+    api.on('error', (err) => {
+        const msg = err.message || JSON.stringify(err);
+        console.log(`Error from substrate node connection. Error was ${msg}`);
+        return msg;
+    });
+    return {
+        api,
+        keyring: new Keyring({ type: 'sr25519' }),
+    };
+});

package/build/src/version.d.ts

@@ -0,0 +1,2 @@
+declare const version: string;
+export default version;

package/build/src/version.js

@@ -0,0 +1,3 @@
+import packageJson from '../package.json' assert { type: 'json' };
+const { version } = packageJson;
+export default version;

package/build/tests/fixtures/processes.d.ts

@@ -0,0 +1,281 @@
+declare const _default: ({
+    name: string;
+    version: number;
+    program: ({
+        Restriction: {
+            FixedNumberOfInputs: {
+                num_inputs: number;
+            };
+            FixedNumberOfOutputs?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            FixedOutputMetadataValueType?: undefined;
+            OutputHasMetadata?: undefined;
+            SenderHasOutputRole?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            FixedNumberOfOutputs: {
+                num_outputs: number;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            FixedOutputMetadataValueType?: undefined;
+            OutputHasMetadata?: undefined;
+            SenderHasOutputRole?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Op: string;
+        Restriction?: undefined;
+    } | {
+        Restriction: {
+            FixedOutputMetadataValue: {
+                index: number;
+                metadata_key: string;
+                metadata_value: {
+                    Literal: string;
+                };
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedOutputMetadataValueType?: undefined;
+            OutputHasMetadata?: undefined;
+            SenderHasOutputRole?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            FixedOutputMetadataValueType: {
+                index: number;
+                metadata_key: string;
+                metadata_value_type: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+            SenderHasOutputRole?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            OutputHasMetadata: {
+                index: number;
+                metadata_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            FixedOutputMetadataValueType?: undefined;
+            SenderHasOutputRole?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: string;
+        Op?: undefined;
+    } | {
+        Restriction: {
+            SenderHasOutputRole: {
+                index: number;
+                role_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            FixedOutputMetadataValueType?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    })[];
+} | {
+    name: string;
+    version: number;
+    program: ({
+        Restriction: {
+            FixedNumberOfInputs: {
+                num_inputs: number;
+            };
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            FixedNumberOfOutputs: {
+                num_outputs: number;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Op: string;
+        Restriction?: undefined;
+    } | {
+        Restriction: {
+            FixedInputMetadataValue: {
+                index: number;
+                metadata_key: string;
+                metadata_value: {
+                    Literal: string;
+                };
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            MatchInputOutputMetadataValue: {
+                input_index: number;
+                input_metadata_key: string;
+                output_index: number;
+                output_metadata_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            MatchInputOutputRole: {
+                input_index: number;
+                input_role_key: string;
+                output_index: number;
+                output_role_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            InputHasMetadata: {
+                index: number;
+                metadata_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: string;
+        Op?: undefined;
+    } | {
+        Restriction: {
+            MatchInputIdOutputMetadataValue: {
+                input_index: number;
+                output_index: number;
+                output_metadata_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            SenderHasOutputRole: {
+                index: number;
+                role_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            FixedOutputMetadataValue?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            FixedOutputMetadataValue: {
+                index: number;
+                metadata_key: string;
+                metadata_value: {
+                    Literal: string;
+                };
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            OutputHasMetadata?: undefined;
+        };
+        Op?: undefined;
+    } | {
+        Restriction: {
+            OutputHasMetadata: {
+                index: number;
+                metadata_key: string;
+            };
+            FixedNumberOfInputs?: undefined;
+            FixedNumberOfOutputs?: undefined;
+            FixedInputMetadataValue?: undefined;
+            MatchInputOutputMetadataValue?: undefined;
+            MatchInputOutputRole?: undefined;
+            InputHasMetadata?: undefined;
+            MatchInputIdOutputMetadataValue?: undefined;
+            SenderHasOutputRole?: undefined;
+            FixedOutputMetadataValue?: undefined;
+        };
+        Op?: undefined;
+    })[];
+})[];
+export default _default;