@waku/rln 0.0.12 → 0.0.13-d77370f

package/dist/rln_contract.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rln_contract.js","sourceRoot":"","sources":["../src/rln_contract.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAEhC,OAAO,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AAazC,MAAM,OAAO,WAAW;IAkBtB,YAAY,EAAE,OAAO,EAAE,QAAQ,EAAmB;QAd1C,aAAQ,GAAa,EAAE,CAAC;QAe9B,IAAI,CAAC,SAAS,GAAG,IAAI,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC;QACjE,IAAI,CAAC,aAAa,GAAG,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,gBAAgB,EAAE,CAAC;IAChE,CAAC;IAfM,MAAM,CAAC,KAAK,CAAC,IAAI,CACtB,WAAwB,EACxB,OAAwB;QAExB,MAAM,WAAW,GAAG,IAAI,WAAW,CAAC,OAAO,CAAC,CAAC;QAE7C,MAAM,WAAW,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC;QAC5C,WAAW,CAAC,kBAAkB,CAAC,WAAW,CAAC,CAAC;QAE5C,OAAO,WAAW,CAAC;IACrB,CAAC;IAOD,IAAW,QAAQ;QACjB,OAAO,IAAI,CAAC,SAAS,CAAC;IACxB,CAAC;IAED,IAAW,OAAO;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAEM,KAAK,CAAC,YAAY,CACvB,WAAwB,EACxB,SAAkB;QAElB,MAAM,sBAAsB,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,WAAW,CAC5D,IAAI,CAAC,aAAa,EAClB,SAAS,CACV,CAAC;QAEF,KAAK,MAAM,KAAK,IAAI,sBAAsB,EAAE;YAC1C,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,CAAC;SAC7C;IACH,CAAC;IAEM,kBAAkB,CAAC,WAAwB;QAChD,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,CAC9D,IAAI,CAAC,kBAAkB,CAAC,WAAW,EAAE,KAAK,CAAC,CAC5C,CAAC;IACJ,CAAC;IAEO,kBAAkB,CACxB,WAAwB,EACxB,KAAmB;QAEnB,IAAI,CAAC,KAAK,CAAC,IAAI,EAAE;YACf,OAAO;SACR;QAED,MAAM,MAAM,GAAW,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC;QACzC,MAAM,KAAK,GAAW,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;QAEvC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,CAAC,CAAC;QAErC,MAAM,YAAY,GAAG,MAAM,CAAC,KAAK,CAAC,OAAO,CACvC,MAAM,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,EAC7B,EAAE,CACH,CAAC;QACF,WAAW,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC;IACzC,CAAC;IAEM,KAAK,CAAC,cAAc,CACzB,WAAwB,EACxB,SAAiB;QAEjB,MAAM,aAAa,GAAG,MAAM,WAAW,CAAC,2BAA2B,CACjE,SAAS,CACV,CAAC;QACF,MAAM,YAAY,GAAG,MAAM,IAAI,CAAC,QAAQ,CAAC,kBAAkB,EAAE,CAAC;QAE9D,MAAM,kBAAkB,GACtB,MAAM,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,aAAa,CAAC,kBAAkB,EAAE;YAC7D,KAAK,EAAE,YAAY;SACpB,CAAC,CAAC;QACL,MAAM,iBAAiB,GAAG,MAAM,kBAAkB,CAAC,IAAI,EAAE,CAAC;QAE1D,OAAO,iBAAiB,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACxC,CAAC;CACF"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@waku/rln",
-  "version": "0.0.12",
+  "version": "0.0.13-d77370f",
   "description": "Rate Limit Nullifier for js-waku",
   "types": "./dist/index.d.ts",
   "module": "./dist/index.js",
@@ -59,6 +59,7 @@
     "@size-limit/preset-big-lib": "^8.0.0",
     "@types/app-root-path": "^1.2.4",
     "@types/chai": "^4.2.15",
+    "@types/chai-spies": "^1.0.3",
     "@types/debug": "^4.1.7",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.6",
@@ -69,6 +70,7 @@
     "@web/rollup-plugin-import-meta-assets": "^1.0.7",
     "app-root-path": "^3.0.0",
     "chai": "^4.3.4",
+    "chai-spies": "^1.0.0",
     "cspell": "^5.14.0",
     "eslint": "^8.6.0",
     "eslint-config-prettier": "^8.3.0",
@@ -125,6 +127,7 @@
     ]
   },
   "dependencies": {
-    "@waku/zerokit-rln-wasm": "^0.0.4"
+    "@waku/zerokit-rln-wasm": "^0.0.5",
+    "ethers": "^5.7.2"
   }
 }

package/src/codec.ts

@@ -10,7 +10,7 @@ import {
 import { RlnMessage, toRLNSignal } from "./message.js";
 import { MembershipKey, RLNInstance } from "./rln.js";
 
-const log = debug("waku:message:rln-encoder");
+const log = debug("waku:rln:encoder");
 
 export class RLNEncoder implements Encoder {
   public contentTopic: string;
@@ -30,7 +30,7 @@ export class RLNEncoder implements Encoder {
   async toWire(message: Partial<Message>): Promise<Uint8Array | undefined> {
     message.contentTopic = this.contentTopic;
     message.rateLimitProof = await this.generateProof(message);
-
+    log("Proof generated", message.rateLimitProof);
     return this.encoder.toWire(message);
   }
 
@@ -42,7 +42,7 @@ export class RLNEncoder implements Encoder {
     if (!protoMessage) return;
 
     protoMessage.rateLimitProof = await this.generateProof(message);
-
+    log("Proof generated", protoMessage.rateLimitProof);
     return protoMessage;
   }
 

package/src/constants.ts

@@ -0,0 +1,14 @@
+export const RLN_ABI = [
+  "function MEMBERSHIP_DEPOSIT() public view returns(uint256)",
+  "function register(uint256 pubkey) external payable",
+  "function withdraw(uint256 secret, uint256 _pubkeyIndex, address payable receiver) external",
+  "event MemberRegistered(uint256 pubkey, uint256 index)",
+  "event MemberWithdrawn(uint256 pubkey, uint256 index)",
+];
+
+export const GOERLI_CONTRACT = {
+  chainId: 5,
+  startBlock: 7109391,
+  address: "0x4252105670fe33d2947e8ead304969849e64f2a6",
+  abi: RLN_ABI,
+};

package/src/epoch.ts

@@ -1,21 +1,30 @@
+import debug from "debug";
+
 const DefaultEpochUnitSeconds = 10; // the rln-relay epoch length in seconds
 
+const log = debug("waku:rln:epoch");
+
 export function dateToEpoch(
   timestamp: Date,
   epochUnitSeconds: number = DefaultEpochUnitSeconds
 ): number {
   const time = timestamp.getTime();
-  return Math.floor(time / 1000 / epochUnitSeconds);
+  const epoch = Math.floor(time / 1000 / epochUnitSeconds);
+  log("generated epoch", epoch);
+  return epoch;
 }
 
 export function epochIntToBytes(epoch: number): Uint8Array {
   const bytes = new Uint8Array(32);
   const db = new DataView(bytes.buffer);
   db.setUint32(0, epoch, true);
+  log("encoded epoch", epoch, bytes);
   return bytes;
 }
 
 export function epochBytesToInt(bytes: Uint8Array): number {
-  const dv = new DataView(bytes.buffer);
-  return dv.getUint32(0, true);
+  const dv = new DataView(bytes.buffer, bytes.byteOffset, bytes.byteLength);
+  const epoch = dv.getUint32(0, true);
+  log("decoded epoch", epoch, bytes);
+  return epoch;
 }

package/src/index.ts

@@ -1,6 +1,8 @@
 import { RLNDecoder, RLNEncoder } from "./codec.js";
-import type { Proof, RLNInstance } from "./rln.js";
+import { GOERLI_CONTRACT, RLN_ABI } from "./constants.js";
+import { Proof, RLNInstance } from "./rln.js";
 import { MembershipKey } from "./rln.js";
+import { RLNContract } from "./rln_contract.js";
 
 // reexport the create function, dynamically imported from rln.ts
 export async function create(): Promise<RLNInstance> {
@@ -11,4 +13,13 @@ export async function create(): Promise<RLNInstance> {
   return await rlnModule.create();
 }
 
-export { RLNInstance, MembershipKey, Proof, RLNEncoder, RLNDecoder };
+export {
+  RLNInstance,
+  MembershipKey,
+  Proof,
+  RLNEncoder,
+  RLNDecoder,
+  RLNContract,
+  RLN_ABI,
+  GOERLI_CONTRACT,
+};

package/src/message.ts

@@ -22,6 +22,15 @@ export class RlnMessage<T extends Message> implements Message {
       : undefined;
   }
 
+  public verifyNoRoot(): boolean | undefined {
+    return this.rateLimitProof
+      ? this.rlnInstance.verifyWithNoRoot(
+          this.rateLimitProof,
+          toRLNSignal(this)
+        ) // this.rlnInstance.verifyRLNProof once issue status-im/nwaku#1248 is fixed
+      : undefined;
+  }
+
   get payload(): Uint8Array | undefined {
     return this.msg.payload;
   }

package/src/rln.ts

@@ -26,6 +26,16 @@ function concatenate(...input: Uint8Array[]): Uint8Array {
   return result;
 }
 
+/**
+ * Transforms Uint8Array into BigInt
+ * @param array: Uint8Array
+ * @returns BigInt
+ */
+function buildBigIntFromUint8Array(array: Uint8Array): bigint {
+  const dataView = new DataView(array.buffer);
+  return dataView.getBigUint64(0, true);
+}
+
 const stringEncoder = new TextEncoder();
 
 const DEPTH = 20;
@@ -59,13 +69,15 @@ export async function create(): Promise<RLNInstance> {
 export class MembershipKey {
   constructor(
     public readonly IDKey: Uint8Array,
-    public readonly IDCommitment: Uint8Array
+    public readonly IDCommitment: Uint8Array,
+    public readonly IDCommitmentBigInt: bigint
   ) {}
 
   static fromBytes(memKeys: Uint8Array): MembershipKey {
     const idKey = memKeys.subarray(0, 32);
     const idCommitment = memKeys.subarray(32);
-    return new MembershipKey(idKey, idCommitment);
+    const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment);
+    return new MembershipKey(idKey, idCommitment, idCommitmentBigInt);
   }
 }
 
@@ -125,6 +137,15 @@ export class RLNInstance {
     return MembershipKey.fromBytes(memKeys);
   }
 
+  generateSeededMembershipKey(seed: string): MembershipKey {
+    const seedBytes = stringEncoder.encode(seed);
+    const memKeys = zerokitRLN.generateSeededMembershipKey(
+      this.zkRLN,
+      seedBytes
+    );
+    return MembershipKey.fromBytes(memKeys);
+  }
+
   insertMember(idCommitment: Uint8Array): void {
     zerokitRLN.insertMember(this.zkRLN, idCommitment);
   }
@@ -225,4 +246,25 @@ export class RLNInstance {
       root
     );
   }
+
+  verifyWithNoRoot(
+    proof: RateLimitProof | Uint8Array,
+    msg: Uint8Array
+  ): boolean {
+    let pBytes: Uint8Array;
+    if (proof instanceof Uint8Array) {
+      pBytes = proof;
+    } else {
+      pBytes = proofToBytes(proof);
+    }
+
+    // calculate message length
+    const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
+
+    return zerokitRLN.verifyWithRoots(
+      this.zkRLN,
+      concatenate(pBytes, msgLen, msg),
+      new Uint8Array()
+    );
+  }
 }

package/src/rln_contract.ts

@@ -0,0 +1,104 @@
+import { ethers } from "ethers";
+
+import { RLN_ABI } from "./constants.js";
+import { RLNInstance } from "./rln.js";
+
+type Member = {
+  pubkey: string;
+  index: number;
+};
+
+type ContractOptions = {
+  address: string;
+  provider: ethers.Signer | ethers.providers.Provider;
+};
+
+export class RLNContract {
+  private _contract: ethers.Contract;
+  private membersFilter: ethers.EventFilter;
+
+  private _members: Member[] = [];
+
+  public static async init(
+    rlnInstance: RLNInstance,
+    options: ContractOptions
+  ): Promise<RLNContract> {
+    const rlnContract = new RLNContract(options);
+
+    await rlnContract.fetchMembers(rlnInstance);
+    rlnContract.subscribeToMembers(rlnInstance);
+
+    return rlnContract;
+  }
+
+  constructor({ address, provider }: ContractOptions) {
+    this._contract = new ethers.Contract(address, RLN_ABI, provider);
+    this.membersFilter = this.contract.filters.MemberRegistered();
+  }
+
+  public get contract(): ethers.Contract {
+    return this._contract;
+  }
+
+  public get members(): Member[] {
+    return this._members;
+  }
+
+  public async fetchMembers(
+    rlnInstance: RLNInstance,
+    fromBlock?: number
+  ): Promise<void> {
+    const registeredMemberEvents = await this.contract.queryFilter(
+      this.membersFilter,
+      fromBlock
+    );
+
+    for (const event of registeredMemberEvents) {
+      this.addMemberFromEvent(rlnInstance, event);
+    }
+  }
+
+  public subscribeToMembers(rlnInstance: RLNInstance): void {
+    this.contract.on(this.membersFilter, (_pubkey, _index, event) =>
+      this.addMemberFromEvent(rlnInstance, event)
+    );
+  }
+
+  private addMemberFromEvent(
+    rlnInstance: RLNInstance,
+    event: ethers.Event
+  ): void {
+    if (!event.args) {
+      return;
+    }
+
+    const pubkey: string = event.args.pubkey;
+    const index: number = event.args.index;
+
+    this.members.push({ index, pubkey });
+
+    const idCommitment = ethers.utils.zeroPad(
+      ethers.utils.arrayify(pubkey),
+      32
+    );
+    rlnInstance.insertMember(idCommitment);
+  }
+
+  public async registerMember(
+    rlnInstance: RLNInstance,
+    signature: string
+  ): Promise<ethers.Event | undefined> {
+    const membershipKey = await rlnInstance.generateSeededMembershipKey(
+      signature
+    );
+    const depositValue = await this.contract.MEMBERSHIP_DEPOSIT();
+
+    const txRegisterResponse: ethers.ContractTransaction =
+      await this.contract.register(membershipKey.IDCommitmentBigInt, {
+        value: depositValue,
+      });
+    const txRegisterReceipt = await txRegisterResponse.wait();
+
+    return txRegisterReceipt?.events?.[0];
+  }
+}