@waku/rln 0.1.6-ace7ca2.0 → 0.1.6-b133417.0

package/src/keystore/keystore.ts

@@ -14,6 +14,8 @@ import {
 import _ from "lodash";
 import { v4 as uuidV4 } from "uuid";
 
+import { BytesUtils } from "../utils/bytes.js";
+
 import { decryptEipKeystore, keccak256Checksum } from "./cipher.js";
 import { isCredentialValid, isKeystoreValid } from "./schema_validator.js";
 import type {
@@ -248,6 +250,7 @@ export class Keystore {
       const str = bytesToUtf8(bytes);
       const obj = JSON.parse(str);
 
+      // Little Endian
       const idCommitmentLE = Keystore.fromArraylikeToBytes(
         _.get(obj, "identityCredential.idCommitment", [])
       );
@@ -261,12 +264,21 @@ export class Keystore {
         _.get(obj, "identityCredential.idSecretHash", [])
       );
 
+      // Big Endian
+      const idCommitmentBE = BytesUtils.switchEndianness(idCommitmentLE);
+      const idTrapdoorBE = BytesUtils.switchEndianness(idTrapdoorLE);
+      const idNullifierBE = BytesUtils.switchEndianness(idNullifierLE);
+      const idSecretHashBE = BytesUtils.switchEndianness(idSecretHashLE);
+      const idCommitmentBigInt =
+        BytesUtils.buildBigIntFromUint8ArrayBE(idCommitmentBE);
+
       return {
         identity: {
-          IDCommitment: idCommitmentLE,
-          IDTrapdoor: idTrapdoorLE,
-          IDNullifier: idNullifierLE,
-          IDSecretHash: idSecretHashLE
+          IDCommitment: idCommitmentBE,
+          IDTrapdoor: idTrapdoorBE,
+          IDNullifier: idNullifierBE,
+          IDSecretHash: idSecretHashBE,
+          IDCommitmentBigInt: idCommitmentBigInt
         },
         membership: {
           treeIndex: _.get(obj, "treeIndex"),
@@ -317,22 +329,24 @@ export class Keystore {
 
   // follows nwaku implementation
   // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L98
+  // IdentityCredential is stored in Big Endian format => switch to Little Endian
   private static fromIdentityToBytes(options: KeystoreEntity): Uint8Array {
-    function toLittleEndian(bytes: Uint8Array): Uint8Array {
-      return new Uint8Array(bytes).reverse();
-    }
     return utf8ToBytes(
       JSON.stringify({
         treeIndex: options.membership.treeIndex,
         identityCredential: {
           idCommitment: Array.from(
-            toLittleEndian(options.identity.IDCommitment)
+            BytesUtils.switchEndianness(options.identity.IDCommitment)
+          ),
+          idNullifier: Array.from(
+            BytesUtils.switchEndianness(options.identity.IDNullifier)
           ),
-          idNullifier: Array.from(toLittleEndian(options.identity.IDNullifier)),
           idSecretHash: Array.from(
-            toLittleEndian(options.identity.IDSecretHash)
+            BytesUtils.switchEndianness(options.identity.IDSecretHash)
           ),
-          idTrapdoor: Array.from(toLittleEndian(options.identity.IDTrapdoor))
+          idTrapdoor: Array.from(
+            BytesUtils.switchEndianness(options.identity.IDTrapdoor)
+          )
         },
         membershipContract: {
           chainId: options.membership.chainId,

package/src/proof.ts

@@ -1,6 +1,6 @@
 import type { IRateLimitProof } from "@waku/interfaces";
 
-import { concatenate, poseidonHash } from "./utils/index.js";
+import { BytesUtils, poseidonHash } from "./utils/index.js";
 
 const proofOffset = 128;
 const rootOffset = proofOffset + 32;
@@ -57,7 +57,7 @@ export class Proof implements IRateLimitProof {
 }
 
 export function proofToBytes(p: IRateLimitProof): Uint8Array {
-  return concatenate(
+  return BytesUtils.concatenate(
     p.proof,
     p.merkleRoot,
     p.epoch,

package/src/utils/bytes.ts

@@ -1,80 +1,130 @@
-/**
- * Concatenate Uint8Arrays
- * @param input
- * @returns concatenation of all Uint8Array received as input
- */
-export function concatenate(...input: Uint8Array[]): Uint8Array {
-  let totalLength = 0;
-  for (const arr of input) {
-    totalLength += arr.length;
+export class BytesUtils {
+  /**
+   * Switches endianness of a byte array
+   */
+  public static switchEndianness(bytes: Uint8Array): Uint8Array {
+    return new Uint8Array(bytes.reverse());
   }
-  const result = new Uint8Array(totalLength);
-  let offset = 0;
-  for (const arr of input) {
-    result.set(arr, offset);
-    offset += arr.length;
+
+  /**
+   * Builds a BigInt from a big-endian Uint8Array
+   * @param bytes The big-endian bytes to convert
+   * @returns The resulting BigInt in big-endian format
+   */
+  public static buildBigIntFromUint8ArrayBE(bytes: Uint8Array): bigint {
+    let result = 0n;
+    for (let i = 0; i < bytes.length; i++) {
+      result = (result << 8n) + BigInt(bytes[i]);
+    }
+    return result;
   }
-  return result;
-}
 
-export function switchEndianness(bytes: Uint8Array): Uint8Array {
-  return new Uint8Array(bytes.reverse());
-}
+  /**
+   * Switches endianness of a bigint value
+   * @param value The bigint value to switch endianness for
+   * @returns The bigint value with reversed endianness
+   */
+  public static switchEndiannessBigInt(value: bigint): bigint {
+    // Convert bigint to byte array
+    const bytes = [];
+    let tempValue = value;
+    while (tempValue > 0n) {
+      bytes.push(Number(tempValue & 0xffn));
+      tempValue >>= 8n;
+    }
 
-export function buildBigIntFromUint8ArrayBE(bytes: Uint8Array): bigint {
-  // Interpret bytes as big-endian
-  return bytes.reduce((acc, byte) => (acc << 8n) + BigInt(byte), 0n);
-}
+    // Reverse bytes and convert back to bigint
+    return bytes
+      .reverse()
+      .reduce((acc, byte) => (acc << 8n) + BigInt(byte), 0n);
+  }
 
-export function writeUIntLE(
-  buf: Uint8Array,
-  value: number,
-  offset: number,
-  byteLength: number,
-  noAssert?: boolean
-): Uint8Array {
-  value = +value;
-  offset = offset >>> 0;
-  byteLength = byteLength >>> 0;
-  if (!noAssert) {
-    const maxBytes = Math.pow(2, 8 * byteLength) - 1;
-    checkInt(buf, value, offset, byteLength, maxBytes, 0);
+  /**
+   * Converts a big-endian bigint to a 32-byte big-endian Uint8Array
+   * @param value The big-endian bigint to convert
+   * @returns A 32-byte big-endian Uint8Array
+   */
+  public static bigIntToUint8Array32BE(value: bigint): Uint8Array {
+    const bytes = new Uint8Array(32);
+    for (let i = 31; i >= 0; i--) {
+      bytes[i] = Number(value & 0xffn);
+      value >>= 8n;
+    }
+    return bytes;
   }
 
-  let mul = 1;
-  let i = 0;
-  buf[offset] = value & 0xff;
-  while (++i < byteLength && (mul *= 0x100)) {
-    buf[offset + i] = (value / mul) & 0xff;
+  /**
+   * Writes an unsigned integer to a buffer in little-endian format
+   */
+  public static writeUIntLE(
+    buf: Uint8Array,
+    value: number,
+    offset: number,
+    byteLength: number,
+    noAssert?: boolean
+  ): Uint8Array {
+    value = +value;
+    offset = offset >>> 0;
+    byteLength = byteLength >>> 0;
+    if (!noAssert) {
+      const maxBytes = Math.pow(2, 8 * byteLength) - 1;
+      BytesUtils.checkInt(buf, value, offset, byteLength, maxBytes, 0);
+    }
+
+    let mul = 1;
+    let i = 0;
+    buf[offset] = value & 0xff;
+    while (++i < byteLength && (mul *= 0x100)) {
+      buf[offset + i] = (value / mul) & 0xff;
+    }
+
+    return buf;
   }
 
-  return buf;
-}
+  /**
+   * Fills with zeros to set length
+   * @param array little endian Uint8Array
+   * @param length amount to pad
+   * @returns little endian Uint8Array padded with zeros to set length
+   */
+  public static zeroPadLE(array: Uint8Array, length: number): Uint8Array {
+    const result = new Uint8Array(length);
+    for (let i = 0; i < length; i++) {
+      result[i] = array[i] || 0;
+    }
+    return result;
+  }
 
-/**
- * Fills with zeros to set length
- * @param array little endian Uint8Array
- * @param length amount to pad
- * @returns little endian Uint8Array padded with zeros to set length
- */
-export function zeroPadLE(array: Uint8Array, length: number): Uint8Array {
-  const result = new Uint8Array(length);
-  for (let i = 0; i < length; i++) {
-    result[i] = array[i] || 0;
+  // Adapted from https://github.com/feross/buffer
+  public static checkInt(
+    buf: Uint8Array,
+    value: number,
+    offset: number,
+    ext: number,
+    max: number,
+    min: number
+  ): void {
+    if (value > max || value < min)
+      throw new RangeError('"value" argument is out of bounds');
+    if (offset + ext > buf.length) throw new RangeError("Index out of range");
   }
-  return result;
-}
 
-// Adapted from https://github.com/feross/buffer
-function checkInt(
-  buf: Uint8Array,
-  value: number,
-  offset: number,
-  ext: number,
-  max: number,
-  min: number
-): void {
-  if (value > max || value < min)
-    throw new RangeError('"value" argument is out of bounds');
-  if (offset + ext > buf.length) throw new RangeError("Index out of range");
+  /**
+   * Concatenate Uint8Arrays
+   * @param input
+   * @returns concatenation of all Uint8Array received as input
+   */
+  public static concatenate(...input: Uint8Array[]): Uint8Array {
+    let totalLength = 0;
+    for (const arr of input) {
+      totalLength += arr.length;
+    }
+    const result = new Uint8Array(totalLength);
+    let offset = 0;
+    for (const arr of input) {
+      result.set(arr, offset);
+      offset += arr.length;
+    }
+    return result;
+  }
 }

package/src/utils/hash.ts

@@ -1,15 +1,25 @@
 import * as zerokitRLN from "@waku/zerokit-rln-wasm";
 
-import { concatenate, writeUIntLE } from "./bytes.js";
+import { BytesUtils } from "./bytes.js";
 
 export function poseidonHash(...input: Array<Uint8Array>): Uint8Array {
-  const inputLen = writeUIntLE(new Uint8Array(8), input.length, 0, 8);
-  const lenPrefixedData = concatenate(inputLen, ...input);
+  const inputLen = BytesUtils.writeUIntLE(
+    new Uint8Array(8),
+    input.length,
+    0,
+    8
+  );
+  const lenPrefixedData = BytesUtils.concatenate(inputLen, ...input);
   return zerokitRLN.poseidonHash(lenPrefixedData);
 }
 
 export function sha256(input: Uint8Array): Uint8Array {
-  const inputLen = writeUIntLE(new Uint8Array(8), input.length, 0, 8);
-  const lenPrefixedData = concatenate(inputLen, input);
+  const inputLen = BytesUtils.writeUIntLE(
+    new Uint8Array(8),
+    input.length,
+    0,
+    8
+  );
+  const lenPrefixedData = BytesUtils.concatenate(inputLen, input);
   return zerokitRLN.hash(lenPrefixedData);
 }

package/src/utils/index.ts

@@ -1,9 +1,4 @@
 export { extractMetaMaskSigner } from "./metamask.js";
-export {
-  concatenate,
-  writeUIntLE,
-  switchEndianness,
-  zeroPadLE
-} from "./bytes.js";
+export { BytesUtils } from "./bytes.js";
 export { sha256, poseidonHash } from "./hash.js";
 export { dateToEpoch, epochIntToBytes, epochBytesToInt } from "./epoch.js";

package/src/zerokit.ts

@@ -5,12 +5,7 @@ import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./contract/constants.js";
 import { IdentityCredential } from "./identity.js";
 import { Proof, proofToBytes } from "./proof.js";
 import { WitnessCalculator } from "./resources/witness_calculator";
-import {
-  concatenate,
-  dateToEpoch,
-  epochIntToBytes,
-  writeUIntLE
-} from "./utils/index.js";
+import { BytesUtils, dateToEpoch, epochIntToBytes } from "./utils/index.js";
 
 export class Zerokit {
   public constructor(
@@ -57,13 +52,16 @@ export class Zerokit {
   ): void {
     // serializes a seq of IDCommitments to a byte seq
     // the order of serialization is |id_commitment_len<8>|id_commitment<var>|
-    const idCommitmentLen = writeUIntLE(
+    const idCommitmentLen = BytesUtils.writeUIntLE(
       new Uint8Array(8),
       idCommitments.length,
       0,
       8
     );
-    const idCommitmentBytes = concatenate(idCommitmentLen, ...idCommitments);
+    const idCommitmentBytes = BytesUtils.concatenate(
+      idCommitmentLen,
+      ...idCommitments
+    );
     zerokitRLN.setLeavesFrom(this.zkRLN, index, idCommitmentBytes);
   }
 
@@ -83,9 +81,19 @@ export class Zerokit {
     rateLimit?: number
   ): Uint8Array {
     // calculate message length
-    const msgLen = writeUIntLE(new Uint8Array(8), uint8Msg.length, 0, 8);
-    const memIndexBytes = writeUIntLE(new Uint8Array(8), memIndex, 0, 8);
-    const rateLimitBytes = writeUIntLE(
+    const msgLen = BytesUtils.writeUIntLE(
+      new Uint8Array(8),
+      uint8Msg.length,
+      0,
+      8
+    );
+    const memIndexBytes = BytesUtils.writeUIntLE(
+      new Uint8Array(8),
+      memIndex,
+      0,
+      8
+    );
+    const rateLimitBytes = BytesUtils.writeUIntLE(
       new Uint8Array(8),
       rateLimit ?? this.rateLimit,
       0,
@@ -93,7 +101,7 @@ export class Zerokit {
     );
 
     // [ id_key<32> | id_index<8> | epoch<32> | signal_len<8> | signal<var> | rate_limit<8> ]
-    return concatenate(
+    return BytesUtils.concatenate(
       idKey,
       memIndexBytes,
       epoch,
@@ -169,8 +177,8 @@ export class Zerokit {
     }
 
     // calculate message length
-    const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = writeUIntLE(
+    const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+    const rateLimitBytes = BytesUtils.writeUIntLE(
       new Uint8Array(8),
       rateLimit ?? this.rateLimit,
       0,
@@ -179,7 +187,7 @@ export class Zerokit {
 
     return zerokitRLN.verifyRLNProof(
       this.zkRLN,
-      concatenate(pBytes, msgLen, msg, rateLimitBytes)
+      BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes)
     );
   }
 
@@ -196,19 +204,19 @@ export class Zerokit {
       pBytes = proofToBytes(proof);
     }
     // calculate message length
-    const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = writeUIntLE(
+    const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+    const rateLimitBytes = BytesUtils.writeUIntLE(
       new Uint8Array(8),
       rateLimit ?? this.rateLimit,
       0,
       8
     );
 
-    const rootsBytes = concatenate(...roots);
+    const rootsBytes = BytesUtils.concatenate(...roots);
 
     return zerokitRLN.verifyWithRoots(
       this.zkRLN,
-      concatenate(pBytes, msgLen, msg, rateLimitBytes),
+      BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes),
       rootsBytes
     );
   }
@@ -226,8 +234,8 @@ export class Zerokit {
     }
 
     // calculate message length
-    const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = writeUIntLE(
+    const msgLen = BytesUtils.writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+    const rateLimitBytes = BytesUtils.writeUIntLE(
       new Uint8Array(8),
       rateLimit ?? this.rateLimit,
       0,
@@ -236,7 +244,7 @@ export class Zerokit {
 
     return zerokitRLN.verifyWithRoots(
       this.zkRLN,
-      concatenate(pBytes, msgLen, msg, rateLimitBytes),
+      BytesUtils.concatenate(pBytes, msgLen, msg, rateLimitBytes),
       new Uint8Array()
     );
   }