@waku/rln 0.0.2-8a6571f.0 → 0.0.2-9094860.0

package/bundle/index.js

@@ -4,9 +4,11 @@ export { RLNContract } from './packages/rln/dist/contract/rln_contract.js';
 export { SEPOLIA_CONTRACT } from './packages/rln/dist/contract/constants.js';
 export { createRLN } from './packages/rln/dist/create.js';
 export { IdentityCredential } from './packages/rln/dist/identity.js';
+export { IdentityGenerator } from './packages/rln/dist/identity_generator.js';
 export { Keystore } from './packages/rln/dist/keystore/keystore.js';
 export { Proof } from './packages/rln/dist/proof.js';
 export { RLNInstance } from './packages/rln/dist/rln.js';
+export { RLNLight } from './packages/rln/dist/rln_light.js';
 export { MerkleRootTracker } from './packages/rln/dist/root_tracker.js';
 export { extractMetaMaskSigner } from './packages/rln/dist/utils/metamask.js';
 import './packages/rln/dist/utils/epoch.js';

package/bundle/packages/rln/dist/contract/rln_contract.js

@@ -25,7 +25,8 @@ class RLNContract {
     rateLimit;
     _members = new Map();
     _membersFilter;
-    _membersRemovedFilter;
+    _membershipErasedFilter;
+    _membersExpiredFilter;
     /**
      * Asynchronous initializer for RLNContract.
      * Allows injecting a mocked contract for testing purposes.
@@ -47,9 +48,10 @@ class RLNContract {
         // Use the injected contract if provided; otherwise, instantiate a new one.
         this.contract = contract || new Contract(address, RLN_ABI, signer);
         this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
-        // Initialize event filters for MembershipRegistered and MembershipErased
+        // Initialize event filters
         this._membersFilter = this.contract.filters.MembershipRegistered();
-        this._membersRemovedFilter = this.contract.filters.MembershipErased();
+        this._membershipErasedFilter = this.contract.filters.MembershipErased();
+        this._membersExpiredFilter = this.contract.filters.MembershipExpired();
     }
     /**
      * Gets the current rate limit for this contract instance
@@ -110,7 +112,7 @@ class RLNContract {
             this.contract.maxTotalRateLimit(),
             this.contract.currentTotalRateLimit()
         ]);
-        return maxTotal.sub(currentTotal).toNumber();
+        return Number(maxTotal) - Number(currentTotal);
     }
     /**
      * Updates the rate limit for future registrations
@@ -129,11 +131,17 @@ class RLNContract {
         }
         return this._membersFilter;
     }
-    get membersRemovedFilter() {
-        if (!this._membersRemovedFilter) {
-            throw Error("MembersErased filter was not initialized.");
+    get membershipErasedFilter() {
+        if (!this._membershipErasedFilter) {
+            throw Error("MembershipErased filter was not initialized.");
         }
-        return this._membersRemovedFilter;
+        return this._membershipErasedFilter;
+    }
+    get membersExpiredFilter() {
+        if (!this._membersExpiredFilter) {
+            throw Error("MembersExpired filter was not initialized.");
+        }
+        return this._membersExpiredFilter;
     }
     async fetchMembers(rlnInstance, options = {}) {
         const registeredMemberEvents = await queryFilter(this.contract, {
@@ -144,9 +152,18 @@ class RLNContract {
         const removedMemberEvents = await queryFilter(this.contract, {
             fromBlock: this.deployBlock,
             ...options,
-            membersFilter: this.membersRemovedFilter
+            membersFilter: this.membershipErasedFilter
         });
-        const events = [...registeredMemberEvents, ...removedMemberEvents];
+        const expiredMemberEvents = await queryFilter(this.contract, {
+            fromBlock: this.deployBlock,
+            ...options,
+            membersFilter: this.membersExpiredFilter
+        });
+        const events = [
+            ...registeredMemberEvents,
+            ...removedMemberEvents,
+            ...expiredMemberEvents
+        ];
         this.processEvents(rlnInstance, events);
     }
     processEvents(rlnInstance, events) {
@@ -156,8 +173,15 @@ class RLNContract {
             if (!evt.args) {
                 return;
             }
-            if (evt.event === "MembershipErased") {
-                const index = evt.args.index;
+            if (evt.event === "MembershipErased" ||
+                evt.event === "MembershipExpired") {
+                let index = evt.args.index;
+                if (!index) {
+                    return;
+                }
+                if (typeof index === "number" || typeof index === "string") {
+                    index = BigNumber.from(index);
+                }
                 const toRemoveVal = toRemoveTable.get(evt.blockNumber);
                 if (toRemoveVal != undefined) {
                     toRemoveVal.push(index.toNumber());
@@ -185,13 +209,17 @@ class RLNContract {
                 if (!evt.args)
                     return;
                 const _idCommitment = evt.args.idCommitment;
-                const index = evt.args.index;
+                let index = evt.args.index;
                 if (!_idCommitment || !index) {
                     return;
                 }
+                if (typeof index === "number" || typeof index === "string") {
+                    index = BigNumber.from(index);
+                }
                 const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
                 rlnInstance.zerokit.insertMember(idCommitment);
-                this._members.set(index.toNumber(), {
+                const numericIndex = index.toNumber();
+                this._members.set(numericIndex, {
                     index,
                     idCommitment: _idCommitment
                 });
@@ -213,18 +241,36 @@ class RLNContract {
         });
     }
     subscribeToMembers(rlnInstance) {
-        this.contract.on(this.membersFilter, (_idCommitment, _rateLimit, _index, event) => {
+        this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
+            this.processEvents(rlnInstance, [event]);
+        });
+        this.contract.on(this.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
-        this.contract.on(this.membersRemovedFilter, (_idCommitment, _rateLimit, _index, event) => {
+        this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
             this.processEvents(rlnInstance, [event]);
         });
     }
     async registerWithIdentity(identity) {
         try {
             log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
-            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit: 300000 });
+            // Check if the ID commitment is already registered
+            const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
+            if (existingIndex) {
+                throw new Error(`ID commitment is already registered with index ${existingIndex}`);
+            }
+            // Check if there's enough remaining rate limit
+            const remainingRateLimit = await this.getRemainingTotalRateLimit();
+            if (remainingRateLimit < this.rateLimit) {
+                throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
+            }
+            const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
+            const gasLimit = estimatedGas.add(10000);
+            const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
             const txRegisterReceipt = await txRegisterResponse.wait();
+            if (txRegisterReceipt.status === 0) {
+                throw new Error("Transaction failed on-chain");
+            }
             const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
             if (!memberRegistered || !memberRegistered.args) {
                 log.error("Failed to register membership: No MembershipRegistered event found");
@@ -232,14 +278,14 @@ class RLNContract {
             }
             const decodedData = {
                 idCommitment: memberRegistered.args.idCommitment,
-                rateLimit: memberRegistered.args.rateLimit,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
                 index: memberRegistered.args.index
             };
             log.info(`Successfully registered membership with index ${decodedData.index} ` +
-                `and rate limit ${decodedData.rateLimit}`);
+                `and rate limit ${decodedData.membershipRateLimit}`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
-            const membershipId = decodedData.index.toNumber();
+            const membershipId = Number(decodedData.index);
             return {
                 identity,
                 membership: {
@@ -250,8 +296,32 @@ class RLNContract {
             };
         }
         catch (error) {
-            log.error(`Error in registerWithIdentity: ${error.message}`);
-            return undefined;
+            if (error instanceof Error) {
+                const errorMessage = error.message;
+                log.error("registerWithIdentity - error message:", errorMessage);
+                log.error("registerWithIdentity - error stack:", error.stack);
+                // Try to extract more specific error information
+                if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
+                    throw new Error("Registration failed: Cannot exceed maximum total rate limit");
+                }
+                else if (errorMessage.includes("InvalidIdCommitment")) {
+                    throw new Error("Registration failed: Invalid ID commitment");
+                }
+                else if (errorMessage.includes("InvalidMembershipRateLimit")) {
+                    throw new Error("Registration failed: Invalid membership rate limit");
+                }
+                else if (errorMessage.includes("execution reverted")) {
+                    throw new Error("Contract execution reverted. Check contract requirements.");
+                }
+                else {
+                    throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
+                }
+            }
+            else {
+                throw new Error("Unknown error in registerWithIdentity", {
+                    cause: error
+                });
+            }
         }
     }
     /**
@@ -287,14 +357,14 @@ class RLNContract {
             }
             const decodedData = {
                 idCommitment: memberRegistered.args.idCommitment,
-                rateLimit: memberRegistered.args.rateLimit,
+                membershipRateLimit: memberRegistered.args.membershipRateLimit,
                 index: memberRegistered.args.index
             };
             log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
-                `Rate limit: ${decodedData.rateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
+                `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
             const network = await this.contract.provider.getNetwork();
             const address = this.contract.address;
-            const membershipId = decodedData.index.toNumber();
+            const membershipId = Number(decodedData.index);
             return {
                 identity,
                 membership: {

package/bundle/packages/rln/dist/identity_generator.js

@@ -0,0 +1,75 @@
+import { keccak256 } from '../../../node_modules/@ethersproject/keccak256/lib.esm/index.js';
+import { toUtf8Bytes } from '../../../node_modules/@ethersproject/strings/lib.esm/utf8.js';
+import { IdentityCredential } from './identity.js';
+import { buildBigIntFromUint8Array } from './utils/bytes.js';
+import './utils/epoch.js';
+
+/**
+ * A standalone implementation of identity generation for RLN memberships
+ * without Zerokit dependency. Only supports identity creation and membership
+ * registration.
+ */
+class IdentityGenerator {
+    /**
+     * Generate a new random identity credential
+     * @returns An IdentityCredential object
+     */
+    generateIdentityCredentials() {
+        // Generate random values for IDTrapdoor and IDNullifier
+        const idTrapdoor = crypto.getRandomValues(new Uint8Array(32));
+        const idNullifier = crypto.getRandomValues(new Uint8Array(32));
+        // Generate IDSecretHash by concatenating and hashing
+        const combined = new Uint8Array(64);
+        combined.set(idTrapdoor, 0);
+        combined.set(idNullifier, 32);
+        const idSecretHash = new Uint8Array(keccak256(combined)
+            .substring(2)
+            .match(/.{1,2}/g)
+            .map((byte) => parseInt(byte, 16)));
+        // Generate IDCommitment by hashing IDSecretHash
+        const idCommitment = new Uint8Array(keccak256(idSecretHash)
+            .substring(2)
+            .match(/.{1,2}/g)
+            .map((byte) => parseInt(byte, 16)));
+        // Generate BigInt from IDCommitment
+        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
+        return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
+    }
+    /**
+     * Generate an identity credential from a seed
+     * @param seed A string seed to generate a deterministic identity
+     * @returns An IdentityCredential object
+     */
+    generateSeededIdentityCredential(seed) {
+        // Convert seed to bytes
+        const seedBytes = toUtf8Bytes(seed);
+        // Use the seed to derive IDTrapdoor and IDNullifier deterministically
+        const seedHash = keccak256(seedBytes);
+        const seedHashBytes = new Uint8Array(seedHash
+            .substring(2)
+            .match(/.{1,2}/g)
+            .map((byte) => parseInt(byte, 16)));
+        // Use first half for IDTrapdoor, second half for IDNullifier
+        const idTrapdoor = seedHashBytes.slice(0, 32);
+        const idNullifier = keccak256(seedHashBytes).substring(2);
+        const idNullifierBytes = new Uint8Array(idNullifier.match(/.{1,2}/g).map((byte) => parseInt(byte, 16))).slice(0, 32);
+        // Generate IDSecretHash by concatenating and hashing
+        const combined = new Uint8Array(64);
+        combined.set(idTrapdoor, 0);
+        combined.set(idNullifierBytes, 32);
+        const idSecretHash = new Uint8Array(keccak256(combined)
+            .substring(2)
+            .match(/.{1,2}/g)
+            .map((byte) => parseInt(byte, 16)));
+        // Generate IDCommitment by hashing IDSecretHash
+        const idCommitment = new Uint8Array(keccak256(idSecretHash)
+            .substring(2)
+            .match(/.{1,2}/g)
+            .map((byte) => parseInt(byte, 16)));
+        // Generate BigInt from IDCommitment
+        const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment, 32);
+        return new IdentityCredential(idTrapdoor, idNullifierBytes, idSecretHash, idCommitment, idCommitmentBigInt);
+    }
+}
+
+export { IdentityGenerator };

package/bundle/packages/rln/dist/rln.js

@@ -100,8 +100,6 @@ class RLNInstance {
         return this._signer;
     }
     async start(options = {}) {
-        // eslint-disable-next-line no-console
-        console.log("starting", options);
         if (this.started || this.starting) {
             return;
         }
@@ -133,12 +131,6 @@ class RLNInstance {
         if (address === SEPOLIA_CONTRACT.address) {
             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();
         if (chainId && chainId !== currentChainId) {

package/bundle/packages/rln/dist/rln_light.js

@@ -0,0 +1,228 @@
+import '../../interfaces/dist/protocols.js';
+import '../../interfaces/dist/connection_manager.js';
+import '../../interfaces/dist/health_indicator.js';
+import '../../../node_modules/multiformats/dist/src/bases/base10.js';
+import '../../../node_modules/multiformats/dist/src/bases/base16.js';
+import '../../../node_modules/multiformats/dist/src/bases/base2.js';
+import '../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
+import '../../../node_modules/multiformats/dist/src/bases/base32.js';
+import '../../../node_modules/multiformats/dist/src/bases/base36.js';
+import '../../../node_modules/multiformats/dist/src/bases/base58.js';
+import '../../../node_modules/multiformats/dist/src/bases/base64.js';
+import '../../../node_modules/multiformats/dist/src/bases/base8.js';
+import '../../../node_modules/multiformats/dist/src/bases/identity.js';
+import '../../../node_modules/multiformats/dist/src/codecs/json.js';
+import { Logger } from '../../utils/dist/logger/index.js';
+import { RLNContract } from './contract/rln_contract.js';
+import { SEPOLIA_CONTRACT } from './contract/constants.js';
+import { IdentityGenerator } from './identity_generator.js';
+import { Keystore } from './keystore/keystore.js';
+import { extractMetaMaskSigner } from './utils/metamask.js';
+import './utils/epoch.js';
+
+const log = new Logger("waku:rln-light");
+/**
+ * Lightweight RLN implementation without Zerokit
+ * Only supports Keystore and membership registration
+ */
+class RLNLight {
+    started = false;
+    starting = false;
+    _contract;
+    _signer;
+    keystore = Keystore.create();
+    _credentials;
+    identityGenerator = new IdentityGenerator();
+    get contract() {
+        return this._contract;
+    }
+    get signer() {
+        return this._signer;
+    }
+    /**
+     * Get the current credentials
+     */
+    get credentials() {
+        return this._credentials;
+    }
+    /**
+     * Start the RLNLight instance
+     * @param options Configuration options
+     */
+    async start(options = {}) {
+        if (this.started || this.starting) {
+            log.warn("RLNLight already started or starting");
+            return;
+        }
+        this.starting = true;
+        try {
+            // Determine correct options based on credentials, if any
+            const keystoreCredentials = options.address
+                ? await this.findCredentialsByAddress(options.address)
+                : undefined;
+            const startOptions = await this.determineStartOptions(options, keystoreCredentials);
+            // Set the signer
+            if (startOptions.signer) {
+                this._signer = startOptions.signer;
+            }
+            else {
+                this._signer = await extractMetaMaskSigner();
+            }
+            // Initialize the contract with the correct address format
+            const finalAddress = typeof startOptions.address === "string"
+                ? startOptions.address
+                : SEPOLIA_CONTRACT.address;
+            const contractOptions = {
+                signer: this._signer,
+                address: finalAddress,
+                rateLimit: startOptions.rateLimit
+            };
+            // We need to create a minimal compatible object with RLNInstance interface
+            // but we only need it for contract initialization
+            const compatibleRLN = {
+                zerokit: {
+                    getMerkleRoot: () => new Uint8Array(32),
+                    insertMember: (_idCommitment) => { },
+                    insertMembers: (_index, ..._idCommitments) => { },
+                    deleteMember: (_index) => { }
+                }
+            };
+            this._contract = await RLNContract.init(
+            // Type assertion needed for compatibility with RLNInstance interface
+            // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            compatibleRLN, contractOptions);
+            this.started = true;
+        }
+        catch (error) {
+            log.error("Failed to start RLNLight:", error);
+            throw error;
+        }
+        finally {
+            this.starting = false;
+        }
+    }
+    /**
+     * Find credentials in the keystore by contract address
+     */
+    async findCredentialsByAddress(address) {
+        // Since Keystore doesn't have a direct method to find by address,
+        // we need to iterate through all credentials
+        const hashes = this.keystore.keys();
+        for (const hash of hashes) {
+            try {
+                // Try with an empty password - this won't work but lets us check schema
+                const credential = await this.keystore.readCredential(hash, new Uint8Array(0));
+                if (credential?.membership.address === address) {
+                    return credential;
+                }
+            }
+            catch (e) {
+                // Ignore errors, just means we couldn't read this credential
+            }
+        }
+        return undefined;
+    }
+    /**
+     * Determine the correct options for starting RLNLight
+     */
+    async determineStartOptions(options, credentials) {
+        if (options.credentials) {
+            const { credentials: decrypted } = await RLNLight.decryptCredentialsIfNeeded(options.credentials);
+            if (decrypted?.membership) {
+                this._credentials = decrypted;
+                return {
+                    ...options,
+                    address: decrypted.membership.address
+                };
+            }
+        }
+        else if (credentials) {
+            return {
+                ...options,
+                address: credentials.membership.address
+            };
+        }
+        return options;
+    }
+    /**
+     * Decrypt credentials if they are encrypted
+     */
+    static async decryptCredentialsIfNeeded(credentials) {
+        if (!credentials) {
+            return {};
+        }
+        if ("identity" in credentials) {
+            return { credentials };
+        }
+        else {
+            const keystore = Keystore.create();
+            try {
+                const decrypted = await keystore.readCredential(credentials.id, credentials.password);
+                if (!decrypted) {
+                    return {};
+                }
+                return {
+                    credentials: {
+                        identity: decrypted.identity,
+                        membership: decrypted.membership
+                    },
+                    keystore
+                };
+            }
+            catch (e) {
+                log.error("Failed to decrypt credentials", e);
+                return {};
+            }
+        }
+    }
+    /**
+     * Register a membership using an identity or signature
+     * @param options Options including identity or signature
+     * @returns Decrypted credentials if successful
+     */
+    async registerMembership(options) {
+        if (!this.contract) {
+            throw Error("RLN Contract is not initialized.");
+        }
+        let identity = "identity" in options && options.identity;
+        if ("signature" in options) {
+            identity = this.identityGenerator.generateSeededIdentityCredential(options.signature);
+        }
+        if (!identity) {
+            throw Error("Missing signature or identity to register membership.");
+        }
+        return this.contract.registerWithIdentity(identity);
+    }
+    /**
+     * Changes credentials in use by relying on provided Keystore
+     * @param id Hash of credentials to select from Keystore
+     * @param password Password to decrypt credentials from Keystore
+     */
+    async useCredentials(id, password) {
+        const decrypted = await this.keystore.readCredential(id, password);
+        if (!decrypted) {
+            throw new Error("Credentials not found or incorrect password");
+        }
+        this._credentials = {
+            identity: decrypted.identity,
+            membership: decrypted.membership
+        };
+    }
+    /**
+     * Generate a new identity credential
+     * @returns New identity credential
+     */
+    generateIdentityCredential() {
+        return this.identityGenerator.generateIdentityCredentials();
+    }
+    /**
+     * Generate a seeded identity credential
+     * @param seed Seed string to generate deterministic identity
+     * @returns Seeded identity credential
+     */
+    generateSeededIdentityCredential(seed) {
+        return this.identityGenerator.generateSeededIdentityCredential(seed);
+    }
+}
+
+export { RLNLight };