@waku/rln 0.1.7-2ed5ddc.0 → 0.1.7-987c6cd.0

package/src/contract/{test-setup.ts → test_setup.ts}

@@ -5,7 +5,7 @@ import sinon from "sinon";
 import { createRLN } from "../create.js";
 import type { IdentityCredential } from "../identity.js";
 
-import { DEFAULT_RATE_LIMIT, LINEA_CONTRACT } from "./constants.js";
+import { DEFAULT_RATE_LIMIT, RLN_CONTRACT } from "./constants.js";
 import { RLNContract } from "./rln_contract.js";
 
 export interface TestRLNInstance {
@@ -42,7 +42,7 @@ export async function initializeRLNContract(
   mockedRegistryContract: ethers.Contract
 ): Promise<RLNContract> {
   const provider = new ethers.providers.JsonRpcProvider();
-  const voidSigner = new ethers.VoidSigner(LINEA_CONTRACT.address, provider);
+  const voidSigner = new ethers.VoidSigner(RLN_CONTRACT.address, provider);
 
   const originalRegister = mockedRegistryContract.register;
   (mockedRegistryContract as any).register = function (...args: any[]) {
@@ -63,7 +63,7 @@ export async function initializeRLNContract(
   };
 
   const contract = await RLNContract.init(rlnInstance, {
-    address: LINEA_CONTRACT.address,
+    address: RLN_CONTRACT.address,
     signer: voidSigner,
     rateLimit: DEFAULT_RATE_LIMIT,
     contract: mockedRegistryContract
@@ -83,4 +83,4 @@ export const TEST_DATA = {
   ),
   mockSignature:
     "0xdeb8a6b00a8e404deb1f52d3aa72ed7f60a2ff4484c737eedaef18a0aacb2dfb4d5d74ac39bb71fa358cf2eb390565a35b026cc6272f2010d4351e17670311c21c"
-} as const;
+};

package/src/contract/{test-utils.ts → test_utils.ts}

@@ -5,7 +5,7 @@ import sinon from "sinon";
 
 import type { IdentityCredential } from "../identity.js";
 
-import { DEFAULT_RATE_LIMIT, LINEA_CONTRACT } from "./constants.js";
+import { DEFAULT_RATE_LIMIT, RLN_CONTRACT } from "./constants.js";
 
 export const mockRateLimits = {
   minRate: 20,
@@ -36,9 +36,9 @@ export function createMockProvider(): MockProvider {
 
 export function createMockFilters(): MockFilters {
   return {
-    MembershipRegistered: () => ({ address: LINEA_CONTRACT.address }),
-    MembershipErased: () => ({ address: LINEA_CONTRACT.address }),
-    MembershipExpired: () => ({ address: LINEA_CONTRACT.address })
+    MembershipRegistered: () => ({ address: RLN_CONTRACT.address }),
+    MembershipErased: () => ({ address: RLN_CONTRACT.address }),
+    MembershipExpired: () => ({ address: RLN_CONTRACT.address })
   };
 }
 
@@ -51,9 +51,9 @@ export function createMockRegistryContract(
   overrides: ContractOverrides = {}
 ): ethers.Contract {
   const filters = {
-    MembershipRegistered: () => ({ address: LINEA_CONTRACT.address }),
-    MembershipErased: () => ({ address: LINEA_CONTRACT.address }),
-    MembershipExpired: () => ({ address: LINEA_CONTRACT.address })
+    MembershipRegistered: () => ({ address: RLN_CONTRACT.address }),
+    MembershipErased: () => ({ address: RLN_CONTRACT.address }),
+    MembershipExpired: () => ({ address: RLN_CONTRACT.address })
   };
 
   const baseContract = {
@@ -89,7 +89,7 @@ export function createMockRegistryContract(
         format: () => {}
       })
     },
-    address: LINEA_CONTRACT.address
+    address: RLN_CONTRACT.address
   };
 
   // Merge overrides while preserving filters
@@ -163,7 +163,7 @@ export function verifyRegistration(
   expect(decryptedCredentials).to.have.property("identity");
   expect(decryptedCredentials).to.have.property("membership");
   expect(decryptedCredentials.membership).to.include({
-    address: LINEA_CONTRACT.address,
+    address: RLN_CONTRACT.address,
     treeIndex: 1
   });
 

package/src/credentials_manager.ts

@@ -1,9 +1,9 @@
 import { hmac } from "@noble/hashes/hmac";
-import { sha256 } from "@noble/hashes/sha256";
+import { sha256 } from "@noble/hashes/sha2";
 import { Logger } from "@waku/utils";
 import { ethers } from "ethers";
 
-import { LINEA_CONTRACT } from "./contract/constants.js";
+import { RLN_CONTRACT, RLN_Q } from "./contract/constants.js";
 import { RLNBaseContract } from "./contract/rln_base_contract.js";
 import { IdentityCredential } from "./identity.js";
 import { Keystore } from "./keystore/index.js";
@@ -13,10 +13,8 @@ import type {
 } from "./keystore/index.js";
 import { KeystoreEntity, Password } from "./keystore/types.js";
 import { RegisterMembershipOptions, StartRLNOptions } from "./types.js";
-import {
-  buildBigIntFromUint8Array,
-  extractMetaMaskSigner
-} from "./utils/index.js";
+import { BytesUtils } from "./utils/bytes.js";
+import { extractMetaMaskSigner } from "./utils/index.js";
 import { Zerokit } from "./zerokit.js";
 
 const log = new Logger("waku:credentials");
@@ -116,7 +114,9 @@ export class RLNCredentialsManager {
         );
       } else {
         log.info("Using local implementation to generate identity");
-        identity = this.generateSeededIdentityCredential(options.signature);
+        identity = await this.generateSeededIdentityCredential(
+          options.signature
+        );
       }
     }
 
@@ -152,10 +152,10 @@ export class RLNCredentialsManager {
     const address =
       credentials?.membership.address ||
       options.address ||
-      LINEA_CONTRACT.address;
+      RLN_CONTRACT.address;
 
-    if (address === LINEA_CONTRACT.address) {
-      chainId = LINEA_CONTRACT.chainId.toString();
+    if (address === RLN_CONTRACT.address) {
+      chainId = RLN_CONTRACT.chainId.toString();
       log.info(`Using Linea contract with chainId: ${chainId}`);
     }
 
@@ -249,7 +249,9 @@ export class RLNCredentialsManager {
    * @param seed A string seed to generate the identity from
    * @returns IdentityCredential
    */
-  private generateSeededIdentityCredential(seed: string): IdentityCredential {
+  private async generateSeededIdentityCredential(
+    seed: string
+  ): Promise<IdentityCredential> {
     log.info("Generating seeded identity credential");
     // Convert the seed to bytes
     const encoder = new TextEncoder();
@@ -257,26 +259,38 @@ export class RLNCredentialsManager {
 
     // Generate deterministic values using HMAC-SHA256
     // We use different context strings for each component to ensure they're different
-    const idTrapdoor = hmac(sha256, seedBytes, encoder.encode("IDTrapdoor"));
-    const idNullifier = hmac(sha256, seedBytes, encoder.encode("IDNullifier"));
-
-    // Generate IDSecretHash as a hash of IDTrapdoor and IDNullifier
-    const combinedBytes = new Uint8Array([...idTrapdoor, ...idNullifier]);
-    const idSecretHash = sha256(combinedBytes);
+    const idTrapdoorBE = hmac(sha256, seedBytes, encoder.encode("IDTrapdoor"));
+    const idNullifierBE = hmac(
+      sha256,
+      seedBytes,
+      encoder.encode("IDNullifier")
+    );
 
-    // Generate IDCommitment as a hash of IDSecretHash
-    const idCommitment = sha256(idSecretHash);
+    const combinedBytes = new Uint8Array([...idTrapdoorBE, ...idNullifierBE]);
+    const idSecretHashBE = sha256(combinedBytes);
 
-    // Convert IDCommitment to BigInt
-    const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment);
+    const idCommitmentRawBE = sha256(idSecretHashBE);
+    const idCommitmentBE = this.reduceIdCommitment(idCommitmentRawBE);
 
-    log.info("Successfully generated identity credential");
+    log.info(
+      "Successfully generated identity credential, storing in Big Endian format"
+    );
     return new IdentityCredential(
-      idTrapdoor,
-      idNullifier,
-      idSecretHash,
-      idCommitment,
-      idCommitmentBigInt
+      idTrapdoorBE,
+      idNullifierBE,
+      idSecretHashBE,
+      idCommitmentBE
     );
   }
+
+  /**
+   * Helper: take 32-byte BE, reduce mod Q, return 32-byte BE
+   */
+  private reduceIdCommitment(
+    bytesBE: Uint8Array,
+    limit: bigint = RLN_Q
+  ): Uint8Array {
+    const nBE = BytesUtils.buildBigIntFromUint8ArrayBE(bytesBE);
+    return BytesUtils.bigIntToUint8Array32BE(nBE % limit);
+  }
 }

package/src/identity.ts

@@ -1,13 +1,19 @@
-import { buildBigIntFromUint8Array } from "./utils/index.js";
+import { BytesUtils } from "./utils/bytes.js";
 
 export class IdentityCredential {
+  public IDCommitmentBigInt: bigint;
+  /**
+   * All variables are in little-endian format
+   */
   public constructor(
     public readonly IDTrapdoor: Uint8Array,
     public readonly IDNullifier: Uint8Array,
     public readonly IDSecretHash: Uint8Array,
-    public readonly IDCommitment: Uint8Array,
-    public readonly IDCommitmentBigInt: bigint
-  ) {}
+    public readonly IDCommitment: Uint8Array
+  ) {
+    this.IDCommitmentBigInt =
+      BytesUtils.buildBigIntFromUint8ArrayBE(IDCommitment);
+  }
 
   public static fromBytes(memKeys: Uint8Array): IdentityCredential {
     if (memKeys.length < 128) {
@@ -18,14 +24,12 @@ export class IdentityCredential {
     const idNullifier = memKeys.subarray(32, 64);
     const idSecretHash = memKeys.subarray(64, 96);
     const idCommitment = memKeys.subarray(96, 128);
-    const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
 
     return new IdentityCredential(
       idTrapdoor,
       idNullifier,
       idSecretHash,
-      idCommitment,
-      idCommitmentBigInt
+      idCommitment
     );
   }
 }

package/src/index.ts

@@ -1,6 +1,6 @@
 import { RLNDecoder, RLNEncoder } from "./codec.js";
-import { RLN_ABI } from "./contract/abi.js";
-import { LINEA_CONTRACT, RLNContract } from "./contract/index.js";
+import { RLN_ABI } from "./contract/abi/rln.js";
+import { RLN_CONTRACT, RLNContract } from "./contract/index.js";
 import { RLNBaseContract } from "./contract/rln_base_contract.js";
 import { createRLN } from "./create.js";
 import { RLNCredentialsManager } from "./credentials_manager.js";
@@ -23,7 +23,7 @@ export {
   RLNDecoder,
   MerkleRootTracker,
   RLNContract,
-  LINEA_CONTRACT,
+  RLN_CONTRACT,
   extractMetaMaskSigner,
   RLN_ABI
 };

package/src/keystore/keystore.ts

@@ -14,7 +14,7 @@ import {
 import _ from "lodash";
 import { v4 as uuidV4 } from "uuid";
 
-import { buildBigIntFromUint8Array } from "../utils/bytes.js";
+import { BytesUtils } from "../utils/bytes.js";
 
 import { decryptEipKeystore, keccak256Checksum } from "./cipher.js";
 import { isCredentialValid, isKeystoreValid } from "./schema_validator.js";
@@ -250,26 +250,35 @@ export class Keystore {
       const str = bytesToUtf8(bytes);
       const obj = JSON.parse(str);
 
-      // TODO: add runtime validation of nwaku credentials
+      // Little Endian
+      const idCommitmentLE = Keystore.fromArraylikeToBytes(
+        _.get(obj, "identityCredential.idCommitment", [])
+      );
+      const idTrapdoorLE = Keystore.fromArraylikeToBytes(
+        _.get(obj, "identityCredential.idTrapdoor", [])
+      );
+      const idNullifierLE = Keystore.fromArraylikeToBytes(
+        _.get(obj, "identityCredential.idNullifier", [])
+      );
+      const idSecretHashLE = Keystore.fromArraylikeToBytes(
+        _.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: Keystore.fromArraylikeToBytes(
-            _.get(obj, "identityCredential.idCommitment", [])
-          ),
-          IDTrapdoor: Keystore.fromArraylikeToBytes(
-            _.get(obj, "identityCredential.idTrapdoor", [])
-          ),
-          IDNullifier: Keystore.fromArraylikeToBytes(
-            _.get(obj, "identityCredential.idNullifier", [])
-          ),
-          IDCommitmentBigInt: buildBigIntFromUint8Array(
-            Keystore.fromArraylikeToBytes(
-              _.get(obj, "identityCredential.idCommitment", [])
-            )
-          ),
-          IDSecretHash: Keystore.fromArraylikeToBytes(
-            _.get(obj, "identityCredential.idSecretHash", [])
-          )
+          IDCommitment: idCommitmentBE,
+          IDTrapdoor: idTrapdoorBE,
+          IDNullifier: idNullifierBE,
+          IDSecretHash: idSecretHashBE,
+          IDCommitmentBigInt: idCommitmentBigInt
         },
         membership: {
           treeIndex: _.get(obj, "treeIndex"),
@@ -320,15 +329,35 @@ 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 {
+    const { IDCommitment, IDNullifier, IDSecretHash, IDTrapdoor } =
+      options.identity;
+    const idCommitmentLE = BytesUtils.switchEndianness(IDCommitment);
+    const idNullifierLE = BytesUtils.switchEndianness(IDNullifier);
+    const idSecretHashLE = BytesUtils.switchEndianness(IDSecretHash);
+    const idTrapdoorLE = BytesUtils.switchEndianness(IDTrapdoor);
+
+    // eslint-disable-next-line no-console
+    console.log({
+      idCommitmentBE: IDCommitment,
+      idCommitmentLE,
+      idNullifierBE: IDNullifier,
+      idNullifierLE,
+      idSecretHashBE: IDSecretHash,
+      idSecretHashLE,
+      idTrapdoorBE: IDTrapdoor,
+      idTrapdoorLE
+    });
+
     return utf8ToBytes(
       JSON.stringify({
         treeIndex: options.membership.treeIndex,
         identityCredential: {
-          idCommitment: Array.from(options.identity.IDCommitment),
-          idNullifier: Array.from(options.identity.IDNullifier),
-          idSecretHash: Array.from(options.identity.IDSecretHash),
-          idTrapdoor: Array.from(options.identity.IDTrapdoor)
+          idCommitment: Array.from(idCommitmentLE),
+          idNullifier: Array.from(idNullifierLE),
+          idSecretHash: Array.from(idSecretHashLE),
+          idTrapdoor: Array.from(idTrapdoorLE)
         },
         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,84 +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;
-}
 
-// 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");
-}
+  /**
+   * 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 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);
+    // Reverse bytes and convert back to bigint
+    return bytes
+      .reverse()
+      .reduce((acc, byte) => (acc << 8n) + BigInt(byte), 0n);
   }
 
-  let mul = 1;
-  let i = 0;
-  buf[offset] = value & 0xff;
-  while (++i < byteLength && (mul *= 0x100)) {
-    buf[offset + i] = (value / mul) & 0xff;
+  /**
+   * 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;
   }
 
-  return buf;
-}
+  /**
+   * 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);
+    }
 
-/**
- * Transforms Uint8Array into BigInt
- * @param array: Uint8Array
- * @returns BigInt
- */
-export function buildBigIntFromUint8Array(
-  array: Uint8Array,
-  byteOffset: number = 0
-): bigint {
-  const dataView = new DataView(array.buffer);
-  return dataView.getBigUint64(byteOffset, true);
-}
+    let mul = 1;
+    let i = 0;
+    buf[offset] = value & 0xff;
+    while (++i < byteLength && (mul *= 0x100)) {
+      buf[offset + i] = (value / mul) & 0xff;
+    }
+
+    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;
+  }
+
+  // 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");
+  }
 
-/**
- * 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;
+  /**
+   * 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;
   }
-  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,
-  buildBigIntFromUint8Array,
-  zeroPadLE
-} from "./bytes.js";
+export { BytesUtils } from "./bytes.js";
 export { sha256, poseidonHash } from "./hash.js";
 export { dateToEpoch, epochIntToBytes, epochBytesToInt } from "./epoch.js";