@twin.org/immutable-proof-service 0.0.1-next.5 → 0.0.1-next.7

package/dist/cjs/index.cjs

@@ -335,10 +335,10 @@ class ImmutableProofService {
      */
     _assertionMethodId;
     /**
-     * The proof config key id to use for the proofs.
+     * The proof hash key id to use for the proofs.
      * @internal
      */
-    _proofConfigKeyId;
+    _proofHashKeyId;
     /**
      * Are we currently processing proofs.
      * @internal
@@ -359,8 +359,8 @@ class ImmutableProofService {
         this._immutableStorage = immutableStorageModels.ImmutableStorageConnectorFactory.get(options?.immutableStorageType ?? "immutable-storage");
         this._identityConnector = identityModels.IdentityConnectorFactory.get(options?.identityConnectorType ?? "identity");
         this._config = options?.config ?? {};
-        this._assertionMethodId = this._config.assertionMethodId ?? "immutable-proof";
-        this._proofConfigKeyId = this._config.proofConfigKeyId ?? "immutable-proof";
+        this._assertionMethodId = this._config.assertionMethodId ?? "immutable-proof-assertion";
+        this._proofHashKeyId = this._config.proofHashKeyId ?? "immutable-proof-hash";
         this._processing = false;
     }
     /**
@@ -557,7 +557,6 @@ class ImmutableProofService {
                 // As we are adding the proof to the data we update its context
                 immutableProof["@context"] = [
                     immutableProofModels.ImmutableProofTypes.ContextRoot,
-                    immutableStorageModels.ImmutableStorageTypes.ContextRoot,
                     standardsW3cDid.DidContexts.ContextVCDataIntegrity
                 ];
                 immutableProof.proof = await this._identityConnector.createProof(proofEntity.nodeIdentity, `${proofEntity.nodeIdentity}#${this._assertionMethodId}`, hashData);
@@ -603,6 +602,10 @@ class ImmutableProofService {
             if (core.Is.uint8Array(immutableResult.data)) {
                 proofModel = core.ObjectHelper.fromBytes(immutableResult.data);
                 proofModel.immutableReceipt = immutableResult.receipt;
+                // As we are adding the receipt to the data we update its context
+                if (core.Is.array(proofModel["@context"])) {
+                    proofModel["@context"].push(immutableStorageModels.ImmutableStorageTypes.ContextRoot);
+                }
                 if (core.Is.object(proofModel.proof) && core.Is.object(proofObject)) {
                     if (proofModel.proof.cryptosuite !== standardsW3cDid.DidCryptoSuites.EdDSAJcs2022) {
                         failure = immutableProofModels.ImmutableProofFailure.CryptoSuiteMismatch;
@@ -639,17 +642,17 @@ class ImmutableProofService {
      * @internal
      */
     async generateHashData(nodeIdentity, immutableProof) {
-        // We hash the data for the proof with the proof or immutable receipt for the proof
+        // We hash the data for the proof without the the proof or immutable receipt for the proof
         // without these objects we can simplify the context
         const object = core.ObjectHelper.omit(immutableProof, ["proof", "immutableReceipt"]);
         object["@context"] = immutableProofModels.ImmutableProofTypes.ContextRoot;
         const canonicalDocument = core.JsonHelper.canonicalize(object);
-        const proofConfigKey = await this._vaultConnector.getKey(`${nodeIdentity}/${this._proofConfigKeyId}`);
-        const proofConfigHash = crypto.Sha256.sum256(proofConfigKey.privateKey);
+        const proofKey = await this._vaultConnector.getKey(`${nodeIdentity}/${this._proofHashKeyId}`);
+        const proofHash = crypto.Sha256.sum256(proofKey.privateKey);
         const transformedDocumentHash = crypto.Sha256.sum256(core.Converter.utf8ToBytes(canonicalDocument));
-        const hashData = new Uint8Array(proofConfigHash.length + transformedDocumentHash.length);
-        hashData.set(proofConfigHash);
-        hashData.set(transformedDocumentHash, proofConfigHash.length);
+        const hashData = new Uint8Array(proofHash.length + transformedDocumentHash.length);
+        hashData.set(proofHash);
+        hashData.set(transformedDocumentHash, proofHash.length);
         return hashData;
     }
 }

package/dist/esm/index.mjs

@@ -333,10 +333,10 @@ class ImmutableProofService {
      */
     _assertionMethodId;
     /**
-     * The proof config key id to use for the proofs.
+     * The proof hash key id to use for the proofs.
      * @internal
      */
-    _proofConfigKeyId;
+    _proofHashKeyId;
     /**
      * Are we currently processing proofs.
      * @internal
@@ -357,8 +357,8 @@ class ImmutableProofService {
         this._immutableStorage = ImmutableStorageConnectorFactory.get(options?.immutableStorageType ?? "immutable-storage");
         this._identityConnector = IdentityConnectorFactory.get(options?.identityConnectorType ?? "identity");
         this._config = options?.config ?? {};
-        this._assertionMethodId = this._config.assertionMethodId ?? "immutable-proof";
-        this._proofConfigKeyId = this._config.proofConfigKeyId ?? "immutable-proof";
+        this._assertionMethodId = this._config.assertionMethodId ?? "immutable-proof-assertion";
+        this._proofHashKeyId = this._config.proofHashKeyId ?? "immutable-proof-hash";
         this._processing = false;
     }
     /**
@@ -555,7 +555,6 @@ class ImmutableProofService {
                 // As we are adding the proof to the data we update its context
                 immutableProof["@context"] = [
                     ImmutableProofTypes.ContextRoot,
-                    ImmutableStorageTypes.ContextRoot,
                     DidContexts.ContextVCDataIntegrity
                 ];
                 immutableProof.proof = await this._identityConnector.createProof(proofEntity.nodeIdentity, `${proofEntity.nodeIdentity}#${this._assertionMethodId}`, hashData);
@@ -601,6 +600,10 @@ class ImmutableProofService {
             if (Is.uint8Array(immutableResult.data)) {
                 proofModel = ObjectHelper.fromBytes(immutableResult.data);
                 proofModel.immutableReceipt = immutableResult.receipt;
+                // As we are adding the receipt to the data we update its context
+                if (Is.array(proofModel["@context"])) {
+                    proofModel["@context"].push(ImmutableStorageTypes.ContextRoot);
+                }
                 if (Is.object(proofModel.proof) && Is.object(proofObject)) {
                     if (proofModel.proof.cryptosuite !== DidCryptoSuites.EdDSAJcs2022) {
                         failure = ImmutableProofFailure.CryptoSuiteMismatch;
@@ -637,17 +640,17 @@ class ImmutableProofService {
      * @internal
      */
     async generateHashData(nodeIdentity, immutableProof) {
-        // We hash the data for the proof with the proof or immutable receipt for the proof
+        // We hash the data for the proof without the the proof or immutable receipt for the proof
         // without these objects we can simplify the context
         const object = ObjectHelper.omit(immutableProof, ["proof", "immutableReceipt"]);
         object["@context"] = ImmutableProofTypes.ContextRoot;
         const canonicalDocument = JsonHelper.canonicalize(object);
-        const proofConfigKey = await this._vaultConnector.getKey(`${nodeIdentity}/${this._proofConfigKeyId}`);
-        const proofConfigHash = Sha256.sum256(proofConfigKey.privateKey);
+        const proofKey = await this._vaultConnector.getKey(`${nodeIdentity}/${this._proofHashKeyId}`);
+        const proofHash = Sha256.sum256(proofKey.privateKey);
         const transformedDocumentHash = Sha256.sum256(Converter.utf8ToBytes(canonicalDocument));
-        const hashData = new Uint8Array(proofConfigHash.length + transformedDocumentHash.length);
-        hashData.set(proofConfigHash);
-        hashData.set(transformedDocumentHash, proofConfigHash.length);
+        const hashData = new Uint8Array(proofHash.length + transformedDocumentHash.length);
+        hashData.set(proofHash);
+        hashData.set(transformedDocumentHash, proofHash.length);
         return hashData;
     }
 }

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

@@ -4,12 +4,12 @@
 export interface IImmutableProofServiceConfig {
     /**
      * The assertion method id to use for the stream.
-     * @default immutable-proof
+     * @default immutable-proof-assertion
      */
     assertionMethodId?: string;
     /**
-     * The key to use in the proof config.
-     * @default immutable-proof
+     * The key to use in the proof hash.
+     * @default immutable-proof-hash
      */
-    proofConfigKeyId?: string;
+    proofHashKeyId?: string;
 }

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/immutable-proof-service - Changelog
 
-## v0.0.1-next.5
+## v0.0.1-next.7
 
 - Initial Release

package/docs/reference/interfaces/IImmutableProofServiceConfig.md

@@ -13,19 +13,19 @@ The assertion method id to use for the stream.
 #### Default
 
 ```ts
-immutable-proof
+immutable-proof-assertion
 ```
 
 ***
 
-### proofConfigKeyId?
+### proofHashKeyId?
 
-> `optional` **proofConfigKeyId**: `string`
+> `optional` **proofHashKeyId**: `string`
 
-The key to use in the proof config.
+The key to use in the proof hash.
 
 #### Default
 
 ```ts
-immutable-proof
+immutable-proof-hash
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/immutable-proof-service",
-	"version": "0.0.1-next.5",
+	"version": "0.0.1-next.7",
 	"description": "Immutable proof contract implementation and REST endpoint definitions",
 	"repository": {
 		"type": "git",
@@ -22,7 +22,7 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/identity-models": "next",
-		"@twin.org/immutable-proof-models": "0.0.1-next.5",
+		"@twin.org/immutable-proof-models": "0.0.1-next.7",
 		"@twin.org/immutable-storage-models": "next",
 		"@twin.org/nameof": "next",
 		"@twin.org/standards-w3c-did": "next",