@waku/rln 0.0.2-09108d9.0 → 0.0.2-2eccb11.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (47) hide show
  1. package/bundle/_virtual/utils.js +2 -2
  2. package/bundle/_virtual/utils2.js +2 -2
  3. package/bundle/index.js +2 -1
  4. package/bundle/packages/rln/dist/contract/abi.js +648 -0
  5. package/bundle/packages/rln/dist/contract/constants.js +25 -65
  6. package/bundle/packages/rln/dist/contract/rln_contract.js +335 -74
  7. package/bundle/packages/rln/dist/message.js +1 -1
  8. package/bundle/packages/rln/dist/rln.js +42 -20
  9. package/bundle/packages/rln/dist/zerokit.js +34 -14
  10. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +1 -1
  11. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +2 -2
  12. package/bundle/packages/rln/node_modules/@noble/hashes/_sha2.js +1 -1
  13. package/bundle/packages/rln/node_modules/@noble/hashes/hmac.js +1 -1
  14. package/bundle/packages/rln/node_modules/@noble/hashes/pbkdf2.js +1 -1
  15. package/bundle/packages/rln/node_modules/@noble/hashes/scrypt.js +1 -1
  16. package/bundle/packages/rln/node_modules/@noble/hashes/sha256.js +1 -1
  17. package/bundle/packages/rln/node_modules/@noble/hashes/sha512.js +1 -1
  18. package/bundle/packages/rln/node_modules/@noble/hashes/utils.js +1 -1
  19. package/dist/.tsbuildinfo +1 -1
  20. package/dist/contract/abi.d.ts +46 -0
  21. package/dist/contract/abi.js +647 -0
  22. package/dist/contract/abi.js.map +1 -0
  23. package/dist/contract/constants.d.ts +63 -3
  24. package/dist/contract/constants.js +23 -64
  25. package/dist/contract/constants.js.map +1 -1
  26. package/dist/contract/rln_contract.d.ts +100 -17
  27. package/dist/contract/rln_contract.js +334 -72
  28. package/dist/contract/rln_contract.js.map +1 -1
  29. package/dist/index.d.ts +3 -3
  30. package/dist/index.js +3 -3
  31. package/dist/index.js.map +1 -1
  32. package/dist/message.js +1 -1
  33. package/dist/message.js.map +1 -1
  34. package/dist/rln.d.ts +5 -1
  35. package/dist/rln.js +42 -19
  36. package/dist/rln.js.map +1 -1
  37. package/dist/zerokit.d.ts +10 -6
  38. package/dist/zerokit.js +34 -14
  39. package/dist/zerokit.js.map +1 -1
  40. package/package.json +1 -1
  41. package/src/contract/abi.ts +646 -0
  42. package/src/contract/constants.ts +26 -65
  43. package/src/contract/rln_contract.ts +500 -108
  44. package/src/index.ts +4 -9
  45. package/src/message.ts +1 -1
  46. package/src/rln.ts +63 -21
  47. package/src/zerokit.ts +74 -15
@@ -1,68 +1,28 @@
1
- // ref https://github.com/waku-org/waku-rln-contract/blob/19fded82bca07e7b535b429dc507cfb83f10dfcf/deployments/sepolia/WakuRlnRegistry_Implementation.json#L3
2
- const RLN_REGISTRY_ABI = [
3
- "error IncompatibleStorage()",
4
- "error IncompatibleStorageIndex()",
5
- "error NoStorageContractAvailable()",
6
- "error StorageAlreadyExists(address storageAddress)",
7
- "event AdminChanged(address previousAdmin, address newAdmin)",
8
- "event BeaconUpgraded(address indexed beacon)",
9
- "event Initialized(uint8 version)",
10
- "event NewStorageContract(uint16 index, address storageAddress)",
11
- "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
12
- "event Upgraded(address indexed implementation)",
13
- "function forceProgress()",
14
- "function initialize(address _poseidonHasher)",
15
- "function newStorage()",
16
- "function nextStorageIndex() view returns (uint16)",
17
- "function owner() view returns (address)",
18
- "function poseidonHasher() view returns (address)",
19
- "function proxiableUUID() view returns (bytes32)",
20
- "function register(uint16 storageIndex, uint256 commitment)",
21
- "function register(uint256[] commitments)",
22
- "function register(uint16 storageIndex, uint256[] commitments)",
23
- "function registerStorage(address storageAddress)",
24
- "function renounceOwnership()",
25
- "function storages(uint16) view returns (address)",
26
- "function transferOwnership(address newOwner)",
27
- "function upgradeTo(address newImplementation)",
28
- "function upgradeToAndCall(address newImplementation, bytes data) payable",
29
- "function usingStorageIndex() view returns (uint16)"
30
- ];
31
- // ref https://github.com/waku-org/waku-rln-contract/blob/19fded82bca07e7b535b429dc507cfb83f10dfcf/deployments/sepolia/WakuRlnStorage_0.json#L3
32
- const RLN_STORAGE_ABI = [
33
- "constructor(address _poseidonHasher, uint16 _contractIndex)",
34
- "error DuplicateIdCommitment()",
35
- "error FullTree()",
36
- "error InvalidIdCommitment(uint256 idCommitment)",
37
- "error NotImplemented()",
38
- "event MemberRegistered(uint256 idCommitment, uint256 index)",
39
- "event MemberWithdrawn(uint256 idCommitment, uint256 index)",
40
- "event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)",
41
- "function DEPTH() view returns (uint256)",
42
- "function MEMBERSHIP_DEPOSIT() view returns (uint256)",
43
- "function SET_SIZE() view returns (uint256)",
44
- "function contractIndex() view returns (uint16)",
45
- "function deployedBlockNumber() view returns (uint32)",
46
- "function idCommitmentIndex() view returns (uint256)",
47
- "function isValidCommitment(uint256 idCommitment) view returns (bool)",
48
- "function memberExists(uint256) view returns (bool)",
49
- "function members(uint256) view returns (uint256)",
50
- "function owner() view returns (address)",
51
- "function poseidonHasher() view returns (address)",
52
- "function register(uint256[] idCommitments)",
53
- "function register(uint256 idCommitment) payable",
54
- "function renounceOwnership()",
55
- "function slash(uint256 idCommitment, address receiver, uint256[8] proof) pure",
56
- "function stakedAmounts(uint256) view returns (uint256)",
57
- "function transferOwnership(address newOwner)",
58
- "function verifier() view returns (address)",
59
- "function withdraw() pure",
60
- "function withdrawalBalance(address) view returns (uint256)"
61
- ];
1
+ import { RLN_ABI } from './abi.js';
2
+
62
3
  const SEPOLIA_CONTRACT = {
63
- chainId: 11155111,
64
- address: "0xF471d71E9b1455bBF4b85d475afb9BB0954A29c4",
65
- abi: RLN_REGISTRY_ABI
4
+ chainId: 59141,
5
+ // Implementation contract: 0xde2260ca49300357d5af4153cda0d18f7b3ea9b3
6
+ address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
7
+ abi: RLN_ABI
8
+ };
9
+ /**
10
+ * Rate limit tiers (messages per epoch)
11
+ * Each membership can specify a rate limit within these bounds.
12
+ * @see https://github.com/waku-org/specs/blob/master/standards/core/rln-contract.md#implementation-suggestions
13
+ */
14
+ const RATE_LIMIT_TIERS = {
15
+ LOW: 20, // Suggested minimum rate - 20 messages per epoch
16
+ MEDIUM: 200,
17
+ HIGH: 600 // Suggested maximum rate - 600 messages per epoch
18
+ };
19
+ // Global rate limit parameters
20
+ const RATE_LIMIT_PARAMS = {
21
+ MIN_RATE: RATE_LIMIT_TIERS.LOW,
22
+ MAX_RATE: RATE_LIMIT_TIERS.HIGH,
23
+ MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
24
+ EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
66
25
  };
26
+ const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
67
27
 
68
- export { RLN_REGISTRY_ABI, RLN_STORAGE_ABI, SEPOLIA_CONTRACT };
28
+ export { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS, SEPOLIA_CONTRACT };
@@ -5,56 +5,121 @@ import { hexToBytes } from '../../../utils/dist/bytes/index.js';
5
5
  import { Logger } from '../../../utils/dist/logger/index.js';
6
6
  import { MerkleRootTracker } from '../root_tracker.js';
7
7
  import { zeroPadLE } from '../utils/bytes.js';
8
- import '../utils/epoch.js';
9
- import { RLN_REGISTRY_ABI, RLN_STORAGE_ABI } from './constants.js';
8
+ import { RLN_ABI } from './abi.js';
9
+ import { RATE_LIMIT_PARAMS, DEFAULT_RATE_LIMIT } from './constants.js';
10
10
  import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
11
- import { AddressZero } from '../../../../node_modules/@ethersproject/constants/lib.esm/addresses.js';
11
+ import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
12
12
 
13
13
  const log = new Logger("waku:rln:contract");
14
+ var MembershipState;
15
+ (function (MembershipState) {
16
+ MembershipState["Active"] = "Active";
17
+ MembershipState["GracePeriod"] = "GracePeriod";
18
+ MembershipState["Expired"] = "Expired";
19
+ MembershipState["ErasedAwaitsWithdrawal"] = "ErasedAwaitsWithdrawal";
20
+ })(MembershipState || (MembershipState = {}));
14
21
  class RLNContract {
15
- registryContract;
22
+ contract;
16
23
  merkleRootTracker;
17
24
  deployBlock;
18
- storageIndex;
19
- storageContract;
20
- _membersFilter;
25
+ rateLimit;
21
26
  _members = new Map();
27
+ _membersFilter;
28
+ _membersRemovedFilter;
29
+ _membersExpiredFilter;
30
+ /**
31
+ * Asynchronous initializer for RLNContract.
32
+ * Allows injecting a mocked contract for testing purposes.
33
+ */
22
34
  static async init(rlnInstance, options) {
23
35
  const rlnContract = new RLNContract(rlnInstance, options);
24
- await rlnContract.initStorageContract(options.signer);
25
36
  await rlnContract.fetchMembers(rlnInstance);
26
37
  rlnContract.subscribeToMembers(rlnInstance);
27
38
  return rlnContract;
28
39
  }
29
- constructor(rlnInstance, { registryAddress, signer }) {
40
+ constructor(rlnInstance, options) {
41
+ const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
42
+ if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
43
+ rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
44
+ throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE} messages per epoch`);
45
+ }
46
+ this.rateLimit = rateLimit;
30
47
  const initialRoot = rlnInstance.zerokit.getMerkleRoot();
31
- this.registryContract = new Contract(registryAddress, RLN_REGISTRY_ABI, signer);
48
+ // Use the injected contract if provided; otherwise, instantiate a new one.
49
+ this.contract = contract || new Contract(address, RLN_ABI, signer);
32
50
  this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
51
+ // Initialize event filters for all relevant events
52
+ this._membersFilter = this.contract.filters.MembershipRegistered();
53
+ this._membersRemovedFilter = this.contract.filters.MembershipErased();
54
+ this._membersExpiredFilter = this.contract.filters.MembershipExpired();
33
55
  }
34
- async initStorageContract(signer, options = {}) {
35
- const storageIndex = options?.storageIndex
36
- ? options.storageIndex
37
- : await this.registryContract.usingStorageIndex();
38
- const storageAddress = await this.registryContract.storages(storageIndex);
39
- if (!storageAddress || storageAddress === AddressZero) {
40
- throw Error("No RLN Storage initialized on registry contract.");
41
- }
42
- this.storageIndex = storageIndex;
43
- this.storageContract = new Contract(storageAddress, RLN_STORAGE_ABI, signer);
44
- this._membersFilter = this.storageContract.filters.MemberRegistered();
45
- this.deployBlock = await this.storageContract.deployedBlockNumber();
56
+ /**
57
+ * Gets the current rate limit for this contract instance
58
+ */
59
+ getRateLimit() {
60
+ return this.rateLimit;
46
61
  }
47
- get registry() {
48
- if (!this.registryContract) {
49
- throw Error("Registry contract was not initialized");
50
- }
51
- return this.registryContract;
62
+ /**
63
+ * Gets the contract address
64
+ */
65
+ get address() {
66
+ return this.contract.address;
52
67
  }
53
- get contract() {
54
- if (!this.storageContract) {
55
- throw Error("Storage contract was not initialized");
56
- }
57
- return this.storageContract;
68
+ /**
69
+ * Gets the contract provider
70
+ */
71
+ get provider() {
72
+ return this.contract.provider;
73
+ }
74
+ /**
75
+ * Gets the minimum allowed rate limit from the contract
76
+ * @returns Promise<number> The minimum rate limit in messages per epoch
77
+ */
78
+ async getMinRateLimit() {
79
+ const minRate = await this.contract.minMembershipRateLimit();
80
+ return minRate.toNumber();
81
+ }
82
+ /**
83
+ * Gets the maximum allowed rate limit from the contract
84
+ * @returns Promise<number> The maximum rate limit in messages per epoch
85
+ */
86
+ async getMaxRateLimit() {
87
+ const maxRate = await this.contract.maxMembershipRateLimit();
88
+ return maxRate.toNumber();
89
+ }
90
+ /**
91
+ * Gets the maximum total rate limit across all memberships
92
+ * @returns Promise<number> The maximum total rate limit in messages per epoch
93
+ */
94
+ async getMaxTotalRateLimit() {
95
+ const maxTotalRate = await this.contract.maxTotalRateLimit();
96
+ return maxTotalRate.toNumber();
97
+ }
98
+ /**
99
+ * Gets the current total rate limit usage across all memberships
100
+ * @returns Promise<number> The current total rate limit usage in messages per epoch
101
+ */
102
+ async getCurrentTotalRateLimit() {
103
+ const currentTotal = await this.contract.currentTotalRateLimit();
104
+ return currentTotal.toNumber();
105
+ }
106
+ /**
107
+ * Gets the remaining available total rate limit that can be allocated
108
+ * @returns Promise<number> The remaining rate limit that can be allocated
109
+ */
110
+ async getRemainingTotalRateLimit() {
111
+ const [maxTotal, currentTotal] = await Promise.all([
112
+ this.contract.maxTotalRateLimit(),
113
+ this.contract.currentTotalRateLimit()
114
+ ]);
115
+ return maxTotal.sub(currentTotal).toNumber();
116
+ }
117
+ /**
118
+ * Updates the rate limit for future registrations
119
+ * @param newRateLimit The new rate limit to use
120
+ */
121
+ async setRateLimit(newRateLimit) {
122
+ this.rateLimit = newRateLimit;
58
123
  }
59
124
  get members() {
60
125
  const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
@@ -66,13 +131,40 @@ class RLNContract {
66
131
  }
67
132
  return this._membersFilter;
68
133
  }
134
+ get membersRemovedFilter() {
135
+ if (!this._membersRemovedFilter) {
136
+ throw Error("MembersErased filter was not initialized.");
137
+ }
138
+ return this._membersRemovedFilter;
139
+ }
140
+ get membersExpiredFilter() {
141
+ if (!this._membersExpiredFilter) {
142
+ throw Error("MembersExpired filter was not initialized.");
143
+ }
144
+ return this._membersExpiredFilter;
145
+ }
69
146
  async fetchMembers(rlnInstance, options = {}) {
70
147
  const registeredMemberEvents = await queryFilter(this.contract, {
71
148
  fromBlock: this.deployBlock,
72
149
  ...options,
73
150
  membersFilter: this.membersFilter
74
151
  });
75
- this.processEvents(rlnInstance, registeredMemberEvents);
152
+ const removedMemberEvents = await queryFilter(this.contract, {
153
+ fromBlock: this.deployBlock,
154
+ ...options,
155
+ membersFilter: this.membersRemovedFilter
156
+ });
157
+ const expiredMemberEvents = await queryFilter(this.contract, {
158
+ fromBlock: this.deployBlock,
159
+ ...options,
160
+ membersFilter: this.membersExpiredFilter
161
+ });
162
+ const events = [
163
+ ...registeredMemberEvents,
164
+ ...removedMemberEvents,
165
+ ...expiredMemberEvents
166
+ ];
167
+ this.processEvents(rlnInstance, events);
76
168
  }
77
169
  processEvents(rlnInstance, events) {
78
170
  const toRemoveTable = new Map();
@@ -81,8 +173,18 @@ class RLNContract {
81
173
  if (!evt.args) {
82
174
  return;
83
175
  }
84
- if (evt.removed) {
85
- const index = evt.args.index;
176
+ if (evt.event === "MembershipErased" ||
177
+ evt.event === "MembershipExpired") {
178
+ // Both MembershipErased and MembershipExpired events should remove members
179
+ let index = evt.args.index;
180
+ // Ensure index is an ethers.BigNumber
181
+ if (!index) {
182
+ return;
183
+ }
184
+ // Convert index to ethers.BigNumber if it's not already
185
+ if (typeof index === "number" || typeof index === "string") {
186
+ index = BigNumber.from(index);
187
+ }
86
188
  const toRemoveVal = toRemoveTable.get(evt.blockNumber);
87
189
  if (toRemoveVal != undefined) {
88
190
  toRemoveVal.push(index.toNumber());
@@ -92,7 +194,7 @@ class RLNContract {
92
194
  toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
93
195
  }
94
196
  }
95
- else {
197
+ else if (evt.event === "MembershipRegistered") {
96
198
  let eventsPerBlock = toInsertTable.get(evt.blockNumber);
97
199
  if (eventsPerBlock == undefined) {
98
200
  eventsPerBlock = [];
@@ -100,6 +202,7 @@ class RLNContract {
100
202
  eventsPerBlock.push(evt);
101
203
  toInsertTable.set(evt.blockNumber, eventsPerBlock);
102
204
  }
205
+ // MembershipExtended events don't change the membership set, so we don't need to handle them here
103
206
  });
104
207
  this.removeMembers(rlnInstance, toRemoveTable);
105
208
  this.insertMembers(rlnInstance, toInsertTable);
@@ -107,16 +210,25 @@ class RLNContract {
107
210
  insertMembers(rlnInstance, toInsert) {
108
211
  toInsert.forEach((events, blockNumber) => {
109
212
  events.forEach((evt) => {
110
- const _idCommitment = evt?.args?.idCommitment;
111
- const index = evt?.args?.index;
213
+ if (!evt.args)
214
+ return;
215
+ const _idCommitment = evt.args.idCommitment;
216
+ let index = evt.args.index;
217
+ // Ensure index is an ethers.BigNumber
112
218
  if (!_idCommitment || !index) {
113
219
  return;
114
220
  }
115
- const idCommitment = zeroPadLE(hexToBytes(_idCommitment?._hex), 32);
221
+ // Convert index to ethers.BigNumber if it's not already
222
+ if (typeof index === "number" || typeof index === "string") {
223
+ index = BigNumber.from(index);
224
+ }
225
+ const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
116
226
  rlnInstance.zerokit.insertMember(idCommitment);
117
- this._members.set(index.toNumber(), {
118
- index,
119
- idCommitment: _idCommitment?._hex
227
+ // Always store the numeric index as the key, but the BigNumber as the value
228
+ const numericIndex = index.toNumber();
229
+ this._members.set(numericIndex, {
230
+ index, // This is always a BigNumber
231
+ idCommitment: _idCommitment
120
232
  });
121
233
  });
122
234
  const currentRoot = rlnInstance.zerokit.getMerkleRoot();
@@ -124,7 +236,7 @@ class RLNContract {
124
236
  });
125
237
  }
126
238
  removeMembers(rlnInstance, toRemove) {
127
- const removeDescending = new Map([...toRemove].sort().reverse());
239
+ const removeDescending = new Map([...toRemove].reverse());
128
240
  removeDescending.forEach((indexes, blockNumber) => {
129
241
  indexes.forEach((index) => {
130
242
  if (this._members.has(index)) {
@@ -136,50 +248,191 @@ class RLNContract {
136
248
  });
137
249
  }
138
250
  subscribeToMembers(rlnInstance) {
139
- this.contract.on(this.membersFilter, (_pubkey, _index, event) => this.processEvents(rlnInstance, [event]));
251
+ this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
252
+ this.processEvents(rlnInstance, [event]);
253
+ });
254
+ this.contract.on(this.membersRemovedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
255
+ this.processEvents(rlnInstance, [event]);
256
+ });
257
+ this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
258
+ this.processEvents(rlnInstance, [event]);
259
+ });
140
260
  }
141
261
  async registerWithIdentity(identity) {
142
- if (this.storageIndex === undefined) {
143
- throw Error("Cannot register credential, no storage contract index found.");
144
- }
145
- const txRegisterResponse = await this.registryContract["register(uint16,uint256)"](this.storageIndex, identity.IDCommitmentBigInt, { gasLimit: 100000 });
146
- const txRegisterReceipt = await txRegisterResponse.wait();
147
- // assumption: register(uint16,uint256) emits one event
148
- const memberRegistered = txRegisterReceipt?.events?.[0];
149
- if (!memberRegistered) {
262
+ try {
263
+ log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
264
+ const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit: 300000 });
265
+ const txRegisterReceipt = await txRegisterResponse.wait();
266
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
267
+ if (!memberRegistered || !memberRegistered.args) {
268
+ log.error("Failed to register membership: No MembershipRegistered event found");
269
+ return undefined;
270
+ }
271
+ const decodedData = {
272
+ idCommitment: memberRegistered.args.idCommitment,
273
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
274
+ index: memberRegistered.args.index
275
+ };
276
+ log.info(`Successfully registered membership with index ${decodedData.index} ` +
277
+ `and rate limit ${decodedData.membershipRateLimit}`);
278
+ const network = await this.contract.provider.getNetwork();
279
+ const address = this.contract.address;
280
+ const membershipId = decodedData.index.toNumber();
281
+ return {
282
+ identity,
283
+ membership: {
284
+ address,
285
+ treeIndex: membershipId,
286
+ chainId: network.chainId
287
+ }
288
+ };
289
+ }
290
+ catch (error) {
291
+ log.error(`Error in registerWithIdentity: ${error.message}`);
150
292
  return undefined;
151
293
  }
152
- const decodedData = this.contract.interface.decodeEventLog("MemberRegistered", memberRegistered.data);
153
- const network = await this.registryContract.provider.getNetwork();
154
- const address = this.registryContract.address;
155
- const membershipId = decodedData.index.toNumber();
156
- return {
157
- identity,
158
- membership: {
159
- address,
160
- treeIndex: membershipId,
161
- chainId: network.chainId
294
+ }
295
+ /**
296
+ * Helper method to get remaining messages in current epoch
297
+ * @param membershipId The ID of the membership to check
298
+ * @returns number of remaining messages allowed in current epoch
299
+ */
300
+ async getRemainingMessages(membershipId) {
301
+ try {
302
+ const [startTime, , rateLimit] = await this.contract.getMembershipInfo(membershipId);
303
+ // Calculate current epoch
304
+ const currentTime = Math.floor(Date.now() / 1000);
305
+ const epochsPassed = Math.floor((currentTime - startTime) / RATE_LIMIT_PARAMS.EPOCH_LENGTH);
306
+ const currentEpochStart = startTime + epochsPassed * RATE_LIMIT_PARAMS.EPOCH_LENGTH;
307
+ // Get message count in current epoch using contract's function
308
+ const messageCount = await this.contract.getMessageCount(membershipId, currentEpochStart);
309
+ return Math.max(0, rateLimit.sub(messageCount).toNumber());
310
+ }
311
+ catch (error) {
312
+ log.error(`Error getting remaining messages: ${error.message}`);
313
+ return 0; // Fail safe: assume no messages remaining on error
314
+ }
315
+ }
316
+ async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
317
+ try {
318
+ log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
319
+ const txRegisterResponse = await this.contract.registerWithPermit(permit.owner, permit.deadline, permit.v, permit.r, permit.s, identity.IDCommitmentBigInt, this.rateLimit, idCommitmentsToErase.map((id) => BigNumber.from(id)));
320
+ const txRegisterReceipt = await txRegisterResponse.wait();
321
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
322
+ if (!memberRegistered || !memberRegistered.args) {
323
+ log.error("Failed to register membership with permit: No MembershipRegistered event found");
324
+ return undefined;
162
325
  }
163
- };
326
+ const decodedData = {
327
+ idCommitment: memberRegistered.args.idCommitment,
328
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
329
+ index: memberRegistered.args.index
330
+ };
331
+ log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
332
+ `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
333
+ const network = await this.contract.provider.getNetwork();
334
+ const address = this.contract.address;
335
+ const membershipId = decodedData.index.toNumber();
336
+ return {
337
+ identity,
338
+ membership: {
339
+ address,
340
+ treeIndex: membershipId,
341
+ chainId: network.chainId
342
+ }
343
+ };
344
+ }
345
+ catch (error) {
346
+ log.error(`Error in registerWithPermitAndErase: ${error.message}`);
347
+ return undefined;
348
+ }
164
349
  }
165
350
  roots() {
166
351
  return this.merkleRootTracker.roots();
167
352
  }
353
+ async withdraw(token, holder) {
354
+ try {
355
+ const tx = await this.contract.withdraw(token, { from: holder });
356
+ await tx.wait();
357
+ }
358
+ catch (error) {
359
+ log.error(`Error in withdraw: ${error.message}`);
360
+ }
361
+ }
362
+ async getMembershipInfo(idCommitment) {
363
+ try {
364
+ const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
365
+ const currentBlock = await this.contract.provider.getBlockNumber();
366
+ let state;
367
+ if (currentBlock < startBlock) {
368
+ state = MembershipState.Active;
369
+ }
370
+ else if (currentBlock < endBlock) {
371
+ state = MembershipState.GracePeriod;
372
+ }
373
+ else {
374
+ state = MembershipState.Expired;
375
+ }
376
+ const index = await this.getMemberIndex(idCommitment);
377
+ if (!index)
378
+ return undefined;
379
+ return {
380
+ index,
381
+ idCommitment,
382
+ rateLimit: rateLimit.toNumber(),
383
+ startBlock: startBlock.toNumber(),
384
+ endBlock: endBlock.toNumber(),
385
+ state
386
+ };
387
+ }
388
+ catch (error) {
389
+ return undefined;
390
+ }
391
+ }
392
+ async extendMembership(idCommitment) {
393
+ const tx = await this.contract.extendMemberships([idCommitment]);
394
+ return await tx.wait();
395
+ }
396
+ async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
397
+ const tx = await this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
398
+ return await tx.wait();
399
+ }
400
+ async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
401
+ if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
402
+ rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
403
+ throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
404
+ }
405
+ const tx = await this.contract.register(idCommitment, rateLimit, []);
406
+ return await tx.wait();
407
+ }
408
+ async getMemberIndex(idCommitment) {
409
+ try {
410
+ const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitment));
411
+ if (events.length === 0)
412
+ return undefined;
413
+ // Get the most recent registration event
414
+ const event = events[events.length - 1];
415
+ return event.args?.index;
416
+ }
417
+ catch (error) {
418
+ return undefined;
419
+ }
420
+ }
168
421
  }
169
- // these value should be tested on other networks
422
+ // These values should be tested on other networks
170
423
  const FETCH_CHUNK = 5;
171
424
  const BLOCK_RANGE = 3000;
172
425
  async function queryFilter(contract, options) {
173
426
  const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
174
- if (!fromBlock) {
427
+ if (fromBlock === undefined) {
175
428
  return contract.queryFilter(membersFilter);
176
429
  }
177
- if (!contract.signer.provider) {
178
- throw Error("No provider found on the contract's signer.");
430
+ if (!contract.provider) {
431
+ throw Error("No provider found on the contract.");
179
432
  }
180
- const toBlock = await contract.signer.provider.getBlockNumber();
433
+ const toBlock = await contract.provider.getBlockNumber();
181
434
  if (toBlock - fromBlock < fetchRange) {
182
- return contract.queryFilter(membersFilter);
435
+ return contract.queryFilter(membersFilter, fromBlock, toBlock);
183
436
  }
184
437
  const events = [];
185
438
  const chunks = splitToChunks(fromBlock, toBlock, fetchRange);
@@ -208,11 +461,19 @@ function* takeN(array, size) {
208
461
  start += size;
209
462
  }
210
463
  }
211
- function ignoreErrors(promise, defaultValue) {
212
- return promise.catch((err) => {
213
- log.info(`Ignoring an error during query: ${err?.message}`);
464
+ async function ignoreErrors(promise, defaultValue) {
465
+ try {
466
+ return await promise;
467
+ }
468
+ catch (err) {
469
+ if (err instanceof Error) {
470
+ log.info(`Ignoring an error during query: ${err.message}`);
471
+ }
472
+ else {
473
+ log.info(`Ignoring an unknown error during query`);
474
+ }
214
475
  return defaultValue;
215
- });
476
+ }
216
477
  }
217
478
 
218
- export { RLNContract };
479
+ export { MembershipState, RLNContract };
@@ -17,7 +17,7 @@ class RlnMessage {
17
17
  }
18
18
  verify(roots) {
19
19
  return this.rateLimitProof
20
- ? this.rlnInstance.zerokit.verifyWithRoots(this.rateLimitProof, toRLNSignal(this.msg.contentTopic, this.msg), ...roots) // this.rlnInstance.verifyRLNProof once issue status-im/nwaku#1248 is fixed
20
+ ? this.rlnInstance.zerokit.verifyWithRoots(this.rateLimitProof, toRLNSignal(this.msg.contentTopic, this.msg), roots) // this.rlnInstance.verifyRLNProof once issue status-im/nwaku#1248 is fixed
21
21
  : undefined;
22
22
  }
23
23
  verifyNoRoot() {