@waku/rln 0.0.1 → 0.0.2-00f2e75.0

package/dist/contract/constants.d.ts

@@ -0,0 +1,67 @@
+export declare const SEPOLIA_CONTRACT: {
+    chainId: number;
+    address: string;
+    abi: ({
+        inputs: never[];
+        stateMutability: string;
+        type: string;
+        name?: undefined;
+        anonymous?: undefined;
+        outputs?: undefined;
+    } | {
+        inputs: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+        stateMutability?: undefined;
+        anonymous?: undefined;
+        outputs?: undefined;
+    } | {
+        anonymous: boolean;
+        inputs: {
+            indexed: boolean;
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        type: string;
+        stateMutability?: undefined;
+        outputs?: undefined;
+    } | {
+        inputs: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        name: string;
+        outputs: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        stateMutability: string;
+        type: string;
+        anonymous?: undefined;
+    })[];
+};
+/**
+ * Rate limit tiers (messages per epoch)
+ * Each membership can specify a rate limit within these bounds.
+ * @see https://github.com/waku-org/specs/blob/master/standards/core/rln-contract.md#implementation-suggestions
+ */
+export declare const RATE_LIMIT_TIERS: {
+    readonly LOW: 20;
+    readonly MEDIUM: 200;
+    readonly HIGH: 600;
+};
+export declare const RATE_LIMIT_PARAMS: {
+    readonly MIN_RATE: 20;
+    readonly MAX_RATE: 600;
+    readonly MAX_TOTAL_RATE: 160000;
+    readonly EPOCH_LENGTH: 600;
+};
+export declare const DEFAULT_RATE_LIMIT: 600;

package/dist/contract/constants.js

@@ -0,0 +1,26 @@
+import { RLN_ABI } from "./abi.js";
+export const SEPOLIA_CONTRACT = {
+    chainId: 59141,
+    // Implementation contract: 0xde2260ca49300357d5af4153cda0d18f7b3ea9b3
+    address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
+    abi: RLN_ABI
+};
+/**
+ * Rate limit tiers (messages per epoch)
+ * Each membership can specify a rate limit within these bounds.
+ * @see https://github.com/waku-org/specs/blob/master/standards/core/rln-contract.md#implementation-suggestions
+ */
+export const RATE_LIMIT_TIERS = {
+    LOW: 20, // Suggested minimum rate - 20 messages per epoch
+    MEDIUM: 200,
+    HIGH: 600 // Suggested maximum rate - 600 messages per epoch
+};
+// Global rate limit parameters
+export const RATE_LIMIT_PARAMS = {
+    MIN_RATE: RATE_LIMIT_TIERS.LOW,
+    MAX_RATE: RATE_LIMIT_TIERS.HIGH,
+    MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
+    EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
+};
+export const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
+//# sourceMappingURL=constants.js.map

package/dist/contract/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/contract/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,KAAK;IACd,sEAAsE;IACtE,OAAO,EAAE,4CAA4C;IACrD,GAAG,EAAE,OAAO;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,EAAE,EAAE,iDAAiD;IAC1D,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG,CAAC,kDAAkD;CACpD,CAAC;AAEX,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,gBAAgB,CAAC,GAAG;IAC9B,QAAQ,EAAE,gBAAgB,CAAC,IAAI;IAC/B,cAAc,EAAE,OAAO,EAAE,kDAAkD;IAC3E,YAAY,EAAE,GAAG,CAAC,uCAAuC;CACjD,CAAC;AAEX,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC"}

package/dist/contract/index.d.ts

@@ -0,0 +1,2 @@
+export { RLNContract } from "./rln_contract.js";
+export * from "./constants.js";

package/dist/contract/index.js

@@ -0,0 +1,3 @@
+export { RLNContract } from "./rln_contract.js";
+export * from "./constants.js";
+//# sourceMappingURL=index.js.map

package/dist/contract/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,cAAc,gBAAgB,CAAC"}

package/dist/contract/rln_contract.d.ts

@@ -0,0 +1,135 @@
+import { ethers } from "ethers";
+import type { IdentityCredential } from "../identity.js";
+import type { DecryptedCredentials } from "../keystore/index.js";
+import type { RLNInstance } from "../rln.js";
+type Member = {
+    idCommitment: string;
+    index: ethers.BigNumber;
+};
+interface RLNContractOptions {
+    signer: ethers.Signer;
+    address: string;
+    rateLimit?: number;
+}
+interface RLNContractInitOptions extends RLNContractOptions {
+    contract?: ethers.Contract;
+}
+export interface MembershipRegisteredEvent {
+    idCommitment: string;
+    membershipRateLimit: ethers.BigNumber;
+    index: ethers.BigNumber;
+}
+type FetchMembersOptions = {
+    fromBlock?: number;
+    fetchRange?: number;
+    fetchChunks?: number;
+};
+export interface MembershipInfo {
+    index: ethers.BigNumber;
+    idCommitment: string;
+    rateLimit: number;
+    startBlock: number;
+    endBlock: number;
+    state: MembershipState;
+}
+export declare enum MembershipState {
+    Active = "Active",
+    GracePeriod = "GracePeriod",
+    Expired = "Expired",
+    ErasedAwaitsWithdrawal = "ErasedAwaitsWithdrawal"
+}
+export declare class RLNContract {
+    contract: ethers.Contract;
+    private merkleRootTracker;
+    private deployBlock;
+    private rateLimit;
+    private _members;
+    private _membersFilter;
+    private _membersRemovedFilter;
+    private _membersExpiredFilter;
+    /**
+     * Asynchronous initializer for RLNContract.
+     * Allows injecting a mocked contract for testing purposes.
+     */
+    static init(rlnInstance: RLNInstance, options: RLNContractInitOptions): Promise<RLNContract>;
+    private constructor();
+    /**
+     * Gets the current rate limit for this contract instance
+     */
+    getRateLimit(): number;
+    /**
+     * Gets the contract address
+     */
+    get address(): string;
+    /**
+     * Gets the contract provider
+     */
+    get provider(): ethers.providers.Provider;
+    /**
+     * Gets the minimum allowed rate limit from the contract
+     * @returns Promise<number> The minimum rate limit in messages per epoch
+     */
+    getMinRateLimit(): Promise<number>;
+    /**
+     * Gets the maximum allowed rate limit from the contract
+     * @returns Promise<number> The maximum rate limit in messages per epoch
+     */
+    getMaxRateLimit(): Promise<number>;
+    /**
+     * Gets the maximum total rate limit across all memberships
+     * @returns Promise<number> The maximum total rate limit in messages per epoch
+     */
+    getMaxTotalRateLimit(): Promise<number>;
+    /**
+     * Gets the current total rate limit usage across all memberships
+     * @returns Promise<number> The current total rate limit usage in messages per epoch
+     */
+    getCurrentTotalRateLimit(): Promise<number>;
+    /**
+     * Gets the remaining available total rate limit that can be allocated
+     * @returns Promise<number> The remaining rate limit that can be allocated
+     */
+    getRemainingTotalRateLimit(): Promise<number>;
+    /**
+     * Updates the rate limit for future registrations
+     * @param newRateLimit The new rate limit to use
+     */
+    setRateLimit(newRateLimit: number): Promise<void>;
+    get members(): Member[];
+    private get membersFilter();
+    private get membersRemovedFilter();
+    private get membersExpiredFilter();
+    fetchMembers(rlnInstance: RLNInstance, options?: FetchMembersOptions): Promise<void>;
+    processEvents(rlnInstance: RLNInstance, events: ethers.Event[]): void;
+    private insertMembers;
+    private removeMembers;
+    subscribeToMembers(rlnInstance: RLNInstance): void;
+    registerWithIdentity(identity: IdentityCredential): Promise<DecryptedCredentials | undefined>;
+    /**
+     * Helper method to get remaining messages in current epoch
+     * @param membershipId The ID of the membership to check
+     * @returns number of remaining messages allowed in current epoch
+     */
+    getRemainingMessages(membershipId: number): Promise<number>;
+    registerWithPermitAndErase(identity: IdentityCredential, permit: {
+        owner: string;
+        deadline: number;
+        v: number;
+        r: string;
+        s: string;
+    }, idCommitmentsToErase: string[]): Promise<DecryptedCredentials | undefined>;
+    roots(): Uint8Array[];
+    withdraw(token: string, holder: string): Promise<void>;
+    getMembershipInfo(idCommitment: string): Promise<MembershipInfo | undefined>;
+    extendMembership(idCommitment: string): Promise<ethers.ContractReceipt>;
+    eraseMembership(idCommitment: string, eraseFromMembershipSet?: boolean): Promise<ethers.ContractReceipt>;
+    registerMembership(idCommitment: string, rateLimit?: number): Promise<ethers.ContractTransaction>;
+    private getMemberIndex;
+    /**
+     * Debug function to check why a registration might fail
+     * @param idCommitment The ID commitment to check
+     * @param rateLimit The rate limit to check
+     */
+    debugRegistration(idCommitment: string, rateLimit: number): Promise<void>;
+}
+export {};