@waku/rln 0.0.2-c86e056.0 → 0.0.2-caeafce.0

package/src/contract/rln_contract.ts

@@ -8,7 +8,7 @@ import type { RLNInstance } from "../rln.js";
 import { MerkleRootTracker } from "../root_tracker.js";
 import { zeroPadLE } from "../utils/bytes.js";
 
-import { RLN_V2_ABI } from "./abi/rlnv2.js";
+import { RLN_ABI } from "./abi.js";
 import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./constants.js";
 
 const log = new Logger("waku:rln:contract");
@@ -108,8 +108,7 @@ export class RLNContract {
     const initialRoot = rlnInstance.zerokit.getMerkleRoot();
 
     // Use the injected contract if provided; otherwise, instantiate a new one.
-    this.contract =
-      contract || new ethers.Contract(address, RLN_V2_ABI, signer);
+    this.contract = contract || new ethers.Contract(address, RLN_ABI, signer);
     this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
 
     // Initialize event filters for MembershipRegistered and MembershipRemoved
@@ -124,6 +123,20 @@ export class RLNContract {
     return this.rateLimit;
   }
 
+  /**
+   * Gets the contract address
+   */
+  public get address(): string {
+    return this.contract.address;
+  }
+
+  /**
+   * Gets the contract provider
+   */
+  public get provider(): ethers.providers.Provider {
+    return this.contract.provider;
+  }
+
   /**
    * Gets the minimum allowed rate limit from the contract
    * @returns Promise<number> The minimum rate limit in messages per epoch

package/src/index.ts

@@ -1,5 +1,5 @@
 import { RLNDecoder, RLNEncoder } from "./codec.js";
-import { RLN_V2_ABI } from "./contract/abi/rlnv2.js";
+import { RLN_ABI } from "./contract/abi.js";
 import { RLNContract, SEPOLIA_CONTRACT } from "./contract/index.js";
 import { createRLN } from "./create.js";
 import { IdentityCredential } from "./identity.js";
@@ -21,5 +21,5 @@ export {
   RLNContract,
   SEPOLIA_CONTRACT,
   extractMetaMaskSigner,
-  RLN_V2_ABI
+  RLN_ABI
 };

package/src/rln.ts

@@ -15,6 +15,7 @@ import {
   type RLNDecoder,
   type RLNEncoder
 } from "./codec.js";
+import { DEFAULT_RATE_LIMIT } from "./contract/constants.js";
 import { RLNContract, SEPOLIA_CONTRACT } from "./contract/index.js";
 import { IdentityCredential } from "./identity.js";
 import { Keystore } from "./keystore/index.js";
@@ -32,15 +33,46 @@ import { Zerokit } from "./zerokit.js";
 const log = new Logger("waku:rln");
 
 async function loadWitnessCalculator(): Promise<WitnessCalculator> {
-  const url = new URL("./resources/rln.wasm", import.meta.url);
-  const response = await fetch(url);
-  return await wc.builder(new Uint8Array(await response.arrayBuffer()), false);
+  try {
+    const url = new URL("./resources/rln.wasm", import.meta.url);
+    const response = await fetch(url);
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to fetch witness calculator: ${response.status} ${response.statusText}`
+      );
+    }
+
+    return await wc.builder(
+      new Uint8Array(await response.arrayBuffer()),
+      false
+    );
+  } catch (error) {
+    log.error("Error loading witness calculator:", error);
+    throw new Error(
+      `Failed to load witness calculator: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
 }
 
 async function loadZkey(): Promise<Uint8Array> {
-  const url = new URL("./resources/rln_final.zkey", import.meta.url);
-  const response = await fetch(url);
-  return new Uint8Array(await response.arrayBuffer());
+  try {
+    const url = new URL("./resources/rln_final.zkey", import.meta.url);
+    const response = await fetch(url);
+
+    if (!response.ok) {
+      throw new Error(
+        `Failed to fetch zkey: ${response.status} ${response.statusText}`
+      );
+    }
+
+    return new Uint8Array(await response.arrayBuffer());
+  } catch (error) {
+    log.error("Error loading zkey:", error);
+    throw new Error(
+      `Failed to load zkey: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
 }
 
 /**
@@ -61,7 +93,7 @@ export async function create(): Promise<RLNInstance> {
 
     const DEPTH = 20;
     const zkRLN = zerokitRLN.newRLN(DEPTH, zkey, vkey);
-    const zerokit = new Zerokit(zkRLN, witnessCalculator);
+    const zerokit = new Zerokit(zkRLN, witnessCalculator, DEFAULT_RATE_LIMIT);
 
     return new RLNInstance(zerokit);
   } catch (error) {
@@ -119,6 +151,8 @@ export class RLNInstance {
   }
 
   public async start(options: StartRLNOptions = {}): Promise<void> {
+    // eslint-disable-next-line no-console
+    console.log("starting", options);
     if (this.started || this.starting) {
       return;
     }
@@ -142,7 +176,7 @@ export class RLNInstance {
       this._contract = await RLNContract.init(this, {
         address: address!,
         signer: signer!,
-        rateLimit: options.rateLimit
+        rateLimit: options.rateLimit ?? this.zerokit.getRateLimit
       });
       this.started = true;
     } finally {
@@ -164,6 +198,13 @@ export class RLNInstance {
       chainId = SEPOLIA_CONTRACT.chainId;
     }
 
+    // eslint-disable-next-line no-console
+    console.log({
+      chainId,
+      address,
+      SEPOLIA_CONTRACT
+    });
+
     const signer = options.signer || (await extractMetaMaskSigner());
     const currentChainId = await signer.getChainId();
 
@@ -271,7 +312,7 @@ export class RLNInstance {
     }
 
     const registryAddress = credentials.membership.address;
-    const currentRegistryAddress = this._contract.contract.address;
+    const currentRegistryAddress = this._contract.address;
     if (registryAddress !== currentRegistryAddress) {
       throw Error(
         `Failed to verify chain coordinates: credentials contract address=${registryAddress} is not equal to registryContract address=${currentRegistryAddress}`
@@ -279,7 +320,7 @@ export class RLNInstance {
     }
 
     const chainId = credentials.membership.chainId;
-    const network = await this._contract.contract.provider.getNetwork();
+    const network = await this._contract.provider.getNetwork();
     const currentChainId = network.chainId;
     if (chainId !== currentChainId) {
       throw Error(

package/src/zerokit.ts

@@ -15,9 +15,22 @@ import {
 export class Zerokit {
   public constructor(
     private readonly zkRLN: number,
-    private readonly witnessCalculator: WitnessCalculator
+    private readonly witnessCalculator: WitnessCalculator,
+    private readonly rateLimit: number = DEFAULT_RATE_LIMIT
   ) {}
 
+  public get getZkRLN(): number {
+    return this.zkRLN;
+  }
+
+  public get getWitnessCalculator(): WitnessCalculator {
+    return this.witnessCalculator;
+  }
+
+  public get getRateLimit(): number {
+    return this.rateLimit;
+  }
+
   public generateIdentityCredentials(): IdentityCredential {
     const memKeys = zerokitRLN.generateExtendedMembershipKey(this.zkRLN); // TODO: rename this function in zerokit rln-wasm
     return IdentityCredential.fromBytes(memKeys);
@@ -67,12 +80,17 @@ export class Zerokit {
     memIndex: number,
     epoch: Uint8Array,
     idKey: Uint8Array,
-    rateLimit: number = DEFAULT_RATE_LIMIT
+    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(new Uint8Array(8), rateLimit, 0, 8);
+    const rateLimitBytes = writeUIntLE(
+      new Uint8Array(8),
+      rateLimit ?? this.rateLimit,
+      0,
+      8
+    );
 
     // [ id_key<32> | id_index<8> | epoch<32> | signal_len<8> | signal<var> | rate_limit<8> ]
     return concatenate(
@@ -90,7 +108,7 @@ export class Zerokit {
     index: number,
     epoch: Uint8Array | Date | undefined,
     idSecretHash: Uint8Array,
-    rateLimit: number = DEFAULT_RATE_LIMIT
+    rateLimit?: number
   ): Promise<IRateLimitProof> {
     if (epoch === undefined) {
       epoch = epochIntToBytes(dateToEpoch(new Date()));
@@ -98,12 +116,14 @@ export class Zerokit {
       epoch = epochIntToBytes(dateToEpoch(epoch));
     }
 
+    const effectiveRateLimit = rateLimit ?? this.rateLimit;
+
     if (epoch.length !== 32) throw new Error("invalid epoch");
     if (idSecretHash.length !== 32) throw new Error("invalid id secret hash");
     if (index < 0) throw new Error("index must be >= 0");
     if (
-      rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
-      rateLimit > RATE_LIMIT_PARAMS.MAX_RATE
+      effectiveRateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
+      effectiveRateLimit > RATE_LIMIT_PARAMS.MAX_RATE
     ) {
       throw new Error(
         `Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`
@@ -115,7 +135,7 @@ export class Zerokit {
       index,
       epoch,
       idSecretHash,
-      rateLimit
+      effectiveRateLimit
     );
     const rlnWitness = zerokitRLN.getSerializedRLNWitness(
       this.zkRLN,
@@ -150,9 +170,12 @@ export class Zerokit {
 
     // calculate message length
     const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = rateLimit
-      ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
-      : new Uint8Array(8); // Zero if not specified
+    const rateLimitBytes = writeUIntLE(
+      new Uint8Array(8),
+      rateLimit ?? this.rateLimit,
+      0,
+      8
+    );
 
     return zerokitRLN.verifyRLNProof(
       this.zkRLN,
@@ -174,9 +197,12 @@ export class Zerokit {
     }
     // calculate message length
     const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = rateLimit
-      ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
-      : new Uint8Array(8); // Zero if not specified
+    const rateLimitBytes = writeUIntLE(
+      new Uint8Array(8),
+      rateLimit ?? this.rateLimit,
+      0,
+      8
+    );
 
     const rootsBytes = concatenate(...roots);
 
@@ -201,9 +227,12 @@ export class Zerokit {
 
     // calculate message length
     const msgLen = writeUIntLE(new Uint8Array(8), msg.length, 0, 8);
-    const rateLimitBytes = rateLimit
-      ? writeUIntLE(new Uint8Array(8), rateLimit, 0, 8)
-      : new Uint8Array(8); // Zero if not specified
+    const rateLimitBytes = writeUIntLE(
+      new Uint8Array(8),
+      rateLimit ?? this.rateLimit,
+      0,
+      8
+    );
 
     return zerokitRLN.verifyWithRoots(
       this.zkRLN,

package/bundle/packages/rln/dist/contract/abi/rlnv2.js

@@ -1,394 +0,0 @@
-const RLN_V2_ABI = [
-    {
-        type: "constructor",
-        inputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "error",
-        name: "DuplicateIdCommitment",
-        inputs: []
-    },
-    {
-        type: "error",
-        name: "InvalidIdCommitment",
-        inputs: [
-            {
-                name: "idCommitment",
-                type: "uint256"
-            }
-        ]
-    },
-    {
-        type: "error",
-        name: "InvalidPaginationQuery",
-        inputs: [
-            {
-                name: "startIndex",
-                type: "uint256"
-            },
-            {
-                name: "endIndex",
-                type: "uint256"
-            }
-        ]
-    },
-    {
-        type: "function",
-        name: "MAX_MEMBERSHIP_SET_SIZE",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint32"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "MERKLE_TREE_DEPTH",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint8"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "Q",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint256"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "activeDurationForNewMemberships",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint32"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "currentTotalRateLimit",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint256"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "deployedBlockNumber",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint32"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "depositsToWithdraw",
-        inputs: [
-            {
-                name: "holder",
-                type: "address"
-            },
-            {
-                name: "token",
-                type: "address"
-            }
-        ],
-        outputs: [
-            {
-                name: "balance",
-                type: "uint256"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "eraseMemberships",
-        inputs: [
-            {
-                name: "idCommitments",
-                type: "uint256[]"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "function",
-        name: "eraseMemberships",
-        inputs: [
-            {
-                name: "idCommitments",
-                type: "uint256[]"
-            },
-            {
-                name: "eraseFromMembershipSet",
-                type: "bool"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "function",
-        name: "extendMemberships",
-        inputs: [
-            {
-                name: "idCommitments",
-                type: "uint256[]"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "function",
-        name: "getMembershipInfo",
-        inputs: [
-            {
-                name: "idCommitment",
-                type: "uint256"
-            }
-        ],
-        outputs: [
-            {
-                name: "",
-                type: "uint32"
-            },
-            {
-                name: "",
-                type: "uint32"
-            },
-            {
-                name: "",
-                type: "uint256"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "getMerkleProof",
-        inputs: [
-            {
-                name: "index",
-                type: "uint40"
-            }
-        ],
-        outputs: [
-            {
-                name: "",
-                type: "uint256[20]"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "getRateCommitmentsInRangeBoundsInclusive",
-        inputs: [
-            {
-                name: "startIndex",
-                type: "uint32"
-            },
-            {
-                name: "endIndex",
-                type: "uint32"
-            }
-        ],
-        outputs: [
-            {
-                name: "",
-                type: "uint256[]"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "gracePeriodDurationForNewMemberships",
-        inputs: [],
-        outputs: [
-            {
-                name: "",
-                type: "uint32"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "initialize",
-        inputs: [
-            {
-                name: "_priceCalculator",
-                type: "address"
-            },
-            {
-                name: "_maxTotalRateLimit",
-                type: "uint32"
-            },
-            {
-                name: "_minMembershipRateLimit",
-                type: "uint32"
-            },
-            {
-                name: "_maxMembershipRateLimit",
-                type: "uint32"
-            },
-            {
-                name: "_activeDuration",
-                type: "uint32"
-            },
-            {
-                name: "_gracePeriod",
-                type: "uint32"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "function",
-        name: "isExpired",
-        inputs: [
-            {
-                name: "_idCommitment",
-                type: "uint256"
-            }
-        ],
-        outputs: [
-            {
-                name: "",
-                type: "bool"
-            }
-        ],
-        stateMutability: "view"
-    },
-    {
-        type: "function",
-        name: "register",
-        inputs: [
-            {
-                name: "idCommitment",
-                type: "uint256"
-            },
-            {
-                name: "rateLimit",
-                type: "uint32"
-            },
-            {
-                name: "idCommitmentsToErase",
-                type: "uint256[]"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "function",
-        name: "registerWithPermit",
-        inputs: [
-            {
-                name: "owner",
-                type: "address"
-            },
-            {
-                name: "deadline",
-                type: "uint256"
-            },
-            {
-                name: "v",
-                type: "uint8"
-            },
-            {
-                name: "r",
-                type: "bytes32"
-            },
-            {
-                name: "s",
-                type: "bytes32"
-            },
-            {
-                name: "idCommitment",
-                type: "uint256"
-            },
-            {
-                name: "rateLimit",
-                type: "uint32"
-            },
-            {
-                name: "idCommitmentsToErase",
-                type: "uint256[]"
-            }
-        ],
-        outputs: [],
-        stateMutability: "nonpayable"
-    },
-    {
-        type: "event",
-        name: "MembershipRegistered",
-        inputs: [
-            {
-                name: "idCommitment",
-                type: "uint256",
-                indexed: false
-            },
-            {
-                name: "rateLimit",
-                type: "uint32",
-                indexed: false
-            },
-            {
-                name: "index",
-                type: "uint256",
-                indexed: false
-            }
-        ],
-        anonymous: false
-    },
-    {
-        type: "event",
-        name: "MembershipRemoved",
-        inputs: [
-            {
-                name: "idCommitment",
-                type: "uint256",
-                indexed: false
-            },
-            {
-                name: "index",
-                type: "uint256",
-                indexed: false
-            }
-        ],
-        anonymous: false
-    }
-];
-
-export { RLN_V2_ABI };