@waku/rln 0.0.2-09108d9.0 → 0.0.2-2380dac.0

package/dist/contract/constants.d.ts

@@ -1,7 +1,67 @@
-export declare const RLN_REGISTRY_ABI: string[];
-export declare const RLN_STORAGE_ABI: string[];
 export declare const SEPOLIA_CONTRACT: {
     chainId: number;
     address: string;
-    abi: 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

@@ -1,67 +1,26 @@
-// ref https://github.com/waku-org/waku-rln-contract/blob/19fded82bca07e7b535b429dc507cfb83f10dfcf/deployments/sepolia/WakuRlnRegistry_Implementation.json#L3
-export const RLN_REGISTRY_ABI = [
-    "error IncompatibleStorage()",
-    "error IncompatibleStorageIndex()",
-    "error NoStorageContractAvailable()",
-    "error StorageAlreadyExists(address storageAddress)",
-    "event AdminChanged(address previousAdmin, address newAdmin)",
-    "event BeaconUpgraded(address indexed beacon)",
-    "event Initialized(uint8 version)",
-    "event NewStorageContract(uint16 index, address storageAddress)",
-    "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
-    "event Upgraded(address indexed implementation)",
-    "function forceProgress()",
-    "function initialize(address _poseidonHasher)",
-    "function newStorage()",
-    "function nextStorageIndex() view returns (uint16)",
-    "function owner() view returns (address)",
-    "function poseidonHasher() view returns (address)",
-    "function proxiableUUID() view returns (bytes32)",
-    "function register(uint16 storageIndex, uint256 commitment)",
-    "function register(uint256[] commitments)",
-    "function register(uint16 storageIndex, uint256[] commitments)",
-    "function registerStorage(address storageAddress)",
-    "function renounceOwnership()",
-    "function storages(uint16) view returns (address)",
-    "function transferOwnership(address newOwner)",
-    "function upgradeTo(address newImplementation)",
-    "function upgradeToAndCall(address newImplementation, bytes data) payable",
-    "function usingStorageIndex() view returns (uint16)"
-];
-// ref https://github.com/waku-org/waku-rln-contract/blob/19fded82bca07e7b535b429dc507cfb83f10dfcf/deployments/sepolia/WakuRlnStorage_0.json#L3
-export const RLN_STORAGE_ABI = [
-    "constructor(address _poseidonHasher, uint16 _contractIndex)",
-    "error DuplicateIdCommitment()",
-    "error FullTree()",
-    "error InvalidIdCommitment(uint256 idCommitment)",
-    "error NotImplemented()",
-    "event MemberRegistered(uint256 idCommitment, uint256 index)",
-    "event MemberWithdrawn(uint256 idCommitment, uint256 index)",
-    "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
-    "function DEPTH() view returns (uint256)",
-    "function MEMBERSHIP_DEPOSIT() view returns (uint256)",
-    "function SET_SIZE() view returns (uint256)",
-    "function contractIndex() view returns (uint16)",
-    "function deployedBlockNumber() view returns (uint32)",
-    "function idCommitmentIndex() view returns (uint256)",
-    "function isValidCommitment(uint256 idCommitment) view returns (bool)",
-    "function memberExists(uint256) view returns (bool)",
-    "function members(uint256) view returns (uint256)",
-    "function owner() view returns (address)",
-    "function poseidonHasher() view returns (address)",
-    "function register(uint256[] idCommitments)",
-    "function register(uint256 idCommitment) payable",
-    "function renounceOwnership()",
-    "function slash(uint256 idCommitment, address receiver, uint256[8] proof) pure",
-    "function stakedAmounts(uint256) view returns (uint256)",
-    "function transferOwnership(address newOwner)",
-    "function verifier() view returns (address)",
-    "function withdraw() pure",
-    "function withdrawalBalance(address) view returns (uint256)"
-];
+import { RLN_ABI } from "./abi.js";
 export const SEPOLIA_CONTRACT = {
-    chainId: 11155111,
-    address: "0xF471d71E9b1455bBF4b85d475afb9BB0954A29c4",
-    abi: RLN_REGISTRY_ABI
+    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

@@ -1 +1 @@
-{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/contract/constants.ts"],"names":[],"mappings":"AAAA,6JAA6J;AAC7J,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,6BAA6B;IAC7B,kCAAkC;IAClC,oCAAoC;IACpC,oDAAoD;IACpD,6DAA6D;IAC7D,8CAA8C;IAC9C,kCAAkC;IAClC,gEAAgE;IAChE,qFAAqF;IACrF,gDAAgD;IAChD,0BAA0B;IAC1B,8CAA8C;IAC9C,uBAAuB;IACvB,mDAAmD;IACnD,yCAAyC;IACzC,kDAAkD;IAClD,iDAAiD;IACjD,4DAA4D;IAC5D,0CAA0C;IAC1C,+DAA+D;IAC/D,kDAAkD;IAClD,8BAA8B;IAC9B,kDAAkD;IAClD,8CAA8C;IAC9C,+CAA+C;IAC/C,0EAA0E;IAC1E,oDAAoD;CACrD,CAAC;AAEF,+IAA+I;AAC/I,MAAM,CAAC,MAAM,eAAe,GAAG;IAC7B,6DAA6D;IAC7D,+BAA+B;IAC/B,kBAAkB;IAClB,iDAAiD;IACjD,wBAAwB;IACxB,6DAA6D;IAC7D,4DAA4D;IAC5D,qFAAqF;IACrF,yCAAyC;IACzC,sDAAsD;IACtD,4CAA4C;IAC5C,gDAAgD;IAChD,sDAAsD;IACtD,qDAAqD;IACrD,sEAAsE;IACtE,oDAAoD;IACpD,kDAAkD;IAClD,yCAAyC;IACzC,kDAAkD;IAClD,4CAA4C;IAC5C,iDAAiD;IACjD,8BAA8B;IAC9B,+EAA+E;IAC/E,wDAAwD;IACxD,8CAA8C;IAC9C,4CAA4C;IAC5C,0BAA0B;IAC1B,4DAA4D;CAC7D,CAAC;AAEF,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,OAAO,EAAE,QAAQ;IACjB,OAAO,EAAE,4CAA4C;IACrD,GAAG,EAAE,gBAAgB;CACtB,CAAC"}
+{"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/rln_contract.d.ts

@@ -6,41 +6,124 @@ type Member = {
     idCommitment: string;
     index: ethers.BigNumber;
 };
-type Signer = ethers.Signer;
-type RLNContractOptions = {
-    signer: Signer;
-    registryAddress: string;
-};
-type RLNStorageOptions = {
-    storageIndex?: number;
-};
-type RLNContractInitOptions = RLNContractOptions & RLNStorageOptions;
+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 {
-    private registryContract;
+    contract: ethers.Contract;
     private merkleRootTracker;
     private deployBlock;
-    private storageIndex;
-    private storageContract;
-    private _membersFilter;
+    private rateLimit;
     private _members;
+    private _membersFilter;
+    private _membershipErasedFilter;
+    private _membersExpiredFilter;
+    /**
+     * Asynchronous initializer for RLNContract.
+     * Allows injecting a mocked contract for testing purposes.
+     */
     static init(rlnInstance: RLNInstance, options: RLNContractInitOptions): Promise<RLNContract>;
-    constructor(rlnInstance: RLNInstance, { registryAddress, signer }: RLNContractOptions);
-    private initStorageContract;
-    get registry(): ethers.Contract;
-    get contract(): ethers.Contract;
+    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 membershipErasedFilter();
+    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.ContractTransaction>;
+    eraseMembership(idCommitment: string, eraseFromMembershipSet?: boolean): Promise<ethers.ContractTransaction>;
+    registerMembership(idCommitment: string, rateLimit?: number): Promise<ethers.ContractTransaction>;
+    private getMemberIndex;
 }
 export {};