@3sixty/immutable-proof-task 0.0.0-stage → 0.20.0-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   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

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Immutable Proof Task
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package provides background processing for immutable proof generation. It accepts prepared task payloads, resolves the configured identity connector, and produces verifiable credential output for downstream storage and verification.
+
+## Installation
+
+```shell
+npm install @3sixty/immutable-proof-task
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-immutable-proof](https://github.com/iotaledger/twin-immutable-proof/tree/next/packages/immutable-proof-task) repository.

package/dist/es/immutableProofTask.js

@@ -0,0 +1,12 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * The source context for guards and logging in the immutable proof task.
+ */
+export class ImmutableProofTask {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "ImmutableProofTask";
+}
+//# sourceMappingURL=immutableProofTask.js.map

package/dist/es/immutableProofTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"immutableProofTask.js","sources":["../../src/immutableProofTask.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AAGvC;;GAEG;AACH,MAAM,OAAO,kBAAkB;IAC9B;;OAEG;IACI,MAAM,CAAU,UAAU,GAAW,oBAAoB,CAAC;CACjE","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n\n/**\n * The source context for guards and logging in the immutable proof task.\n */\nexport class ImmutableProofTask {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = \"ImmutableProofTask\";\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,6 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./models/IImmutableProofTaskPayload.js";
+export * from "./models/IImmutableProofTaskResult.js";
+export * from "./processProofTask.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,wCAAwC,CAAC;AACvD,cAAc,uCAAuC,CAAC;AACtD,cAAc,uBAAuB,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./models/IImmutableProofTaskPayload.js\";\nexport * from \"./models/IImmutableProofTaskResult.js\";\nexport * from \"./processProofTask.js\";\n"]}

package/dist/es/models/IImmutableProofTaskPayload.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IImmutableProofTaskPayload.js.map

package/dist/es/models/IImmutableProofTaskPayload.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofTaskPayload.js","sources":["../../../src/models/IImmutableProofTaskPayload.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IImmutableProof } from \"@3sixty/immutable-proof-models\";\n\n/**\n * The payload for the immutable proof task.\n */\nexport interface IImmutableProofTaskPayload {\n\t/**\n\t * The proof id.\n\t */\n\tproofId: string;\n\n\t/**\n\t * The identity to create the proof for.\n\t */\n\tidentity: string;\n\n\t/**\n\t * The identity connector type.\n\t */\n\tidentityConnectorType: string;\n\n\t/**\n\t * The assertion method id.\n\t */\n\tverificationMethodId: string;\n\n\t/**\n\t * The subject to create the proof for.\n\t */\n\tcredentialSubject: IImmutableProof;\n\n\t/**\n\t * The notarization connector type.\n\t */\n\tnotarizationConnectorType: string;\n\n\t/**\n\t * An ISO 8601 date-time string specifying when the notarization lock expires.\n\t * If omitted, no deletion lock is applied.\n\t */\n\tdeleteLockDateTime?: string;\n\n\t/**\n\t * The logging component type to use for step logging inside the task.\n\t * If omitted, no step logging is performed.\n\t */\n\tloggingComponentType?: string;\n}\n"]}

package/dist/es/models/IImmutableProofTaskResult.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IImmutableProofTaskResult.js.map

package/dist/es/models/IImmutableProofTaskResult.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IImmutableProofTaskResult.js","sources":["../../../src/models/IImmutableProofTaskResult.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IError } from \"@3sixty/core\";\nimport type { IDidVerifiableCredential } from \"@3sixty/standards-w3c-did\";\n\n/**\n * The result for the immutable proof task.\n */\nexport interface IImmutableProofTaskResult {\n\t/**\n\t * The proof id.\n\t */\n\tproofId: string;\n\n\t/**\n\t * The verifiable credential produced by the proof task.\n\t */\n\tverifiableCredential: IDidVerifiableCredential;\n\n\t/**\n\t * The notarization id returned after storing the proof.\n\t * Not set when the notarization phase failed, see notarizationError.\n\t */\n\tnotarizationId?: string;\n\n\t/**\n\t * Set when the notarization phase failed. The failure is returned in the result\n\t * instead of being thrown, because the notarization may have reached the ledger\n\t * even though the call failed, and a retry could create a duplicate on-chain object.\n\t */\n\tnotarizationError?: IError;\n}\n"]}

package/dist/es/processProofTask.js

@@ -0,0 +1,220 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { ContextIdStore } from "@3sixty/context";
+import { BaseError, ComponentFactory, Guards, Is, ObjectHelper } from "@3sixty/core";
+import { IdentityConnectorFactory } from "@3sixty/identity-models";
+import { ModuleHelper } from "@3sixty/modules";
+import { NotarizationConnectorFactory, NotarizationMode } from "@3sixty/notarization-models";
+import { ImmutableProofTask } from "./immutableProofTask.js";
+/**
+ * The worker's engine clone, reused by every processProofTask call until processProofTaskEnd
+ * tears it down.
+ */
+let engine;
+/**
+ * Resolves once the most recent processProofTaskStart call has finished.
+ */
+let startupPromise;
+/**
+ * Build and start the worker's engine clone. Registered as the background task handler's
+ * initialiseMethod, so it runs once per worker instead of once per task.
+ * @param engineCloneData The engine clone data used to initialize a cloned engine instance when
+ * running in a separate thread. Empty when not running in a worker thread (e.g. in tests).
+ * @param loggingComponentType The logging component type to use for step logging, if configured.
+ * @returns A promise that resolves once the engine has started.
+ */
+export async function processProofTaskStart(engineCloneData, loggingComponentType) {
+    let built;
+    startupPromise = (async () => {
+        if (Is.empty(engineCloneData)) {
+            return;
+        }
+        const startTime = Date.now();
+        // If the clone data is not empty we are running in a worker thread - create a
+        // cloned engine instance via dynamic import so no static engine dependency is needed.
+        built = await ModuleHelper.execModuleMethod("@3sixty/engine-core", "EngineCoreBuilder.fromClone", [
+            "engine",
+            engineCloneData,
+            await ContextIdStore.getContextIds(),
+            {
+                logLevel: "error",
+                types: [
+                    "loggingComponent",
+                    "loggingConnector",
+                    "identityConnector",
+                    "notarizationConnector",
+                    "vaultConnector",
+                    "entityStorageConnector",
+                    "platformComponent",
+                    "dltConfig"
+                ],
+                entityTypes: [
+                    "LogEntry",
+                    "LogEntryError",
+                    "IdentityDocument",
+                    "Notarization",
+                    "VaultKey",
+                    "VaultSecret"
+                ]
+            }
+        ]);
+        engine = built;
+        await built.start();
+        const logging = ComponentFactory.getIfExists(loggingComponentType);
+        await logging?.log({
+            level: "debug",
+            source: ImmutableProofTask.CLASS_NAME,
+            ts: Date.now(),
+            message: "taskEngineStarted",
+            data: { elapsedMs: Date.now() - startTime }
+        });
+    })();
+    try {
+        await startupPromise;
+    }
+    catch (err) {
+        // Release this attempt's engine before awaiting anything, so a task waiting on the same
+        // startup sees no engine and rebuilds, then stop whatever did start so it is not leaked.
+        if (engine === built) {
+            engine = undefined;
+            startupPromise = undefined;
+        }
+        if (!Is.empty(built)) {
+            await stopEngine(built, loggingComponentType);
+        }
+        throw err;
+    }
+}
+/**
+ * Stop the worker's engine clone. Registered as the background task handler's shutdownMethod.
+ * @param loggingComponentType The logging component type to use for step logging, if configured.
+ * @returns A promise that resolves once the engine has stopped, even if stopping failed.
+ */
+export async function processProofTaskEnd(loggingComponentType) {
+    const current = engine;
+    engine = undefined;
+    startupPromise = undefined;
+    if (!Is.empty(current)) {
+        await stopEngine(current, loggingComponentType);
+    }
+}
+/**
+ * Stop an engine clone, logging instead of throwing when the stop fails.
+ * @param engineToStop The engine to stop.
+ * @param loggingComponentType The logging component type to use for step logging, if configured.
+ * @returns A promise that resolves once the stop attempt has finished.
+ */
+async function stopEngine(engineToStop, loggingComponentType) {
+    try {
+        await engineToStop.stop();
+    }
+    catch (error) {
+        // A throw here must not stop the rest of the shutdown from completing.
+        try {
+            const logging = ComponentFactory.getIfExists(loggingComponentType);
+            await logging?.log({
+                level: "warn",
+                source: ImmutableProofTask.CLASS_NAME,
+                ts: Date.now(),
+                message: "taskEngineStopFailed",
+                error: BaseError.fromError(error)
+            });
+        }
+        catch {
+            // Nothing more can be done if logging also fails.
+        }
+    }
+}
+/**
+ * Process a proof task by creating a verifiable credential and notarizing it. Waits for the
+ * worker's engine clone to finish starting, building it if it hasn't started yet.
+ * @param engineCloneData The engine clone data used to initialize a cloned engine instance when running in a separate thread.
+ * @param payload The payload containing the proof parameters.
+ * @returns The task result containing the verifiable credential and notarization id.
+ */
+export async function processProofTask(engineCloneData, payload) {
+    Guards.objectValue(ImmutableProofTask.CLASS_NAME, "payload", payload);
+    Guards.stringValue(ImmutableProofTask.CLASS_NAME, "payload.identity", payload.identity);
+    Guards.stringValue(ImmutableProofTask.CLASS_NAME, "payload.identityConnectorType", payload.identityConnectorType);
+    Guards.stringValue(ImmutableProofTask.CLASS_NAME, "payload.verificationMethodId", payload.verificationMethodId);
+    Guards.object(ImmutableProofTask.CLASS_NAME, "payload.credentialSubject", payload.credentialSubject);
+    Guards.stringValue(ImmutableProofTask.CLASS_NAME, "payload.notarizationConnectorType", payload.notarizationConnectorType);
+    if (!Is.empty(engineCloneData)) {
+        let startFailed = false;
+        if (startupPromise) {
+            try {
+                await startupPromise;
+            }
+            catch {
+                startFailed = true;
+            }
+        }
+        if (startFailed || Is.empty(engine)) {
+            await processProofTaskStart(engineCloneData, payload.loggingComponentType);
+        }
+    }
+    const taskStartTime = Date.now();
+    const logging = ComponentFactory.getIfExists(payload.loggingComponentType);
+    const identityConnector = IdentityConnectorFactory.get(payload.identityConnectorType);
+    const credentialStartTime = Date.now();
+    const result = await identityConnector.createVerifiableCredential(payload.identity, `${payload.identity}#${payload.verificationMethodId}`, payload.proofId, payload.credentialSubject);
+    await logging?.log({
+        level: "debug",
+        source: ImmutableProofTask.CLASS_NAME,
+        ts: Date.now(),
+        message: "taskVerifiableCredentialCreated",
+        data: { proofId: payload.proofId, elapsedMs: Date.now() - credentialStartTime }
+    });
+    // The proof context is always the last one in the generated vc contexts
+    // as that was the last operation performed, so we can extract it and use it for the proof itself.
+    // Remove verificationMethod to reduce linkage to the issuing identity (reinstated on verify).
+    const proof = result.verifiableCredential.proof;
+    proof["@context"] = result.verifiableCredential["@context"][result.verifiableCredential["@context"].length - 1];
+    delete proof.verificationMethod;
+    const notarizationConnector = NotarizationConnectorFactory.get(payload.notarizationConnectorType);
+    const notarizationStartTime = Date.now();
+    try {
+        const notarizationId = await notarizationConnector.create(payload.identity, {
+            mode: NotarizationMode.Locked,
+            data: ObjectHelper.toBytes(proof),
+            deleteLockDateTime: payload.deleteLockDateTime
+        });
+        await logging?.log({
+            level: "debug",
+            source: ImmutableProofTask.CLASS_NAME,
+            ts: Date.now(),
+            message: "taskNotarizationComplete",
+            data: {
+                proofId: payload.proofId,
+                elapsedMs: Date.now() - notarizationStartTime,
+                totalElapsedMs: Date.now() - taskStartTime
+            }
+        });
+        return {
+            proofId: payload.proofId,
+            verifiableCredential: result.verifiableCredential,
+            notarizationId
+        };
+    }
+    catch (error) {
+        // The notarization may have reached the ledger even though the call failed, so
+        // retrying could create a duplicate on-chain object. Return the failure in the
+        // result instead of throwing, which prevents the task engine from retrying.
+        // Failures thrown before this point are safe for the task engine to retry.
+        const notarizationError = BaseError.fromError(error);
+        await logging?.log({
+            level: "error",
+            source: ImmutableProofTask.CLASS_NAME,
+            ts: Date.now(),
+            message: "taskNotarizationFailed",
+            error: notarizationError,
+            data: { proofId: payload.proofId, elapsedMs: Date.now() - notarizationStartTime }
+        });
+        return {
+            proofId: payload.proofId,
+            verifiableCredential: result.verifiableCredential,
+            notarizationError: notarizationError.toJsonObject(true)
+        };
+    }
+}
+//# sourceMappingURL=processProofTask.js.map

package/dist/es/processProofTask.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"processProofTask.js","sources":["../../src/processProofTask.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,MAAM,EAAE,EAAE,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AAErF,OAAO,EAAE,wBAAwB,EAAE,MAAM,yBAAyB,CAAC;AAEnE,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAE/C,OAAO,EAAE,4BAA4B,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAE7F,OAAO,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAC;AAI7D;;;GAGG;AACH,IAAI,MAKQ,CAAC;AAEb;;GAEG;AACH,IAAI,cAAyC,CAAC;AAE9C;;;;;;;GAOG;AACH,MAAM,CAAC,KAAK,UAAU,qBAAqB,CAC1C,eAAwB,EACxB,oBAA6B;IAE7B,IAAI,KAAoB,CAAC;IACzB,cAAc,GAAG,CAAC,KAAK,IAAI,EAAE;QAC5B,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;YAC/B,OAAO;QACR,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAE7B,8EAA8E;QAC9E,sFAAsF;QACtF,KAAK,GAAG,MAAM,YAAY,CAAC,gBAAgB,CAC1C,qBAAqB,EACrB,6BAA6B,EAC7B;YACC,QAAQ;YACR,eAAe;YACf,MAAM,cAAc,CAAC,aAAa,EAAE;YACpC;gBACC,QAAQ,EAAE,OAAO;gBACjB,KAAK,EAAE;oBACN,kBAAkB;oBAClB,kBAAkB;oBAClB,mBAAmB;oBACnB,uBAAuB;oBACvB,gBAAgB;oBAChB,wBAAwB;oBACxB,mBAAmB;oBACnB,WAAW;iBACX;gBACD,WAAW,EAAE;oBACZ,UAAU;oBACV,eAAe;oBACf,kBAAkB;oBAClB,cAAc;oBACd,UAAU;oBACV,aAAa;iBACb;aACD;SACD,CACD,CAAC;QACF,MAAM,GAAG,KAAK,CAAC;QACf,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QAEpB,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAoB,oBAAoB,CAAC,CAAC;QACtF,MAAM,OAAO,EAAE,GAAG,CAAC;YAClB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,kBAAkB,CAAC,UAAU;YACrC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,mBAAmB;YAC5B,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,EAAE;SAC3C,CAAC,CAAC;IACJ,CAAC,CAAC,EAAE,CAAC;IAEL,IAAI,CAAC;QACJ,MAAM,cAAc,CAAC;IACtB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,wFAAwF;QACxF,yFAAyF;QACzF,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;YACtB,MAAM,GAAG,SAAS,CAAC;YACnB,cAAc,GAAG,SAAS,CAAC;QAC5B,CAAC;QACD,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,UAAU,CAAC,KAAK,EAAE,oBAAoB,CAAC,CAAC;QAC/C,CAAC;QACD,MAAM,GAAG,CAAC;IACX,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,CAAC,KAAK,UAAU,mBAAmB,CAAC,oBAA6B;IACtE,MAAM,OAAO,GAAG,MAAM,CAAC;IACvB,MAAM,GAAG,SAAS,CAAC;IACnB,cAAc,GAAG,SAAS,CAAC;IAC3B,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;QACxB,MAAM,UAAU,CAAC,OAAO,EAAE,oBAAoB,CAAC,CAAC;IACjD,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,UAAU,CACxB,YAAwC,EACxC,oBAA6B;IAE7B,IAAI,CAAC;QACJ,MAAM,YAAY,CAAC,IAAI,EAAE,CAAC;IAC3B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,uEAAuE;QACvE,IAAI,CAAC;YACJ,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAoB,oBAAoB,CAAC,CAAC;YACtF,MAAM,OAAO,EAAE,GAAG,CAAC;gBAClB,KAAK,EAAE,MAAM;gBACb,MAAM,EAAE,kBAAkB,CAAC,UAAU;gBACrC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;gBACd,OAAO,EAAE,sBAAsB;gBAC/B,KAAK,EAAE,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC;aACjC,CAAC,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACR,kDAAkD;QACnD,CAAC;IACF,CAAC;AACF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACrC,eAAwB,EACxB,OAAmC;IAEnC,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,EAC7B,SAAS,EACT,OAAO,CACP,CAAC;IACF,MAAM,CAAC,WAAW,CAAC,kBAAkB,CAAC,UAAU,EAAE,kBAAkB,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAC;IACxF,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,EAC7B,+BAA+B,EAC/B,OAAO,CAAC,qBAAqB,CAC7B,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,EAC7B,8BAA8B,EAC9B,OAAO,CAAC,oBAAoB,CAC5B,CAAC;IACF,MAAM,CAAC,MAAM,CACZ,kBAAkB,CAAC,UAAU,EAC7B,2BAA2B,EAC3B,OAAO,CAAC,iBAAiB,CACzB,CAAC;IACF,MAAM,CAAC,WAAW,CACjB,kBAAkB,CAAC,UAAU,EAC7B,mCAAmC,EACnC,OAAO,CAAC,yBAAyB,CACjC,CAAC;IAEF,IAAI,CAAC,EAAE,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE,CAAC;QAChC,IAAI,WAAW,GAAG,KAAK,CAAC;QACxB,IAAI,cAAc,EAAE,CAAC;YACpB,IAAI,CAAC;gBACJ,MAAM,cAAc,CAAC;YACtB,CAAC;YAAC,MAAM,CAAC;gBACR,WAAW,GAAG,IAAI,CAAC;YACpB,CAAC;QACF,CAAC;QACD,IAAI,WAAW,IAAI,EAAE,CAAC,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC;YACrC,MAAM,qBAAqB,CAAC,eAAe,EAAE,OAAO,CAAC,oBAAoB,CAAC,CAAC;QAC5E,CAAC;IACF,CAAC;IAED,MAAM,aAAa,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACjC,MAAM,OAAO,GAAG,gBAAgB,CAAC,WAAW,CAAoB,OAAO,CAAC,oBAAoB,CAAC,CAAC;IAE9F,MAAM,iBAAiB,GAAG,wBAAwB,CAAC,GAAG,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAEtF,MAAM,mBAAmB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACvC,MAAM,MAAM,GAAG,MAAM,iBAAiB,CAAC,0BAA0B,CAChE,OAAO,CAAC,QAAQ,EAChB,GAAG,OAAO,CAAC,QAAQ,IAAI,OAAO,CAAC,oBAAoB,EAAE,EACrD,OAAO,CAAC,OAAO,EACf,OAAO,CAAC,iBAAiB,CACzB,CAAC;IAEF,MAAM,OAAO,EAAE,GAAG,CAAC;QAClB,KAAK,EAAE,OAAO;QACd,MAAM,EAAE,kBAAkB,CAAC,UAAU;QACrC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;QACd,OAAO,EAAE,iCAAiC;QAC1C,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,mBAAmB,EAAE;KAC/E,CAAC,CAAC;IAEH,wEAAwE;IACxE,kGAAkG;IAClG,8FAA8F;IAC9F,MAAM,KAAK,GAAW,MAAM,CAAC,oBAAoB,CAAC,KAAe,CAAC;IAClE,KAAK,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAC1D,MAAM,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,CAC5B,CAAC;IACxB,OAAO,KAAK,CAAC,kBAAkB,CAAC;IAEhC,MAAM,qBAAqB,GAAG,4BAA4B,CAAC,GAAG,CAAC,OAAO,CAAC,yBAAyB,CAAC,CAAC;IAElG,MAAM,qBAAqB,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;IACzC,IAAI,CAAC;QACJ,MAAM,cAAc,GAAG,MAAM,qBAAqB,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,EAAE;YAC3E,IAAI,EAAE,gBAAgB,CAAC,MAAM;YAC7B,IAAI,EAAE,YAAY,CAAC,OAAO,CAAC,KAAK,CAAC;YACjC,kBAAkB,EAAE,OAAO,CAAC,kBAAkB;SAC9C,CAAC,CAAC;QAEH,MAAM,OAAO,EAAE,GAAG,CAAC;YAClB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,kBAAkB,CAAC,UAAU;YACrC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,0BAA0B;YACnC,IAAI,EAAE;gBACL,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,qBAAqB;gBAC7C,cAAc,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,aAAa;aAC1C;SACD,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;YACjD,cAAc;SACd,CAAC;IACH,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QAChB,+EAA+E;QAC/E,+EAA+E;QAC/E,4EAA4E;QAC5E,2EAA2E;QAC3E,MAAM,iBAAiB,GAAG,SAAS,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QAErD,MAAM,OAAO,EAAE,GAAG,CAAC;YAClB,KAAK,EAAE,OAAO;YACd,MAAM,EAAE,kBAAkB,CAAC,UAAU;YACrC,EAAE,EAAE,IAAI,CAAC,GAAG,EAAE;YACd,OAAO,EAAE,wBAAwB;YACjC,KAAK,EAAE,iBAAiB;YACxB,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,OAAO,EAAE,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE,GAAG,qBAAqB,EAAE;SACjF,CAAC,CAAC;QAEH,OAAO;YACN,OAAO,EAAE,OAAO,CAAC,OAAO;YACxB,oBAAoB,EAAE,MAAM,CAAC,oBAAoB;YACjD,iBAAiB,EAAE,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC;SACvD,CAAC;IACH,CAAC;AACF,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ContextIdStore } from \"@3sixty/context\";\nimport { BaseError, ComponentFactory, Guards, Is, ObjectHelper } from \"@3sixty/core\";\nimport type { IJsonLdNodeObject } from \"@3sixty/data-json-ld\";\nimport { IdentityConnectorFactory } from \"@3sixty/identity-models\";\nimport type { ILoggingComponent } from \"@3sixty/logging-models\";\nimport { ModuleHelper } from \"@3sixty/modules\";\n\nimport { NotarizationConnectorFactory, NotarizationMode } from \"@3sixty/notarization-models\";\nimport type { IProof } from \"@3sixty/standards-w3c-did\";\nimport { ImmutableProofTask } from \"./immutableProofTask.js\";\nimport type { IImmutableProofTaskPayload } from \"./models/IImmutableProofTaskPayload.js\";\nimport type { IImmutableProofTaskResult } from \"./models/IImmutableProofTaskResult.js\";\n\n/**\n * The worker's engine clone, reused by every processProofTask call until processProofTaskEnd\n * tears it down.\n */\nlet engine:\n\t| {\n\t\t\tstart: () => Promise<void>;\n\t\t\tstop: () => Promise<void>;\n\t  }\n\t| undefined;\n\n/**\n * Resolves once the most recent processProofTaskStart call has finished.\n */\nlet startupPromise: Promise<void> | undefined;\n\n/**\n * Build and start the worker's engine clone. Registered as the background task handler's\n * initialiseMethod, so it runs once per worker instead of once per task.\n * @param engineCloneData The engine clone data used to initialize a cloned engine instance when\n * running in a separate thread. Empty when not running in a worker thread (e.g. in tests).\n * @param loggingComponentType The logging component type to use for step logging, if configured.\n * @returns A promise that resolves once the engine has started.\n */\nexport async function processProofTaskStart(\n\tengineCloneData: unknown,\n\tloggingComponentType?: string\n): Promise<void> {\n\tlet built: typeof engine;\n\tstartupPromise = (async () => {\n\t\tif (Is.empty(engineCloneData)) {\n\t\t\treturn;\n\t\t}\n\n\t\tconst startTime = Date.now();\n\n\t\t// If the clone data is not empty we are running in a worker thread - create a\n\t\t// cloned engine instance via dynamic import so no static engine dependency is needed.\n\t\tbuilt = await ModuleHelper.execModuleMethod<NonNullable<typeof engine>>(\n\t\t\t\"@3sixty/engine-core\",\n\t\t\t\"EngineCoreBuilder.fromClone\",\n\t\t\t[\n\t\t\t\t\"engine\",\n\t\t\t\tengineCloneData,\n\t\t\t\tawait ContextIdStore.getContextIds(),\n\t\t\t\t{\n\t\t\t\t\tlogLevel: \"error\",\n\t\t\t\t\ttypes: [\n\t\t\t\t\t\t\"loggingComponent\",\n\t\t\t\t\t\t\"loggingConnector\",\n\t\t\t\t\t\t\"identityConnector\",\n\t\t\t\t\t\t\"notarizationConnector\",\n\t\t\t\t\t\t\"vaultConnector\",\n\t\t\t\t\t\t\"entityStorageConnector\",\n\t\t\t\t\t\t\"platformComponent\",\n\t\t\t\t\t\t\"dltConfig\"\n\t\t\t\t\t],\n\t\t\t\t\tentityTypes: [\n\t\t\t\t\t\t\"LogEntry\",\n\t\t\t\t\t\t\"LogEntryError\",\n\t\t\t\t\t\t\"IdentityDocument\",\n\t\t\t\t\t\t\"Notarization\",\n\t\t\t\t\t\t\"VaultKey\",\n\t\t\t\t\t\t\"VaultSecret\"\n\t\t\t\t\t]\n\t\t\t\t}\n\t\t\t]\n\t\t);\n\t\tengine = built;\n\t\tawait built.start();\n\n\t\tconst logging = ComponentFactory.getIfExists<ILoggingComponent>(loggingComponentType);\n\t\tawait logging?.log({\n\t\t\tlevel: \"debug\",\n\t\t\tsource: ImmutableProofTask.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"taskEngineStarted\",\n\t\t\tdata: { elapsedMs: Date.now() - startTime }\n\t\t});\n\t})();\n\n\ttry {\n\t\tawait startupPromise;\n\t} catch (err) {\n\t\t// Release this attempt's engine before awaiting anything, so a task waiting on the same\n\t\t// startup sees no engine and rebuilds, then stop whatever did start so it is not leaked.\n\t\tif (engine === built) {\n\t\t\tengine = undefined;\n\t\t\tstartupPromise = undefined;\n\t\t}\n\t\tif (!Is.empty(built)) {\n\t\t\tawait stopEngine(built, loggingComponentType);\n\t\t}\n\t\tthrow err;\n\t}\n}\n\n/**\n * Stop the worker's engine clone. Registered as the background task handler's shutdownMethod.\n * @param loggingComponentType The logging component type to use for step logging, if configured.\n * @returns A promise that resolves once the engine has stopped, even if stopping failed.\n */\nexport async function processProofTaskEnd(loggingComponentType?: string): Promise<void> {\n\tconst current = engine;\n\tengine = undefined;\n\tstartupPromise = undefined;\n\tif (!Is.empty(current)) {\n\t\tawait stopEngine(current, loggingComponentType);\n\t}\n}\n\n/**\n * Stop an engine clone, logging instead of throwing when the stop fails.\n * @param engineToStop The engine to stop.\n * @param loggingComponentType The logging component type to use for step logging, if configured.\n * @returns A promise that resolves once the stop attempt has finished.\n */\nasync function stopEngine(\n\tengineToStop: NonNullable<typeof engine>,\n\tloggingComponentType?: string\n): Promise<void> {\n\ttry {\n\t\tawait engineToStop.stop();\n\t} catch (error) {\n\t\t// A throw here must not stop the rest of the shutdown from completing.\n\t\ttry {\n\t\t\tconst logging = ComponentFactory.getIfExists<ILoggingComponent>(loggingComponentType);\n\t\t\tawait logging?.log({\n\t\t\t\tlevel: \"warn\",\n\t\t\t\tsource: ImmutableProofTask.CLASS_NAME,\n\t\t\t\tts: Date.now(),\n\t\t\t\tmessage: \"taskEngineStopFailed\",\n\t\t\t\terror: BaseError.fromError(error)\n\t\t\t});\n\t\t} catch {\n\t\t\t// Nothing more can be done if logging also fails.\n\t\t}\n\t}\n}\n\n/**\n * Process a proof task by creating a verifiable credential and notarizing it. Waits for the\n * worker's engine clone to finish starting, building it if it hasn't started yet.\n * @param engineCloneData The engine clone data used to initialize a cloned engine instance when running in a separate thread.\n * @param payload The payload containing the proof parameters.\n * @returns The task result containing the verifiable credential and notarization id.\n */\nexport async function processProofTask(\n\tengineCloneData: unknown,\n\tpayload: IImmutableProofTaskPayload\n): Promise<IImmutableProofTaskResult> {\n\tGuards.objectValue<IImmutableProofTaskPayload>(\n\t\tImmutableProofTask.CLASS_NAME,\n\t\t\"payload\",\n\t\tpayload\n\t);\n\tGuards.stringValue(ImmutableProofTask.CLASS_NAME, \"payload.identity\", payload.identity);\n\tGuards.stringValue(\n\t\tImmutableProofTask.CLASS_NAME,\n\t\t\"payload.identityConnectorType\",\n\t\tpayload.identityConnectorType\n\t);\n\tGuards.stringValue(\n\t\tImmutableProofTask.CLASS_NAME,\n\t\t\"payload.verificationMethodId\",\n\t\tpayload.verificationMethodId\n\t);\n\tGuards.object<IJsonLdNodeObject>(\n\t\tImmutableProofTask.CLASS_NAME,\n\t\t\"payload.credentialSubject\",\n\t\tpayload.credentialSubject\n\t);\n\tGuards.stringValue(\n\t\tImmutableProofTask.CLASS_NAME,\n\t\t\"payload.notarizationConnectorType\",\n\t\tpayload.notarizationConnectorType\n\t);\n\n\tif (!Is.empty(engineCloneData)) {\n\t\tlet startFailed = false;\n\t\tif (startupPromise) {\n\t\t\ttry {\n\t\t\t\tawait startupPromise;\n\t\t\t} catch {\n\t\t\t\tstartFailed = true;\n\t\t\t}\n\t\t}\n\t\tif (startFailed || Is.empty(engine)) {\n\t\t\tawait processProofTaskStart(engineCloneData, payload.loggingComponentType);\n\t\t}\n\t}\n\n\tconst taskStartTime = Date.now();\n\tconst logging = ComponentFactory.getIfExists<ILoggingComponent>(payload.loggingComponentType);\n\n\tconst identityConnector = IdentityConnectorFactory.get(payload.identityConnectorType);\n\n\tconst credentialStartTime = Date.now();\n\tconst result = await identityConnector.createVerifiableCredential(\n\t\tpayload.identity,\n\t\t`${payload.identity}#${payload.verificationMethodId}`,\n\t\tpayload.proofId,\n\t\tpayload.credentialSubject\n\t);\n\n\tawait logging?.log({\n\t\tlevel: \"debug\",\n\t\tsource: ImmutableProofTask.CLASS_NAME,\n\t\tts: Date.now(),\n\t\tmessage: \"taskVerifiableCredentialCreated\",\n\t\tdata: { proofId: payload.proofId, elapsedMs: Date.now() - credentialStartTime }\n\t});\n\n\t// The proof context is always the last one in the generated vc contexts\n\t// as that was the last operation performed, so we can extract it and use it for the proof itself.\n\t// Remove verificationMethod to reduce linkage to the issuing identity (reinstated on verify).\n\tconst proof: IProof = result.verifiableCredential.proof as IProof;\n\tproof[\"@context\"] = result.verifiableCredential[\"@context\"][\n\t\tresult.verifiableCredential[\"@context\"].length - 1\n\t] as IProof[\"@context\"];\n\tdelete proof.verificationMethod;\n\n\tconst notarizationConnector = NotarizationConnectorFactory.get(payload.notarizationConnectorType);\n\n\tconst notarizationStartTime = Date.now();\n\ttry {\n\t\tconst notarizationId = await notarizationConnector.create(payload.identity, {\n\t\t\tmode: NotarizationMode.Locked,\n\t\t\tdata: ObjectHelper.toBytes(proof),\n\t\t\tdeleteLockDateTime: payload.deleteLockDateTime\n\t\t});\n\n\t\tawait logging?.log({\n\t\t\tlevel: \"debug\",\n\t\t\tsource: ImmutableProofTask.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"taskNotarizationComplete\",\n\t\t\tdata: {\n\t\t\t\tproofId: payload.proofId,\n\t\t\t\telapsedMs: Date.now() - notarizationStartTime,\n\t\t\t\ttotalElapsedMs: Date.now() - taskStartTime\n\t\t\t}\n\t\t});\n\n\t\treturn {\n\t\t\tproofId: payload.proofId,\n\t\t\tverifiableCredential: result.verifiableCredential,\n\t\t\tnotarizationId\n\t\t};\n\t} catch (error) {\n\t\t// The notarization may have reached the ledger even though the call failed, so\n\t\t// retrying could create a duplicate on-chain object. Return the failure in the\n\t\t// result instead of throwing, which prevents the task engine from retrying.\n\t\t// Failures thrown before this point are safe for the task engine to retry.\n\t\tconst notarizationError = BaseError.fromError(error);\n\n\t\tawait logging?.log({\n\t\t\tlevel: \"error\",\n\t\t\tsource: ImmutableProofTask.CLASS_NAME,\n\t\t\tts: Date.now(),\n\t\t\tmessage: \"taskNotarizationFailed\",\n\t\t\terror: notarizationError,\n\t\t\tdata: { proofId: payload.proofId, elapsedMs: Date.now() - notarizationStartTime }\n\t\t});\n\n\t\treturn {\n\t\t\tproofId: payload.proofId,\n\t\t\tverifiableCredential: result.verifiableCredential,\n\t\t\tnotarizationError: notarizationError.toJsonObject(true)\n\t\t};\n\t}\n}\n"]}

package/dist/types/immutableProofTask.d.ts

@@ -0,0 +1,9 @@
+/**
+ * The source context for guards and logging in the immutable proof task.
+ */
+export declare class ImmutableProofTask {
+    /**
+     * Runtime name for the class.
+     */
+    static readonly CLASS_NAME: string;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./models/IImmutableProofTaskPayload.js";
+export * from "./models/IImmutableProofTaskResult.js";
+export * from "./processProofTask.js";

package/dist/types/models/IImmutableProofTaskPayload.d.ts

@@ -0,0 +1,40 @@
+import type { IImmutableProof } from "@3sixty/immutable-proof-models";
+/**
+ * The payload for the immutable proof task.
+ */
+export interface IImmutableProofTaskPayload {
+    /**
+     * The proof id.
+     */
+    proofId: string;
+    /**
+     * The identity to create the proof for.
+     */
+    identity: string;
+    /**
+     * The identity connector type.
+     */
+    identityConnectorType: string;
+    /**
+     * The assertion method id.
+     */
+    verificationMethodId: string;
+    /**
+     * The subject to create the proof for.
+     */
+    credentialSubject: IImmutableProof;
+    /**
+     * The notarization connector type.
+     */
+    notarizationConnectorType: string;
+    /**
+     * An ISO 8601 date-time string specifying when the notarization lock expires.
+     * If omitted, no deletion lock is applied.
+     */
+    deleteLockDateTime?: string;
+    /**
+     * The logging component type to use for step logging inside the task.
+     * If omitted, no step logging is performed.
+     */
+    loggingComponentType?: string;
+}

package/dist/types/models/IImmutableProofTaskResult.d.ts

@@ -0,0 +1,26 @@
+import type { IError } from "@3sixty/core";
+import type { IDidVerifiableCredential } from "@3sixty/standards-w3c-did";
+/**
+ * The result for the immutable proof task.
+ */
+export interface IImmutableProofTaskResult {
+    /**
+     * The proof id.
+     */
+    proofId: string;
+    /**
+     * The verifiable credential produced by the proof task.
+     */
+    verifiableCredential: IDidVerifiableCredential;
+    /**
+     * The notarization id returned after storing the proof.
+     * Not set when the notarization phase failed, see notarizationError.
+     */
+    notarizationId?: string;
+    /**
+     * Set when the notarization phase failed. The failure is returned in the result
+     * instead of being thrown, because the notarization may have reached the ledger
+     * even though the call failed, and a retry could create a duplicate on-chain object.
+     */
+    notarizationError?: IError;
+}

package/dist/types/processProofTask.d.ts

@@ -0,0 +1,25 @@
+import type { IImmutableProofTaskPayload } from "./models/IImmutableProofTaskPayload.js";
+import type { IImmutableProofTaskResult } from "./models/IImmutableProofTaskResult.js";
+/**
+ * Build and start the worker's engine clone. Registered as the background task handler's
+ * initialiseMethod, so it runs once per worker instead of once per task.
+ * @param engineCloneData The engine clone data used to initialize a cloned engine instance when
+ * running in a separate thread. Empty when not running in a worker thread (e.g. in tests).
+ * @param loggingComponentType The logging component type to use for step logging, if configured.
+ * @returns A promise that resolves once the engine has started.
+ */
+export declare function processProofTaskStart(engineCloneData: unknown, loggingComponentType?: string): Promise<void>;
+/**
+ * Stop the worker's engine clone. Registered as the background task handler's shutdownMethod.
+ * @param loggingComponentType The logging component type to use for step logging, if configured.
+ * @returns A promise that resolves once the engine has stopped, even if stopping failed.
+ */
+export declare function processProofTaskEnd(loggingComponentType?: string): Promise<void>;
+/**
+ * Process a proof task by creating a verifiable credential and notarizing it. Waits for the
+ * worker's engine clone to finish starting, building it if it hasn't started yet.
+ * @param engineCloneData The engine clone data used to initialize a cloned engine instance when running in a separate thread.
+ * @param payload The payload containing the proof parameters.
+ * @returns The task result containing the verifiable credential and notarization id.
+ */
+export declare function processProofTask(engineCloneData: unknown, payload: IImmutableProofTaskPayload): Promise<IImmutableProofTaskResult>;

package/docs/changelog.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## [0.20.0-next.1](https://github.com/3sixtyglobal/immutable-proof/compare/immutable-proof-task-v0.20.0-next.0...immutable-proof-task-v0.20.0-next.1) (2026-10-23)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([427b19f](https://github.com/3sixtyglobal/immutable-proof/commit/427b19fe3bd47827cd647e907b120d57415c62a5))
+* updated ts compile ([150ff76](https://github.com/3sixtyglobal/immutable-proof/commit/150ff76ff74620219cd3fae31d152144d0c79edd))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @3sixty/immutable-proof-models bumped from 0.20.0-next.0 to 0.20.0-next.1

package/docs/examples.md

@@ -0,0 +1,54 @@
+# Immutable Proof Task Examples
+
+These snippets show how to prepare payloads and execute background task processing for immutable proof generation.
+
+## processProofTask
+
+```typescript
+import type { IImmutableProofTaskPayload } from '@3sixty/immutable-proof-task';
+
+const payload: IImmutableProofTaskPayload = {
+  proofId: 'immutable-proof:01JABCDEF1234567890',
+  identity: 'did:iota:tst:issuer',
+  identityConnectorType: 'identity',
+  verificationMethodId: 'immutable-proof-assertion',
+  credentialSubject: {
+    '@context': [
+      'https://schema.3sixty.global/immutable-proof',
+      'https://schema.3sixty.global/common'
+    ],
+    type: 'ImmutableProof',
+    id: 'https://example.org/documents/100',
+    proofIntegrity: 'yEr9VvYCGDh2Ww1YwQMehUy4LlW35mLhX8j8R8U6x0g='
+  }
+};
+
+console.log(payload.identity); // did:iota:tst:issuer
+```
+
+```typescript
+import { processProofTask } from '@3sixty/immutable-proof-task';
+
+const engineCloneData = {
+  factories: {},
+  components: {}
+};
+
+const result = await processProofTask(engineCloneData, {
+  proofId: 'immutable-proof:01JABCDEF1234567890',
+  identity: 'did:iota:tst:issuer',
+  identityConnectorType: 'identity',
+  verificationMethodId: 'immutable-proof-assertion',
+  credentialSubject: {
+    '@context': [
+      'https://schema.3sixty.global/immutable-proof',
+      'https://schema.3sixty.global/common'
+    ],
+    type: 'ImmutableProof',
+    id: 'https://example.org/documents/100',
+    proofIntegrity: 'yEr9VvYCGDh2Ww1YwQMehUy4LlW35mLhX8j8R8U6x0g='
+  }
+});
+
+console.log(result.proofId); // immutable-proof:01JABCDEF1234567890
+```

package/docs/reference/functions/processProofTask.md

@@ -0,0 +1,26 @@
+# Function: processProofTask()
+
+> **processProofTask**(`engineCloneData`, `payload`): `Promise`\<[`IImmutableProofTaskResult`](../interfaces/IImmutableProofTaskResult.md)\>
+
+Process a proof task by creating a verifiable credential and notarizing it. Waits for the
+worker's engine clone to finish starting, building it if it hasn't started yet.
+
+## Parameters
+
+### engineCloneData
+
+`unknown`
+
+The engine clone data used to initialize a cloned engine instance when running in a separate thread.
+
+### payload
+
+[`IImmutableProofTaskPayload`](../interfaces/IImmutableProofTaskPayload.md)
+
+The payload containing the proof parameters.
+
+## Returns
+
+`Promise`\<[`IImmutableProofTaskResult`](../interfaces/IImmutableProofTaskResult.md)\>
+
+The task result containing the verifiable credential and notarization id.

package/docs/reference/functions/processProofTaskEnd.md

@@ -0,0 +1,19 @@
+# Function: processProofTaskEnd()
+
+> **processProofTaskEnd**(`loggingComponentType?`): `Promise`\<`void`\>
+
+Stop the worker's engine clone. Registered as the background task handler's shutdownMethod.
+
+## Parameters
+
+### loggingComponentType?
+
+`string`
+
+The logging component type to use for step logging, if configured.
+
+## Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves once the engine has stopped, even if stopping failed.

package/docs/reference/functions/processProofTaskStart.md

@@ -0,0 +1,27 @@
+# Function: processProofTaskStart()
+
+> **processProofTaskStart**(`engineCloneData`, `loggingComponentType?`): `Promise`\<`void`\>
+
+Build and start the worker's engine clone. Registered as the background task handler's
+initialiseMethod, so it runs once per worker instead of once per task.
+
+## Parameters
+
+### engineCloneData
+
+`unknown`
+
+The engine clone data used to initialize a cloned engine instance when
+running in a separate thread. Empty when not running in a worker thread (e.g. in tests).
+
+### loggingComponentType?
+
+`string`
+
+The logging component type to use for step logging, if configured.
+
+## Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves once the engine has started.

package/docs/reference/index.md

@@ -0,0 +1,12 @@
+# @3sixty/immutable-proof-task
+
+## Interfaces
+
+- [IImmutableProofTaskPayload](interfaces/IImmutableProofTaskPayload.md)
+- [IImmutableProofTaskResult](interfaces/IImmutableProofTaskResult.md)
+
+## Functions
+
+- [processProofTaskStart](functions/processProofTaskStart.md)
+- [processProofTaskEnd](functions/processProofTaskEnd.md)
+- [processProofTask](functions/processProofTask.md)

package/docs/reference/interfaces/IImmutableProofTaskPayload.md

@@ -0,0 +1,69 @@
+# Interface: IImmutableProofTaskPayload
+
+The payload for the immutable proof task.
+
+## Properties
+
+### proofId {#proofid}
+
+> **proofId**: `string`
+
+The proof id.
+
+***
+
+### identity {#identity}
+
+> **identity**: `string`
+
+The identity to create the proof for.
+
+***
+
+### identityConnectorType {#identityconnectortype}
+
+> **identityConnectorType**: `string`
+
+The identity connector type.
+
+***
+
+### verificationMethodId {#verificationmethodid}
+
+> **verificationMethodId**: `string`
+
+The assertion method id.
+
+***
+
+### credentialSubject {#credentialsubject}
+
+> **credentialSubject**: `IImmutableProof`
+
+The subject to create the proof for.
+
+***
+
+### notarizationConnectorType {#notarizationconnectortype}
+
+> **notarizationConnectorType**: `string`
+
+The notarization connector type.
+
+***
+
+### deleteLockDateTime? {#deletelockdatetime}
+
+> `optional` **deleteLockDateTime?**: `string`
+
+An ISO 8601 date-time string specifying when the notarization lock expires.
+If omitted, no deletion lock is applied.
+
+***
+
+### loggingComponentType? {#loggingcomponenttype}
+
+> `optional` **loggingComponentType?**: `string`
+
+The logging component type to use for step logging inside the task.
+If omitted, no step logging is performed.

package/docs/reference/interfaces/IImmutableProofTaskResult.md

@@ -0,0 +1,38 @@
+# Interface: IImmutableProofTaskResult
+
+The result for the immutable proof task.
+
+## Properties
+
+### proofId {#proofid}
+
+> **proofId**: `string`
+
+The proof id.
+
+***
+
+### verifiableCredential {#verifiablecredential}
+
+> **verifiableCredential**: `IDidVerifiableCredential`
+
+The verifiable credential produced by the proof task.
+
+***
+
+### notarizationId? {#notarizationid}
+
+> `optional` **notarizationId?**: `string`
+
+The notarization id returned after storing the proof.
+Not set when the notarization phase failed, see notarizationError.
+
+***
+
+### notarizationError? {#notarizationerror}
+
+> `optional` **notarizationError?**: `IError`
+
+Set when the notarization phase failed. The failure is returned in the result
+instead of being thrown, because the notarization may have reached the ledger
+even though the call failed, and a retry could create a duplicate on-chain object.

package/locales/en.json

@@ -0,0 +1,19 @@
+{
+	"debug": {
+		"immutableProofTask": {
+			"taskEngineStarted": "The proof task worker engine started in {elapsedMs}ms",
+			"taskVerifiableCredentialCreated": "The verifiable credential for proof \"{proofId}\" was created in {elapsedMs}ms",
+			"taskNotarizationComplete": "The notarization for proof \"{proofId}\" completed in {elapsedMs}ms, total task time {totalElapsedMs}ms"
+		}
+	},
+	"error": {
+		"immutableProofTask": {
+			"taskNotarizationFailed": "The notarization for proof \"{proofId}\" failed after {elapsedMs}ms, the task will not be retried as the notarization may already be on the ledger"
+		}
+	},
+	"warn": {
+		"immutableProofTask": {
+			"taskEngineStopFailed": "Stopping the proof task worker engine failed, a new engine will be started for the next task"
+		}
+	}
+}

package/package.json

@@ -1,6 +1,56 @@
 {
-  "name": "@3sixty/immutable-proof-task",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/immutable-proof-task",
+	"version": "0.20.0-next.1",
+	"description": "Background proof processing that creates verifiable credentials from prepared payloads",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/immutable-proof.git",
+		"directory": "packages/immutable-proof-task"
+	},
+	"author": "martyn.janes@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/context": "next",
+		"@3sixty/core": "next",
+		"@3sixty/data-json-ld": "next",
+		"@3sixty/identity-models": "next",
+		"@3sixty/immutable-proof-models": "0.20.0-next.1",
+		"@3sixty/logging-models": "next",
+		"@3sixty/modules": "next",
+		"@3sixty/nameof": "next",
+		"@3sixty/notarization-models": "next",
+		"@3sixty/standards-w3c-did": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		},
+		"./locales/*.json": "./locales/*.json"
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"immutable-proof"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/immutable-proof/issues"
+	},
+	"homepage": "https://3sixty.global"
+}