Fix docs and add few helpers

Signed-off-by: lovesh <lovesh.bond@gmail.com>

Author: lovesh

.run/prefilled-positive-accumulator.spec.ts.run.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="prefilled-positive-accumulator.spec.ts" type="JavaScriptTestRunnerJest" nameIsGenerated="true">
+    <node-interpreter value="$USER_HOME$/.nvm/versions/node/v14.18.1/bin/node" />
+    <node-options value="" />
+    <jest-package value="$PROJECT_DIR$/node_modules/jest" />
+    <working-dir value="$PROJECT_DIR$" />
+    <envs />
+    <scope-kind value="TEST_FILE" />
+    <test-file value="$PROJECT_DIR$/tests/prefilled-positive-accumulator.spec.ts" />
+    <method v="2" />
+  </configuration>
+</component>

README.md

@@ -829,7 +829,7 @@ For a more involved demo with multiple BBS+ signatures being used with accumulat
 before requesting blind signatures, see [here](./tests/demo.spec.ts). This test paints a picture where before getting any credential, 
 a user has to prove possession of a credential and membership in an accumulator (except the 1st credential).
 
-##### Verifiable encryption using SAVER
+### Verifiable encryption using SAVER
 
 Note: This section assumes you have read some of the previous examples on composite proof.
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docknetwork/crypto-wasm-ts",
-  "version": "0.12.0",
+  "version": "0.13.0",
   "description": "Typescript abstractions over Dock's Rust crypto library's WASM wrapper",
   "homepage": "https://github.com/docknetwork/crypto-wasm-ts",
   "main": "lib/crypto-wasm-ts/src/index.js",

src/ICompressed.ts

@@ -14,7 +14,7 @@ export interface ICompressed<UncompressedType> {
   readonly value: Uint8Array;
 
   /**
-   * Convert the uncompressed
+   * Convert to uncompressed form
    */
   decompress(): UncompressedType;
 }

src/accumulator/accumulator.ts

@@ -1,12 +1,7 @@
 import {
-  accumulatorDeriveMembershipProvingKeyFromNonMembershipKey,
-  generateAccumulatorKeyPair,
   generateFieldElementFromBytes,
   generateFieldElementFromNumber,
-  generateMembershipProvingKey,
-  generateNonMembershipProvingKey,
   generateRandomFieldElement,
-  IKeypair,
   positiveAccumulatorAdd,
   positiveAccumulatorAddBatch,
   positiveAccumulatorBatchUpdates,
@@ -36,7 +31,7 @@ import {
   universalAccumulatorVerifyNonMembership
 } from '@docknetwork/crypto-wasm';
 import { MembershipWitness, NonMembershipWitness } from './accumulatorWitness';
-import { getUint8ArraysFromObject } from '../util';
+import { ensurePositiveIntegerOfSize, getUint8ArraysFromObject } from '../util';
 import { IAccumulatorState, IUniversalAccumulatorState } from './IAccumulatorState';
 import { IInitialElementsStore } from './IInitialElementsStore';
 import {
@@ -98,6 +93,7 @@ export abstract class Accumulator {
    * @param num - should be a positive integer
    */
   static encodePositiveNumberAsAccumulatorMember(num: number): Uint8Array {
+    ensurePositiveIntegerOfSize(num, 32);
     return generateFieldElementFromNumber(num);
   }
 
@@ -614,8 +610,8 @@ export class UniversalAccumulator extends Accumulator {
 
     // store the products of each batch
     const products: Uint8Array[] = [];
-    // The first batch of products is the elements fixed for each curve, in this case it's for BLS12-381
-    const fixed = universalAccumulatorFixedInitialElements();
+    // The first batch of products is the elements fixed for each curve
+    const fixed = UniversalAccumulator.fixedInitialElements();
     if (storePresent) {
       for (const i of fixed) {
         await initialElementsStore.add(i);
@@ -942,6 +938,14 @@ export class UniversalAccumulator extends Accumulator {
     return universalAccumulatorVerifyNonMembership(this.value.V, nonMember, witness.value, pk.value, params_.value);
   }
 
+  /**
+   * The first few members of a universal accumulator are fixed for each curve. These should be added to the curve
+   * before creating any witness and must never be removed.
+   */
+  static fixedInitialElements(): Uint8Array[] {
+    return universalAccumulatorFixedInitialElements();
+  }
+
   /**
    * Takes product of the form `initial_element_i + secret_key`.
    * @param initialElements

src/bbs-plus/signature.ts

@@ -8,8 +8,8 @@ import {
   bbsVerifyG1,
   generateRandomFieldElement
 } from '@docknetwork/crypto-wasm';
-import { isNumberBiggerThanNBits } from '../util';
 import { BBSPlusPublicKeyG2, BBSPlusSecretKey } from './keys';
+import { ensurePositiveIntegerOfSize } from '../util';
 
 export abstract class Signature {
   value: Uint8Array;
@@ -32,6 +32,7 @@ export abstract class Signature {
    * @param num
    */
   static encodePositiveNumberForSigning(num: number): Uint8Array {
+    ensurePositiveIntegerOfSize(num, 32);
     return generateFieldElementFromNumber(num);
   }
 

src/bytearray-wrapper.ts

@@ -8,4 +8,18 @@ export class BytearrayWrapper {
   constructor(value: Uint8Array) {
     this.value = value;
   }
+
+  /**
+   * Return the wrapped bytearray
+   */
+  get bytes(): Uint8Array {
+    return this.value;
+  }
+
+  /**
+   * Return the length of the wrapped bytearray
+   */
+  get length(): number {
+    return this.value.length;
+  }
 }

src/composite-proof/proof.ts

@@ -22,11 +22,23 @@ export class CompositeProofG1 {
     this.value = proof;
   }
 
+  /**
+   * Generate the composite proof using a `ProofSpec`
+   * @param proofSpec
+   * @param witnesses
+   * @param nonce
+   */
   static generate(proofSpec: ProofSpecG1, witnesses: Witnesses, nonce?: Uint8Array): CompositeProofG1 {
     const proof = generateCompositeProofG1(proofSpec.value, witnesses.values, nonce);
     return new CompositeProofG1(proof);
   }
 
+  /**
+   * Generate the composite proof using a `QuasiProofSpecG1`
+   * @param proofSpec
+   * @param witnesses
+   * @param nonce
+   */
   static generateUsingQuasiProofSpec(
     proofSpec: QuasiProofSpecG1,
     witnesses: Witnesses,
@@ -42,6 +54,40 @@ export class CompositeProofG1 {
     );
   }
 
+  /**
+   * Verify this composite proof using a `ProofSpec`
+   * @param proofSpec
+   * @param nonce
+   */
+  verify(proofSpec: ProofSpecG1, nonce?: Uint8Array): VerifyResult {
+    return verifyCompositeProofG1(this.value, proofSpec.value, nonce);
+  }
+
+  /**
+   * Verify this composite proof using a `QuasiProofSpecG1`
+   * @param proofSpec
+   * @param nonce
+   */
+  verifyUsingQuasiProofSpec(proofSpec: QuasiProofSpecG1, nonce?: Uint8Array): VerifyResult {
+    return this.verifyWithDeconstructedProofSpec(
+      proofSpec.statements,
+      proofSpec.metaStatements,
+      proofSpec.setupParams,
+      proofSpec.context,
+      nonce
+    );
+  }
+
+  /**
+   * Get the ciphertext for the SAVER statement at index `statementIndex`. The proof involving any SAVER statement also
+   * contains the ciphertext corresponding to that statement. Will throw an error if it could not find the ciphertext or
+   * statement at that index
+   * @param statementIndex
+   */
+  getSaverCiphertext(statementIndex: number): SaverCiphertext {
+    return new SaverCiphertext(saverGetCiphertextFromProof(this.value, statementIndex));
+  }
+
   static generateWithDeconstructedProofSpec(
     statements: Statements,
     metaStatements: MetaStatements,
@@ -62,20 +108,6 @@ export class CompositeProofG1 {
     return new CompositeProofG1(proof);
   }
 
-  verify(proofSpec: ProofSpecG1, nonce?: Uint8Array): VerifyResult {
-    return verifyCompositeProofG1(this.value, proofSpec.value, nonce);
-  }
-
-  verifyUsingQuasiProofSpec(proofSpec: QuasiProofSpecG1, nonce?: Uint8Array): VerifyResult {
-    return this.verifyWithDeconstructedProofSpec(
-      proofSpec.statements,
-      proofSpec.metaStatements,
-      proofSpec.setupParams,
-      proofSpec.context,
-      nonce
-    );
-  }
-
   verifyWithDeconstructedProofSpec(
     statements: Statements,
     metaStatements: MetaStatements,
@@ -93,13 +125,4 @@ export class CompositeProofG1 {
       nonce
     );
   }
-
-  /**
-   * Get the ciphertext for the SAVER statement at index `statementIndex`. The proof involving any SAVER statement also
-   * contains the ciphertext corresponding to that statement. Will throw an error if it could not find the ciphertext
-   * @param statementIndex
-   */
-  getSaverCiphertext(statementIndex: number): SaverCiphertext {
-    return new SaverCiphertext(saverGetCiphertextFromProof(this.value, statementIndex));
-  }
 }

src/index.ts

@@ -1,3 +1,4 @@
+export { initializeWasm } from '@docknetwork/crypto-wasm';
 export * from './util';
 export * from './bbs-plus';
 export * from './accumulator';

src/legosnark/index.ts

@@ -16,14 +16,14 @@ export class LegoProvingKey extends BytearrayWrapper implements ICompressed<Lego
   }
 
   /**
-   * Get compressed verifying key from proving key
+   * Get the compressed verifying key from this proving key
    */
   getVerifyingKey(): LegoVerifyingKey {
     return new LegoVerifyingKey(legosnarkVkFromPk(this.value, false));
   }
 
   /**
-   * Get uncompressed verifying key from proving key
+   * Get the uncompressed verifying key from this proving key
    */
   getVerifyingKeyUncompressed(): LegoVerifyingKeyUncompressed {
     return new LegoVerifyingKeyUncompressed(legosnarkVkFromPk(this.value, true));