more docs

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

Author: lovesh

.github/workflows/docs.yml

@@ -12,6 +12,7 @@ jobs:
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
+      - run: yarn install
 
       - name: Build docs
         run: yarn typedoc

src/accumulator/index.ts

@@ -6,4 +6,8 @@ export * from './IAccumulatorState';
 export * from './IInitialElementsStore';
 export * from './kb-universal-accumulator';
 export * from './kb-acccumulator-witness';
-export { VBWitnessUpdateInfo, KBUniversalMembershipWitnessUpdateInfo, KBUniversalNonMembershipWitnessUpdateInfo } from './witness-update-info';
+export {
+  VBWitnessUpdateInfo,
+  KBUniversalMembershipWitnessUpdateInfo,
+  KBUniversalNonMembershipWitnessUpdateInfo
+} from './witness-update-info';

src/accumulator/kb-universal-accumulator.ts

@@ -260,12 +260,7 @@ export class KBUniversalAccumulator extends Accumulator<KBUniversalAccumulatorVa
   ): KBUniversalMembershipWitnessUpdateInfo {
     const sk = this.getSecretKey(secretKey);
     return new KBUniversalMembershipWitnessUpdateInfo(
-      publicInfoForKBUniversalMemWitnessUpdate(
-        this.value.asInternalType,
-        additions,
-        removals,
-        sk.value
-      )
+      publicInfoForKBUniversalMemWitnessUpdate(this.value.asInternalType, additions, removals, sk.value)
     );
   }
 
@@ -276,12 +271,7 @@ export class KBUniversalAccumulator extends Accumulator<KBUniversalAccumulatorVa
   ): KBUniversalNonMembershipWitnessUpdateInfo {
     const sk = this.getSecretKey(secretKey);
     return new KBUniversalNonMembershipWitnessUpdateInfo(
-      publicInfoForKBUniversalNonMemWitnessUpdate(
-        this.value.asInternalType,
-        additions,
-        removals,
-        sk.value
-      )
+      publicInfoForKBUniversalNonMemWitnessUpdate(this.value.asInternalType, additions, removals, sk.value)
     );
   }
 
@@ -291,11 +281,7 @@ export class KBUniversalAccumulator extends Accumulator<KBUniversalAccumulatorVa
   ): KBUniversalNonMembershipWitnessUpdateInfo {
     const sk = this.getSecretKey(secretKey);
     return new KBUniversalNonMembershipWitnessUpdateInfo(
-      publicInfoForKBUniversalNonMemWitnessUpdateOnDomainExtension(
-        this.value.asInternalType,
-        newElements,
-        sk.value
-      )
+      publicInfoForKBUniversalNonMemWitnessUpdateOnDomainExtension(this.value.asInternalType, newElements, sk.value)
     );
   }
 
@@ -306,7 +292,7 @@ export class KBUniversalAccumulator extends Accumulator<KBUniversalAccumulatorVa
   ): [KBUniversalMembershipWitnessUpdateInfo, KBUniversalNonMembershipWitnessUpdateInfo] {
     const sk = this.getSecretKey(secretKey);
     const [m, nm] = publicInfoForBothKBUniversalWitnessUpdate(this.value.asInternalType, additions, removals, sk.value);
-    return [new KBUniversalMembershipWitnessUpdateInfo(m), new KBUniversalNonMembershipWitnessUpdateInfo(nm)]
+    return [new KBUniversalMembershipWitnessUpdateInfo(m), new KBUniversalNonMembershipWitnessUpdateInfo(nm)];
   }
 
   protected async checkBeforeAdd(element: Uint8Array, state?: IKBUniversalAccumulatorState) {

src/accumulator/params-and-keys.ts

@@ -132,7 +132,12 @@ export class AccumulatorParamsForKeyedVerification extends BytearrayWrapper {
 }
 
 export class AccumulatorPublicKeyForKeyedVerification extends BytearrayWrapper {
-  static generate(secretKey: AccumulatorSecretKey, params: AccumulatorParamsForKeyedVerification): AccumulatorPublicKeyForKeyedVerification {
-    return new AccumulatorPublicKeyForKeyedVerification(generateAccumulatorPublicKeyForKeyedVerification(secretKey.value, params.value));
+  static generate(
+    secretKey: AccumulatorSecretKey,
+    params: AccumulatorParamsForKeyedVerification
+  ): AccumulatorPublicKeyForKeyedVerification {
+    return new AccumulatorPublicKeyForKeyedVerification(
+      generateAccumulatorPublicKeyForKeyedVerification(secretKey.value, params.value)
+    );
   }
 }

src/accumulator/witness-update-info.ts

@@ -1,7 +1,8 @@
 import {
   publicInfoForWitnessUpdate,
   publicInfoForKBUniversalMemWitnessUpdate,
-  publicInfoForKBUniversalNonMemWitnessUpdate, publicInfoForKBUniversalNonMemWitnessUpdateOnDomainExtension
+  publicInfoForKBUniversalNonMemWitnessUpdate,
+  publicInfoForKBUniversalNonMemWitnessUpdateOnDomainExtension
 } from 'crypto-wasm-new';
 import { BytearrayWrapper } from '../bytearray-wrapper';
 import { fromLeToBigInt, jsonObjToUint8Array } from '../util';
@@ -42,6 +43,9 @@ export class VBWitnessUpdateInfo extends WitnessUpdateInfo {
   }
 }
 
+/**
+ * Public info published by the KB universal accumulator manager used to update membership witnesses after several additions and removals.
+ */
 export class KBUniversalMembershipWitnessUpdateInfo extends WitnessUpdateInfo {
   fromJSON(json: string): KBUniversalMembershipWitnessUpdateInfo {
     return new KBUniversalMembershipWitnessUpdateInfo(jsonObjToUint8Array(json));
@@ -146,9 +150,11 @@ export class KBUniversalWitnessUpdateInfo {
   toBytes(): Uint8Array {
     const memLength = this.mem ? this.mem.value.length : 0;
     if (memLength > KBUniversalWitnessUpdateInfo.maxLength) {
-      throw new Error(`Cannot support sizes greater than ${KBUniversalWitnessUpdateInfo.maxLength}`)
+      throw new Error(`Cannot support sizes greater than ${KBUniversalWitnessUpdateInfo.maxLength}`);
     }
-    const buf = Buffer.allocUnsafe(KBUniversalWitnessUpdateInfo.maxByteSize + memLength + (this.nonMem ? this.nonMem.value.length : 0));
+    const buf = Buffer.allocUnsafe(
+      KBUniversalWitnessUpdateInfo.maxByteSize + memLength + (this.nonMem ? this.nonMem.value.length : 0)
+    );
     // Write the byte size of membership witness update info in the first `maxByteSize` bytes in little-endian format
     buf.writeUIntLE(memLength, 0, KBUniversalWitnessUpdateInfo.maxByteSize);
     const merged = new Uint8Array(buf);
@@ -168,10 +174,18 @@ export class KBUniversalWitnessUpdateInfo {
   static fromBytes(bytes: Uint8Array): KBUniversalWitnessUpdateInfo {
     const memLength = fromLeToBigInt(bytes, KBUniversalWitnessUpdateInfo.maxByteSize);
     if (memLength > KBUniversalWitnessUpdateInfo.maxLength) {
-      throw new Error(`Cannot support sizes greater than ${KBUniversalWitnessUpdateInfo.maxLength}`)
+      throw new Error(`Cannot support sizes greater than ${KBUniversalWitnessUpdateInfo.maxLength}`);
     }
     // Create the update info if non-zero byte size found
-    const mem = memLength > 0 ? new KBUniversalMembershipWitnessUpdateInfo(bytes.slice(KBUniversalWitnessUpdateInfo.maxByteSize, KBUniversalWitnessUpdateInfo.maxByteSize + Number(memLength))) : undefined;
+    const mem =
+      memLength > 0
+        ? new KBUniversalMembershipWitnessUpdateInfo(
+            bytes.slice(
+              KBUniversalWitnessUpdateInfo.maxByteSize,
+              KBUniversalWitnessUpdateInfo.maxByteSize + Number(memLength)
+            )
+          )
+        : undefined;
     const nonMemVal = bytes.slice(KBUniversalWitnessUpdateInfo.maxByteSize + Number(memLength));
     const nonMem = nonMemVal.length > 0 ? new KBUniversalNonMembershipWitnessUpdateInfo(nonMemVal) : undefined;
     return new KBUniversalWitnessUpdateInfo(mem, nonMem);

src/anonymous-credentials/blinded-credential-builder.ts

@@ -3,7 +3,8 @@ import { CredentialBuilderCommon } from './credential-builder-common';
 import { IBlindCredentialRequest } from './presentation-specification';
 import {
   BBS_PLUS_SIGNATURE_PARAMS_LABEL_BYTES,
-  BBS_SIGNATURE_PARAMS_LABEL_BYTES, STATUS_STR,
+  BBS_SIGNATURE_PARAMS_LABEL_BYTES,
+  STATUS_STR,
   BBDT16_MAC_PARAMS_LABEL_BYTES
 } from './types-and-consts';
 import { BBSCredential, BBSPlusCredential, BBDT16Credential } from './credential';
@@ -36,9 +37,11 @@ export abstract class BlindedCredentialBuilder extends CredentialBuilderCommon {
     let knownAttributes = this.serializeForSigning();
     if (this.blindedCredReq.unBlindedAttributes !== undefined) {
       if (typeof this.blindedCredReq.unBlindedAttributes !== 'object') {
-        throw new Error(`Unblinded attributes were supposed to an object but found ${this.blindedCredReq.unBlindedAttributes}`)
+        throw new Error(
+          `Unblinded attributes were supposed to an object but found ${this.blindedCredReq.unBlindedAttributes}`
+        );
       }
-      knownAttributes = {...knownAttributes, ...this.blindedCredReq.unBlindedAttributes};
+      knownAttributes = { ...knownAttributes, ...this.blindedCredReq.unBlindedAttributes };
     }
     const encodedAttributes = new Map<number, Uint8Array>();
     Object.entries(schema.encoder.encodeMessageObjectAsObjectConstantTime(knownAttributes)).forEach(([name, value]) => {
@@ -50,12 +53,14 @@ export abstract class BlindedCredentialBuilder extends CredentialBuilderCommon {
   protected processUnBlindedAttributes() {
     if (this.blindedCredReq.unBlindedAttributes !== undefined) {
       if (typeof this.blindedCredReq.unBlindedAttributes !== 'object') {
-        throw new Error(`Unblinded attributes were supposed to an object but found ${this.blindedCredReq.unBlindedAttributes}`)
+        throw new Error(
+          `Unblinded attributes were supposed to an object but found ${this.blindedCredReq.unBlindedAttributes}`
+        );
       }
       for (const [name, value] of Object.entries(this.blindedCredReq.unBlindedAttributes)) {
         if (name === STATUS_STR) {
           if (this.credStatus !== undefined) {
-            throw new Error('credStatus was set by the signer when it was provided in request as well')
+            throw new Error('credStatus was set by the signer when it was provided in request as well');
           }
           this.credStatus = value;
         } else {

src/anonymous-credentials/blinded-credential-request-builder.ts

@@ -44,8 +44,10 @@ import {
   BlindSignatureType,
   BoundCheckParamType,
   BoundType,
-  ID_STR, MEM_CHECK_KV_STR,
-  MEM_CHECK_STR, NON_MEM_CHECK_KV_STR,
+  ID_STR,
+  MEM_CHECK_KV_STR,
+  MEM_CHECK_STR,
+  NON_MEM_CHECK_KV_STR,
   NON_MEM_CHECK_STR,
   PublicKey,
   REV_CHECK_STR,
@@ -64,43 +66,67 @@ type Credential = BBSCredential | BBSPlusCredential | PSCredential;
  * Creates a request for a blinded credential, i.e. where some of the attributes are not known to the signer
  */
 export abstract class BlindedCredentialRequestBuilder<SigParams> extends Versioned {
-  // NOTE: Follows semver and must be updated accordingly when the logic of this class changes or the
-  // underlying crypto changes.
+  /**
+   * Follows semver and must be updated accordingly when the logic of this class changes or the
+   * underlying crypto changes.
+   */
   static VERSION = '0.5.0';
 
-  // The schema of the whole (unblinded credential). This should include all attributes, i.e. blinded and unblinded
+  /**
+   * The schema of the whole (unblinded credential). This should include all attributes, i.e. blinded and unblinded
+   */
   _schema?: CredentialSchema;
 
-  // The attributes of the credential subject that will be blinded (hidden from the issuer)
+  /**
+   * The attributes of the credential subject that will be blinded (hidden from the issuer)
+   */
   _subjectToBlind?: object | object[];
 
-  // The credential status if blinded
+  /**
+   * The credential status if blinded
+   */
   _statusToBlind?: object;
 
-  // Any top level attributes to blind
+  /**
+   * Any top level attributes to blind
+   */
   _topLevelAttributesToBlind: Map<string, unknown>;
 
   protected sigParams?: SignatureParams;
 
-  // A blinded credential request will contain a presentation that will prove predicates about the credential attributes and blinded attributes.
+  /**
+   * A blinded credential request will contain a presentation that will prove predicates about the credential attributes and blinded attributes.
+   */
   presentationBuilder: PresentationBuilder;
 
-  // Equalities between blinded and credential attributes
+  /**
+   * Equalities between blinded and credential attributes
+   */
   attributeEqualities: BlindedAttributeEquality[];
 
-  // Attributes proved inequal to a public value in zero knowledge. An attribute can be proven inequal to any number of values
+  /**
+   * Attributes proved inequal to a public value in zero knowledge. An attribute can be proven inequal to any number of values
+   */
   attributeInequalities: Map<string, [IPresentedAttributeInequality, Uint8Array][]>;
 
-  // Bounds on blinded attributes
+  /**
+   * Bounds on blinded attributes
+   */
   bounds: Map<string, IPresentedAttributeBound[]>;
 
-  // Encryption of blinded attributes
+  /**
+   * Encryption of blinded attributes
+   */
   verifEnc: Map<string, IPresentedAttributeVE[]>;
 
-  // Circom predicates on blinded attributes
+  /**
+   * Circom predicates on blinded attributes
+   */
   circomPredicates: IProverCircomPredicate[];
 
-  // Pseudonyms on blinded and credential attributes
+  /**
+   * Pseudonyms on blinded and credential attributes
+   */
   boundedPseudonyms: IProverBoundedPseudonymInBlindedCredReq[];
 
   constructor() {
@@ -140,10 +166,12 @@ export abstract class BlindedCredentialRequestBuilder<SigParams> extends Version
    * @param memberValue - Only this will be blinded.
    * @param revType
    */
-  statusToBlind(registryId: string, revCheck: string, memberValue: unknown, revType= RevocationStatusProtocol.Vb22) {
+  statusToBlind(registryId: string, revCheck: string, memberValue: unknown, revType = RevocationStatusProtocol.Vb22) {
     if (revType === RevocationStatusProtocol.Vb22) {
       if (revCheck !== MEM_CHECK_STR && revCheck !== NON_MEM_CHECK_STR && revCheck !== MEM_CHECK_KV_STR) {
-        throw new Error(`Revocation check should be either ${MEM_CHECK_STR} or ${NON_MEM_CHECK_STR} or ${MEM_CHECK_KV_STR} but was ${revCheck}`);
+        throw new Error(
+          `Revocation check should be either ${MEM_CHECK_STR} or ${NON_MEM_CHECK_STR} or ${MEM_CHECK_KV_STR} but was ${revCheck}`
+        );
       }
     }
     if (revType == RevocationStatusProtocol.KbUni24) {
@@ -519,9 +547,9 @@ export abstract class BlindedCredentialRequestBuilder<SigParams> extends Version
         [STATUS_STR]: {
           [TYPE_STR]: this._statusToBlind[TYPE_STR],
           [ID_STR]: this._statusToBlind[ID_STR],
-          [REV_CHECK_STR]: this._statusToBlind[REV_CHECK_STR],
+          [REV_CHECK_STR]: this._statusToBlind[REV_CHECK_STR]
         }
-      }
+      };
     }
 
     const blindedAttributes = unflatten(attributesWithoutVals) as object;