fix: jsonld document loader node 18 (openwallet-foundation#1454)

Signed-off-by: Timo Glastra <[email protected]> Signed-off-by: Ariel Gentile <[email protected]>
genaris · Jan 29, 2024 · 9569daf · 9569daf
1 parent 805ffd2
commit 9569daf
Show file tree

Hide file tree

Showing 24 changed files with 549 additions and 131 deletions.
diff --git a/packages/bbs-signatures/src/signature-suites/BbsBlsSignature2020.ts b/packages/bbs-signatures/src/signature-suites/BbsBlsSignature2020.ts
@@ -113,15 +113,14 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    * @returns {Promise<object>} Resolves with the created proof object.
    */
   public async createProof(options: CreateProofOptions): Promise<Record<string, unknown>> {
-    const { document, purpose, documentLoader, expansionMap, compactProof } = options
+    const { document, purpose, documentLoader, compactProof } = options
 
     let proof: JsonObject
 
     // use proof JSON-LD document passed to API
     if (this.proof) {
       proof = await jsonld.compact(this.proof, SECURITY_CONTEXT_URL, {
         documentLoader,
-        expansionMap,
         compactToRelative: true,
       })
     } else {
@@ -159,7 +158,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
       document,
       suite: this,
       documentLoader,
-      expansionMap,
     })
 
     // create data to sign
@@ -168,7 +166,7 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
         document,
         proof,
         documentLoader,
-        expansionMap,
+
         compactProof,
       })
     ).map((item) => new Uint8Array(TypedArrayEncoder.fromString(item)))
@@ -179,7 +177,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
       document,
       proof,
       documentLoader,
-      expansionMap,
     })
     delete proof['@context']
 
@@ -192,7 +189,7 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    * @returns {Promise<{object}>} Resolves with the verification result.
    */
   public async verifyProof(options: VerifyProofOptions): Promise<Record<string, unknown>> {
-    const { proof, document, documentLoader, expansionMap, purpose } = options
+    const { proof, document, documentLoader, purpose } = options
 
     try {
       // create data to verify
@@ -201,7 +198,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
           document,
           proof,
           documentLoader,
-          expansionMap,
           compactProof: false,
         })
       ).map((item) => new Uint8Array(TypedArrayEncoder.fromString(item)))
@@ -219,7 +215,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
         document,
         proof,
         documentLoader,
-        expansionMap,
       })
       if (!verified) {
         throw new Error('Invalid signature.')
@@ -231,7 +226,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
         suite: this,
         verificationMethod,
         documentLoader,
-        expansionMap,
       })
       if (!valid) {
         throw error
@@ -244,24 +238,22 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
   }
 
   public async canonize(input: Record<string, unknown>, options: CanonizeOptions): Promise<string> {
-    const { documentLoader, expansionMap, skipExpansion } = options
+    const { documentLoader, skipExpansion } = options
     return jsonld.canonize(input, {
       algorithm: 'URDNA2015',
       format: 'application/n-quads',
       documentLoader,
-      expansionMap,
       skipExpansion,
       useNative: this.useNativeCanonize,
     })
   }
 
   public async canonizeProof(proof: Record<string, unknown>, options: CanonizeOptions): Promise<string> {
-    const { documentLoader, expansionMap } = options
+    const { documentLoader } = options
     proof = { ...proof }
     delete proof[this.proofSignatureKey]
     return this.canonize(proof, {
       documentLoader,
-      expansionMap,
       skipExpansion: false,
     })
   }
@@ -272,17 +264,15 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    * @returns {Promise<{string[]>}.
    */
   public async createVerifyData(options: CreateVerifyDataOptions): Promise<string[]> {
-    const { proof, document, documentLoader, expansionMap } = options
+    const { proof, document, documentLoader } = options
 
     const proof2 = { ...proof, '@context': document['@context'] }
 
     const proofStatements = await this.createVerifyProofData(proof2, {
       documentLoader,
-      expansionMap,
     })
     const documentStatements = await this.createVerifyDocumentData(document, {
       documentLoader,
-      expansionMap,
     })
 
     // concatenate c14n proof options and c14n document
@@ -297,11 +287,10 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    */
   public async createVerifyProofData(
     proof: Record<string, unknown>,
-    { documentLoader, expansionMap }: { documentLoader?: DocumentLoader; expansionMap?: () => void }
+    { documentLoader }: { documentLoader?: DocumentLoader }
   ): Promise<string[]> {
     const c14nProofOptions = await this.canonizeProof(proof, {
       documentLoader,
-      expansionMap,
     })
 
     return c14nProofOptions.split('\n').filter((_) => _.length > 0)
@@ -315,11 +304,10 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    */
   public async createVerifyDocumentData(
     document: Record<string, unknown>,
-    { documentLoader, expansionMap }: { documentLoader?: DocumentLoader; expansionMap?: () => void }
+    { documentLoader }: { documentLoader?: DocumentLoader }
   ): Promise<string[]> {
     const c14nDocument = await this.canonize(document, {
       documentLoader,
-      expansionMap,
     })
 
     return c14nDocument.split('\n').filter((_) => _.length > 0)
@@ -329,7 +317,6 @@ export class BbsBlsSignature2020 extends LinkedDataProof {
    * @param document {object} to be signed.
    * @param proof {object}
    * @param documentLoader {function}
-   * @param expansionMap {function}
    */
   public async getVerificationMethod({
     proof,

diff --git a/packages/bbs-signatures/src/signature-suites/BbsBlsSignatureProof2020.ts b/packages/bbs-signatures/src/signature-suites/BbsBlsSignatureProof2020.ts
@@ -62,7 +62,7 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
    * @returns {Promise<object>} Resolves with the derived proof object.
    */
   public async deriveProof(options: DeriveProofOptions): Promise<Record<string, unknown>> {
-    const { document, proof, revealDocument, documentLoader, expansionMap } = options
+    const { document, proof, revealDocument, documentLoader } = options
     let { nonce } = options
 
     const proofType = proof.type
@@ -98,7 +98,6 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
       // use proof JSON-LD document passed to API
       derivedProof = await jsonld.compact(this.proof, SECURITY_CONTEXT_URL, {
         documentLoader,
-        expansionMap,
         compactToRelative: false,
       })
     } else {
@@ -112,13 +111,11 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
     // Get the input document statements
     const documentStatements = await suite.createVerifyDocumentData(document, {
       documentLoader,
-      expansionMap,
     })
 
     // Get the proof statements
     const proofStatements = await suite.createVerifyProofData(proof, {
       documentLoader,
-      expansionMap,
     })
 
     // Transform any blank node identifiers for the input
@@ -137,7 +134,6 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
     // Canonicalize the resulting reveal document
     const revealDocumentStatements = await suite.createVerifyDocumentData(revealDocumentResult, {
       documentLoader,
-      expansionMap,
     })
 
     //Get the indicies of the revealed statements from the transformed input document offset
@@ -216,7 +212,7 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
    * @returns {Promise<{object}>} Resolves with the verification result.
    */
   public async verifyProof(options: VerifyProofOptions): Promise<VerifyProofResult> {
-    const { document, documentLoader, expansionMap, purpose } = options
+    const { document, documentLoader, purpose } = options
     const { proof } = options
 
     try {
@@ -227,13 +223,11 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
       // Get the proof statements
       const proofStatements = await this.createVerifyProofData(proofIncludingDocumentContext, {
         documentLoader,
-        expansionMap,
       })
 
       // Get the document statements
       const documentStatements = await this.createVerifyProofData(document, {
         documentLoader,
-        expansionMap,
       })
 
       // Transform the blank node identifier placeholders for the document statements
@@ -278,7 +272,6 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
         suite: this,
         verificationMethod,
         documentLoader,
-        expansionMap,
       })
       if (!valid) {
         throw error
@@ -291,27 +284,25 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
   }
 
   public async canonize(input: JsonObject, options: CanonizeOptions): Promise<string> {
-    const { documentLoader, expansionMap, skipExpansion } = options
+    const { documentLoader, skipExpansion } = options
     return jsonld.canonize(input, {
       algorithm: 'URDNA2015',
       format: 'application/n-quads',
       documentLoader,
-      expansionMap,
       skipExpansion,
       useNative: this.useNativeCanonize,
     })
   }
 
   public async canonizeProof(proof: JsonObject, options: CanonizeOptions): Promise<string> {
-    const { documentLoader, expansionMap } = options
+    const { documentLoader } = options
     proof = { ...proof }
 
     delete proof.nonce
     delete proof.proofValue
 
     return this.canonize(proof, {
       documentLoader,
-      expansionMap,
       skipExpansion: false,
     })
   }
@@ -322,15 +313,13 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
    * @returns {Promise<{string[]>}.
    */
   public async createVerifyData(options: CreateVerifyDataOptions): Promise<string[]> {
-    const { proof, document, documentLoader, expansionMap } = options
+    const { proof, document, documentLoader } = options
 
     const proofStatements = await this.createVerifyProofData(proof, {
       documentLoader,
-      expansionMap,
     })
     const documentStatements = await this.createVerifyDocumentData(document, {
       documentLoader,
-      expansionMap,
     })
 
     // concatenate c14n proof options and c14n document
@@ -345,11 +334,10 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
    */
   public async createVerifyProofData(
     proof: JsonObject,
-    { documentLoader, expansionMap }: { documentLoader?: DocumentLoader; expansionMap?: () => void }
+    { documentLoader }: { documentLoader?: DocumentLoader }
   ): Promise<string[]> {
     const c14nProofOptions = await this.canonizeProof(proof, {
       documentLoader,
-      expansionMap,
     })
 
     return c14nProofOptions.split('\n').filter((_) => _.length > 0)
@@ -363,11 +351,10 @@ export class BbsBlsSignatureProof2020 extends LinkedDataProof {
    */
   public async createVerifyDocumentData(
     document: JsonObject,
-    { documentLoader, expansionMap }: { documentLoader?: DocumentLoader; expansionMap?: () => void }
+    { documentLoader }: { documentLoader?: DocumentLoader }
   ): Promise<string[]> {
     const c14nDocument = await this.canonize(document, {
       documentLoader,
-      expansionMap,
     })
 
     return c14nDocument.split('\n').filter((_) => _.length > 0)

diff --git a/packages/bbs-signatures/src/types/CanonizeOptions.ts b/packages/bbs-signatures/src/types/CanonizeOptions.ts
@@ -21,11 +21,7 @@ export interface CanonizeOptions {
    * Optional custom document loader
    */
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  // eslint-disable-next-line
-  expansionMap?: () => void
+
   /**
    * Indicates whether to skip expansion during canonization
    */

diff --git a/packages/bbs-signatures/src/types/CreateProofOptions.ts b/packages/bbs-signatures/src/types/CreateProofOptions.ts
@@ -29,10 +29,6 @@ export interface CreateProofOptions {
    * Optional custom document loader
    */
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  expansionMap?: () => void
   /**
    * Indicates whether to compact the resulting proof
    */

diff --git a/packages/bbs-signatures/src/types/CreateVerifyDataOptions.ts b/packages/bbs-signatures/src/types/CreateVerifyDataOptions.ts
@@ -21,20 +21,17 @@ export interface CreateVerifyDataOptions {
    * Document to create the proof for
    */
   readonly document: JsonObject
+
   /**
    * The proof
    */
   readonly proof: JsonObject
+
   /**
    * Optional custom document loader
    */
-
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
 
-  expansionMap?: () => void
   /**
    * Indicates whether to compact the proof
    */

diff --git a/packages/bbs-signatures/src/types/DeriveProofOptions.ts b/packages/bbs-signatures/src/types/DeriveProofOptions.ts
@@ -34,11 +34,7 @@ export interface DeriveProofOptions {
    */
   // eslint-disable-next-line
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  // eslint-disable-next-line
-  expansionMap?: () => void
+
   /**
    * Nonce to include in the derived proof
    */

diff --git a/packages/bbs-signatures/src/types/SuiteSignOptions.ts b/packages/bbs-signatures/src/types/SuiteSignOptions.ts
@@ -25,10 +25,7 @@ export interface SuiteSignOptions {
    * Optional custom document loader
    */
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  expansionMap?: () => void
+
   /**
    * The array of statements to sign
    */

diff --git a/packages/bbs-signatures/src/types/VerifyProofOptions.ts b/packages/bbs-signatures/src/types/VerifyProofOptions.ts
@@ -33,8 +33,4 @@ export interface VerifyProofOptions {
    * Optional custom document loader
    */
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  expansionMap?: () => void
 }
diff --git a/packages/bbs-signatures/src/types/VerifySignatureOptions.ts b/packages/bbs-signatures/src/types/VerifySignatureOptions.ts
@@ -37,8 +37,4 @@ export interface VerifySignatureOptions {
    * Optional custom document loader
    */
   documentLoader?: DocumentLoader
-  /**
-   * Optional expansion map
-   */
-  expansionMap?: () => void
 }