@waku/rln 0.1.5-053bb95.0 → 0.1.5-197ba46.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 (158) 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/constants.js +6 -2
  5. package/bundle/packages/rln/dist/contract/rln_base_contract.js +274 -141
  6. package/bundle/packages/rln/dist/contract/rln_contract.js +74 -89
  7. package/bundle/packages/rln/dist/credentials_manager.js +1 -1
  8. package/bundle/packages/rln/dist/identity.js +0 -8
  9. package/bundle/packages/rln/dist/keystore/keystore.js +28 -15
  10. package/bundle/packages/rln/dist/utils/bytes.js +8 -2
  11. package/bundle/packages/rln/dist/utils/metamask.js +2 -2
  12. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +1 -1
  13. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +2 -2
  14. package/bundle/packages/rln/node_modules/@noble/hashes/_sha2.js +1 -1
  15. package/bundle/packages/rln/node_modules/@noble/hashes/hmac.js +1 -1
  16. package/bundle/packages/rln/node_modules/@noble/hashes/pbkdf2.js +1 -1
  17. package/bundle/packages/rln/node_modules/@noble/hashes/scrypt.js +1 -1
  18. package/bundle/packages/rln/node_modules/@noble/hashes/sha256.js +1 -1
  19. package/bundle/packages/rln/node_modules/@noble/hashes/sha512.js +1 -1
  20. package/bundle/packages/rln/node_modules/@noble/hashes/utils.js +1 -1
  21. package/dist/.tsbuildinfo +1 -1
  22. package/dist/contract/constants.d.ts +1 -1
  23. package/dist/contract/constants.js +1 -1
  24. package/dist/contract/constants.js.map +1 -1
  25. package/dist/contract/index.d.ts +1 -0
  26. package/dist/contract/index.js +1 -0
  27. package/dist/contract/index.js.map +1 -1
  28. package/dist/contract/rln_base_contract.d.ts +27 -25
  29. package/dist/contract/rln_base_contract.js +272 -139
  30. package/dist/contract/rln_base_contract.js.map +1 -1
  31. package/dist/contract/rln_contract.d.ts +4 -24
  32. package/dist/contract/rln_contract.js +74 -89
  33. package/dist/contract/rln_contract.js.map +1 -1
  34. package/dist/contract/types.d.ts +5 -0
  35. package/dist/contract/types.js.map +1 -1
  36. package/dist/credentials_manager.js +1 -1
  37. package/dist/credentials_manager.js.map +1 -1
  38. package/dist/identity.d.ts +0 -1
  39. package/dist/identity.js +0 -8
  40. package/dist/identity.js.map +1 -1
  41. package/dist/index.d.ts +2 -1
  42. package/dist/index.js +1 -0
  43. package/dist/index.js.map +1 -1
  44. package/dist/keystore/keystore.d.ts +1 -0
  45. package/dist/keystore/keystore.js +28 -15
  46. package/dist/keystore/keystore.js.map +1 -1
  47. package/dist/keystore/types.d.ts +2 -2
  48. package/dist/utils/bytes.js +8 -2
  49. package/dist/utils/bytes.js.map +1 -1
  50. package/package.json +1 -1
  51. package/src/contract/constants.ts +1 -1
  52. package/src/contract/index.ts +1 -0
  53. package/src/contract/rln_base_contract.ts +419 -211
  54. package/src/contract/rln_contract.ts +95 -120
  55. package/src/contract/types.ts +5 -0
  56. package/src/credentials_manager.ts +1 -1
  57. package/src/identity.ts +0 -9
  58. package/src/index.ts +3 -1
  59. package/src/keystore/keystore.ts +54 -29
  60. package/src/keystore/types.ts +2 -2
  61. package/src/utils/bytes.ts +10 -2
  62. package/bundle/_virtual/__node-resolve_empty.js +0 -6
  63. package/bundle/_virtual/_node-resolve_empty.js +0 -3
  64. package/bundle/_virtual/bn.js +0 -3
  65. package/bundle/_virtual/common.js +0 -3
  66. package/bundle/_virtual/common2.js +0 -3
  67. package/bundle/_virtual/hash.js +0 -3
  68. package/bundle/_virtual/inherits_browser.js +0 -3
  69. package/bundle/_virtual/ripemd.js +0 -3
  70. package/bundle/_virtual/sha.js +0 -3
  71. package/bundle/_virtual/sha3.js +0 -3
  72. package/bundle/_virtual/utils3.js +0 -3
  73. package/bundle/node_modules/@ethersproject/abi/lib.esm/_version.js +0 -3
  74. package/bundle/node_modules/@ethersproject/abi/lib.esm/abi-coder.js +0 -96
  75. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/abstract-coder.js +0 -148
  76. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/address.js +0 -26
  77. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/anonymous.js +0 -20
  78. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/array.js +0 -210
  79. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/boolean.js +0 -18
  80. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/bytes.js +0 -30
  81. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/fixed-bytes.js +0 -26
  82. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/null.js +0 -22
  83. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/number.js +0 -43
  84. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/string.js +0 -19
  85. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/tuple.js +0 -58
  86. package/bundle/node_modules/@ethersproject/abi/lib.esm/fragments.js +0 -854
  87. package/bundle/node_modules/@ethersproject/abi/lib.esm/interface.js +0 -609
  88. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/_version.js +0 -3
  89. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/index.js +0 -66
  90. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/_version.js +0 -3
  91. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/index.js +0 -302
  92. package/bundle/node_modules/@ethersproject/address/lib.esm/_version.js +0 -3
  93. package/bundle/node_modules/@ethersproject/address/lib.esm/index.js +0 -110
  94. package/bundle/node_modules/@ethersproject/base64/lib.esm/base64.js +0 -20
  95. package/bundle/node_modules/@ethersproject/basex/lib.esm/index.js +0 -120
  96. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/_version.js +0 -3
  97. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/bignumber.js +0 -287
  98. package/bundle/node_modules/@ethersproject/bytes/lib.esm/_version.js +0 -3
  99. package/bundle/node_modules/@ethersproject/bytes/lib.esm/index.js +0 -402
  100. package/bundle/node_modules/@ethersproject/constants/lib.esm/addresses.js +0 -3
  101. package/bundle/node_modules/@ethersproject/constants/lib.esm/bignumbers.js +0 -8
  102. package/bundle/node_modules/@ethersproject/constants/lib.esm/hashes.js +0 -3
  103. package/bundle/node_modules/@ethersproject/contracts/lib.esm/_version.js +0 -3
  104. package/bundle/node_modules/@ethersproject/contracts/lib.esm/index.js +0 -893
  105. package/bundle/node_modules/@ethersproject/hash/lib.esm/_version.js +0 -3
  106. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/decoder.js +0 -256
  107. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/include.js +0 -36
  108. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/lib.js +0 -135
  109. package/bundle/node_modules/@ethersproject/hash/lib.esm/id.js +0 -8
  110. package/bundle/node_modules/@ethersproject/hash/lib.esm/namehash.js +0 -64
  111. package/bundle/node_modules/@ethersproject/hash/lib.esm/typed-data.js +0 -443
  112. package/bundle/node_modules/@ethersproject/keccak256/lib.esm/index.js +0 -8
  113. package/bundle/node_modules/@ethersproject/keccak256/node_modules/js-sha3/src/sha3.js +0 -660
  114. package/bundle/node_modules/@ethersproject/logger/lib.esm/_version.js +0 -3
  115. package/bundle/node_modules/@ethersproject/logger/lib.esm/index.js +0 -352
  116. package/bundle/node_modules/@ethersproject/networks/lib.esm/_version.js +0 -3
  117. package/bundle/node_modules/@ethersproject/networks/lib.esm/index.js +0 -248
  118. package/bundle/node_modules/@ethersproject/properties/lib.esm/_version.js +0 -3
  119. package/bundle/node_modules/@ethersproject/properties/lib.esm/index.js +0 -127
  120. package/bundle/node_modules/@ethersproject/providers/lib.esm/_version.js +0 -3
  121. package/bundle/node_modules/@ethersproject/providers/lib.esm/base-provider.js +0 -2007
  122. package/bundle/node_modules/@ethersproject/providers/lib.esm/formatter.js +0 -422
  123. package/bundle/node_modules/@ethersproject/providers/lib.esm/json-rpc-provider.js +0 -674
  124. package/bundle/node_modules/@ethersproject/providers/lib.esm/web3-provider.js +0 -132
  125. package/bundle/node_modules/@ethersproject/rlp/lib.esm/_version.js +0 -3
  126. package/bundle/node_modules/@ethersproject/rlp/lib.esm/index.js +0 -120
  127. package/bundle/node_modules/@ethersproject/sha2/lib.esm/sha2.js +0 -8
  128. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/_version.js +0 -3
  129. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/elliptic.js +0 -2430
  130. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/index.js +0 -76
  131. package/bundle/node_modules/@ethersproject/strings/lib.esm/_version.js +0 -3
  132. package/bundle/node_modules/@ethersproject/strings/lib.esm/utf8.js +0 -219
  133. package/bundle/node_modules/@ethersproject/transactions/lib.esm/_version.js +0 -3
  134. package/bundle/node_modules/@ethersproject/transactions/lib.esm/index.js +0 -279
  135. package/bundle/node_modules/@ethersproject/web/lib.esm/_version.js +0 -3
  136. package/bundle/node_modules/@ethersproject/web/lib.esm/geturl.js +0 -69
  137. package/bundle/node_modules/@ethersproject/web/lib.esm/index.js +0 -404
  138. package/bundle/node_modules/bech32/index.js +0 -187
  139. package/bundle/node_modules/bn.js/lib/bn.js +0 -3361
  140. package/bundle/node_modules/hash.js/lib/hash/common.js +0 -97
  141. package/bundle/node_modules/hash.js/lib/hash/hmac.js +0 -51
  142. package/bundle/node_modules/hash.js/lib/hash/ripemd.js +0 -152
  143. package/bundle/node_modules/hash.js/lib/hash/sha/1.js +0 -81
  144. package/bundle/node_modules/hash.js/lib/hash/sha/224.js +0 -33
  145. package/bundle/node_modules/hash.js/lib/hash/sha/256.js +0 -113
  146. package/bundle/node_modules/hash.js/lib/hash/sha/384.js +0 -39
  147. package/bundle/node_modules/hash.js/lib/hash/sha/512.js +0 -336
  148. package/bundle/node_modules/hash.js/lib/hash/sha/common.js +0 -53
  149. package/bundle/node_modules/hash.js/lib/hash/sha.js +0 -14
  150. package/bundle/node_modules/hash.js/lib/hash/utils.js +0 -282
  151. package/bundle/node_modules/hash.js/lib/hash.js +0 -33
  152. package/bundle/node_modules/inherits/inherits_browser.js +0 -33
  153. package/bundle/node_modules/minimalistic-assert/index.js +0 -13
  154. package/bundle/packages/rln/dist/contract/errors.js +0 -62
  155. package/dist/contract/errors.d.ts +0 -30
  156. package/dist/contract/errors.js +0 -61
  157. package/dist/contract/errors.js.map +0 -1
  158. package/src/contract/errors.ts +0 -75
@@ -1,3 +1,3 @@
1
- var utils = {exports: {}};
1
+ var utils = {};
2
2
 
3
- export { utils as __module };
3
+ export { utils as __exports };
@@ -1,3 +1,3 @@
1
- var utils = {};
1
+ var utils = {exports: {}};
2
2
 
3
- export { utils as __exports };
3
+ export { utils as __module };
package/bundle/index.js CHANGED
@@ -1,7 +1,8 @@
1
1
  export { RLNDecoder, RLNEncoder } from './packages/rln/dist/codec.js';
2
2
  export { RLN_ABI } from './packages/rln/dist/contract/abi.js';
3
3
  export { RLNContract } from './packages/rln/dist/contract/rln_contract.js';
4
- export { LINEA_CONTRACT } from './packages/rln/dist/contract/constants.js';
4
+ export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS } from './packages/rln/dist/contract/constants.js';
5
+ export { MembershipState } from './packages/rln/dist/contract/types.js';
5
6
  export { RLNBaseContract } from './packages/rln/dist/contract/rln_base_contract.js';
6
7
  export { createRLN } from './packages/rln/dist/create.js';
7
8
  export { RLNCredentialsManager } from './packages/rln/dist/credentials_manager.js';
@@ -1,7 +1,7 @@
1
1
  import { RLN_ABI } from './abi.js';
2
2
 
3
3
  const LINEA_CONTRACT = {
4
- chainId: "59141",
4
+ chainId: 59141,
5
5
  address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
6
6
  abi: RLN_ABI
7
7
  };
@@ -12,12 +12,16 @@ const LINEA_CONTRACT = {
12
12
  */
13
13
  const RATE_LIMIT_TIERS = {
14
14
  LOW: 20, // Suggested minimum rate - 20 messages per epoch
15
+ MEDIUM: 200,
15
16
  HIGH: 600 // Suggested maximum rate - 600 messages per epoch
16
17
  };
17
18
  // Global rate limit parameters
18
19
  const RATE_LIMIT_PARAMS = {
19
20
  MIN_RATE: RATE_LIMIT_TIERS.LOW,
20
- MAX_RATE: RATE_LIMIT_TIERS.HIGH};
21
+ MAX_RATE: RATE_LIMIT_TIERS.HIGH,
22
+ MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
23
+ EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
24
+ };
21
25
  const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
22
26
 
23
27
  export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };
@@ -15,20 +15,52 @@ import '../../../../node_modules/multiformats/dist/src/codecs/json.js';
15
15
  import { Logger } from '../../../utils/dist/logger/index.js';
16
16
  import { RLN_ABI } from './abi.js';
17
17
  import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
18
- import { RLNContractError, InvalidMembershipError, MembershipNotFoundError, MembershipExistsError, RateLimitExceededError, InvalidRateLimitError, TransactionError } from './errors.js';
19
18
  import { MembershipState } from './types.js';
20
- import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
21
- import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
19
+ import { Contract } from '@ethersproject/contracts';
20
+ import { BigNumber } from '@ethersproject/bignumber';
22
21
 
23
22
  const log = new Logger("waku:rln:contract:base");
24
23
  class RLNBaseContract {
25
24
  contract;
25
+ deployBlock;
26
26
  rateLimit;
27
+ _members = new Map();
28
+ _membersFilter;
29
+ _membershipErasedFilter;
30
+ _membersExpiredFilter;
31
+ /**
32
+ * Constructor for RLNBaseContract.
33
+ * Allows injecting a mocked contract for testing purposes.
34
+ */
27
35
  constructor(options) {
28
36
  const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
29
- this.validateRateLimit(rateLimit);
37
+ log.info("Initializing RLNBaseContract", { address, rateLimit });
30
38
  this.contract = contract || new Contract(address, RLN_ABI, signer);
31
39
  this.rateLimit = rateLimit;
40
+ try {
41
+ log.info("Setting up event filters");
42
+ // Initialize event filters
43
+ this._membersFilter = this.contract.filters.MembershipRegistered();
44
+ this._membershipErasedFilter = this.contract.filters.MembershipErased();
45
+ this._membersExpiredFilter = this.contract.filters.MembershipExpired();
46
+ log.info("Event filters initialized successfully");
47
+ }
48
+ catch (error) {
49
+ log.error("Failed to initialize event filters", { error });
50
+ throw new Error("Failed to initialize event filters: " + error.message);
51
+ }
52
+ // Initialize members and subscriptions
53
+ this.fetchMembers()
54
+ .then(() => {
55
+ this.subscribeToMembers();
56
+ })
57
+ .catch((error) => {
58
+ log.error("Failed to initialize members", { error });
59
+ });
60
+ // Validate rate limit asynchronously
61
+ this.validateRateLimit(rateLimit).catch((error) => {
62
+ log.error("Failed to validate initial rate limit", { error });
63
+ });
32
64
  }
33
65
  /**
34
66
  * Gets the current rate limit for this contract instance
@@ -96,221 +128,297 @@ class RLNBaseContract {
96
128
  * @param newRateLimit The new rate limit to use
97
129
  */
98
130
  async setRateLimit(newRateLimit) {
99
- this.validateRateLimit(newRateLimit);
131
+ await this.validateRateLimit(newRateLimit);
100
132
  this.rateLimit = newRateLimit;
101
133
  }
102
- /**
103
- * Gets all members in the given range
104
- * @param startIndex Start index (inclusive)
105
- * @param endIndex End index (exclusive)
106
- */
107
- async getMembersInRange(startIndex, endIndex) {
108
- try {
109
- // Get all commitments in one call
110
- const idCommitments = await this.contract.getRateCommitmentsInRangeBoundsInclusive(startIndex, endIndex - 1 // -1 because getRateCommitmentsInRangeBoundsInclusive is inclusive
111
- );
112
- // Get membership info for each commitment in a single batch
113
- const membershipPromises = idCommitments.map((idCommitment) => this.contract
114
- .memberships(idCommitment)
115
- .then((info) => ({
116
- idCommitment: idCommitment.toString(),
117
- index: BigNumber.from(info.index)
118
- }))
119
- .catch(() => null) // Skip invalid members
120
- );
121
- // Wait for all promises to resolve
122
- const members = (await Promise.all(membershipPromises)).filter((m) => m !== null);
123
- return members;
134
+ get members() {
135
+ const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
136
+ return sortedMembers;
137
+ }
138
+ async fetchMembers(options = {}) {
139
+ const registeredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
140
+ fromBlock: this.deployBlock,
141
+ ...options,
142
+ membersFilter: this.membersFilter
143
+ });
144
+ const removedMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
145
+ fromBlock: this.deployBlock,
146
+ ...options,
147
+ membersFilter: this.membershipErasedFilter
148
+ });
149
+ const expiredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
150
+ fromBlock: this.deployBlock,
151
+ ...options,
152
+ membersFilter: this.membersExpiredFilter
153
+ });
154
+ const events = [
155
+ ...registeredMemberEvents,
156
+ ...removedMemberEvents,
157
+ ...expiredMemberEvents
158
+ ];
159
+ this.processEvents(events);
160
+ }
161
+ static async queryFilter(contract, options) {
162
+ const FETCH_CHUNK = 5;
163
+ const BLOCK_RANGE = 3000;
164
+ const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
165
+ if (fromBlock === undefined) {
166
+ return contract.queryFilter(membersFilter);
124
167
  }
125
- catch (error) {
126
- if (error instanceof Error &&
127
- error.message.includes("InvalidPaginationQuery")) {
128
- throw new RLNContractError(`Invalid pagination range: start=${startIndex}, end=${endIndex}`);
168
+ if (!contract.provider) {
169
+ throw Error("No provider found on the contract.");
170
+ }
171
+ const toBlock = await contract.provider.getBlockNumber();
172
+ if (toBlock - fromBlock < fetchRange) {
173
+ return contract.queryFilter(membersFilter, fromBlock, toBlock);
174
+ }
175
+ const events = [];
176
+ const chunks = RLNBaseContract.splitToChunks(fromBlock, toBlock, fetchRange);
177
+ for (const portion of RLNBaseContract.takeN(chunks, fetchChunks)) {
178
+ const promises = portion.map(([left, right]) => RLNBaseContract.ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
179
+ const fetchedEvents = await Promise.all(promises);
180
+ events.push(fetchedEvents.flatMap((v) => v));
181
+ }
182
+ return events.flatMap((v) => v);
183
+ }
184
+ processEvents(events) {
185
+ const toRemoveTable = new Map();
186
+ const toInsertTable = new Map();
187
+ events.forEach((evt) => {
188
+ if (!evt.args) {
189
+ return;
190
+ }
191
+ if (evt.event === "MembershipErased" ||
192
+ evt.event === "MembershipExpired") {
193
+ let index = evt.args.index;
194
+ if (!index) {
195
+ return;
196
+ }
197
+ if (typeof index === "number" || typeof index === "string") {
198
+ index = BigNumber.from(index);
199
+ }
200
+ const toRemoveVal = toRemoveTable.get(evt.blockNumber);
201
+ if (toRemoveVal != undefined) {
202
+ toRemoveVal.push(index.toNumber());
203
+ toRemoveTable.set(evt.blockNumber, toRemoveVal);
204
+ }
205
+ else {
206
+ toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
207
+ }
208
+ }
209
+ else if (evt.event === "MembershipRegistered") {
210
+ let eventsPerBlock = toInsertTable.get(evt.blockNumber);
211
+ if (eventsPerBlock == undefined) {
212
+ eventsPerBlock = [];
213
+ }
214
+ eventsPerBlock.push(evt);
215
+ toInsertTable.set(evt.blockNumber, eventsPerBlock);
129
216
  }
130
- throw error;
217
+ });
218
+ }
219
+ static splitToChunks(from, to, step) {
220
+ const chunks = [];
221
+ let left = from;
222
+ while (left < to) {
223
+ const right = left + step < to ? left + step : to;
224
+ chunks.push([left, right]);
225
+ left = right;
131
226
  }
227
+ return chunks;
132
228
  }
133
- /**
134
- * Gets all current members
135
- */
136
- async getAllMembers() {
137
- const nextIndex = (await this.contract.nextFreeIndex()).toNumber();
138
- return this.getMembersInRange(0, nextIndex);
229
+ static *takeN(array, size) {
230
+ let start = 0;
231
+ while (start < array.length) {
232
+ const portion = array.slice(start, start + size);
233
+ yield portion;
234
+ start += size;
235
+ }
139
236
  }
140
- /**
141
- * Gets the member index if it exists, or null if it doesn't
142
- * Throws only on actual errors (invalid input, network issues, etc)
143
- */
144
- async getMemberIndex(idCommitment) {
237
+ static async ignoreErrors(promise, defaultValue) {
145
238
  try {
146
- const isValid = await this.contract.isInMembershipSet(idCommitment);
147
- if (!isValid) {
148
- return null;
149
- }
150
- const membershipInfo = await this.contract.memberships(idCommitment);
151
- return BigNumber.from(membershipInfo.index);
239
+ return await promise;
152
240
  }
153
- catch (error) {
154
- log.error(`Error getting member index: ${error.message}`);
155
- throw new InvalidMembershipError(idCommitment);
241
+ catch (err) {
242
+ if (err instanceof Error) {
243
+ log.info(`Ignoring an error during query: ${err.message}`);
244
+ }
245
+ else {
246
+ log.info(`Ignoring an unknown error during query`);
247
+ }
248
+ return defaultValue;
156
249
  }
157
250
  }
158
- async getMembershipInfo(idCommitment) {
251
+ subscribeToMembers() {
252
+ this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
253
+ this.processEvents([event]);
254
+ });
255
+ this.contract.on(this.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
256
+ this.processEvents([event]);
257
+ });
258
+ this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
259
+ this.processEvents([event]);
260
+ });
261
+ }
262
+ async getMembershipInfo(idCommitmentBigInt) {
159
263
  try {
160
- const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
264
+ const membershipData = await this.contract.memberships(idCommitmentBigInt);
161
265
  const currentBlock = await this.contract.provider.getBlockNumber();
266
+ const [depositAmount, activeDuration, gracePeriodStartTimestamp, gracePeriodDuration, rateLimit, index, holder, token] = membershipData;
267
+ const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
162
268
  let state;
163
- if (currentBlock < startBlock) {
269
+ if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
164
270
  state = MembershipState.Active;
165
271
  }
166
- else if (currentBlock < endBlock) {
272
+ else if (currentBlock < gracePeriodEnd.toNumber()) {
167
273
  state = MembershipState.GracePeriod;
168
274
  }
169
275
  else {
170
276
  state = MembershipState.Expired;
171
277
  }
172
- const index = await this.getMemberIndex(idCommitment);
173
- if (index === null) {
174
- throw new MembershipNotFoundError(idCommitment);
175
- }
176
278
  return {
177
279
  index,
178
- idCommitment,
179
- rateLimit: rateLimit.toNumber(),
180
- startBlock: startBlock.toNumber(),
181
- endBlock: endBlock.toNumber(),
182
- state
280
+ idCommitment: idCommitmentBigInt.toString(),
281
+ rateLimit: Number(rateLimit),
282
+ startBlock: gracePeriodStartTimestamp.toNumber(),
283
+ endBlock: gracePeriodEnd.toNumber(),
284
+ state,
285
+ depositAmount,
286
+ activeDuration,
287
+ gracePeriodDuration,
288
+ holder,
289
+ token
183
290
  };
184
291
  }
185
292
  catch (error) {
186
- if (error instanceof RLNContractError) {
187
- throw error;
188
- }
189
- log.error(`Error getting membership info: ${error.message}`);
190
- throw new InvalidMembershipError(idCommitment);
293
+ log.error("Error in getMembershipInfo:", error);
294
+ return undefined;
191
295
  }
192
296
  }
193
- async extendMembership(idCommitment) {
194
- const tx = await this.contract.extendMemberships([idCommitment]);
195
- await this.confirmTransaction(tx, "MembershipExtended", (event) => ({
196
- idCommitment: event.args.idCommitment,
197
- endBlock: event.args.endBlock
198
- }));
297
+ async extendMembership(idCommitmentBigInt) {
298
+ const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
299
+ await tx.wait();
300
+ return tx;
199
301
  }
200
- async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
201
- const tx = await this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
202
- await this.confirmTransaction(tx, "MembershipErased", (event) => ({
203
- idCommitment: event.args.idCommitment,
204
- index: event.args.index
205
- }));
302
+ async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
303
+ const tx = await this.contract.functions.eraseMemberships([idCommitmentBigInt], eraseFromMembershipSet);
304
+ await tx.wait();
305
+ return tx;
206
306
  }
207
- async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
307
+ async registerMembership(idCommitmentBigInt, rateLimit = DEFAULT_RATE_LIMIT) {
208
308
  if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
209
309
  rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
210
310
  throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
211
311
  }
212
- const tx = await this.contract.register(idCommitment, rateLimit, []);
213
- await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
214
- idCommitment: event.args.idCommitment,
215
- membershipRateLimit: event.args.membershipRateLimit,
216
- index: event.args.index
217
- }));
312
+ return this.contract.register(idCommitmentBigInt, rateLimit, []);
218
313
  }
219
- async withdraw(token, holder) {
314
+ async withdraw(token, from) {
220
315
  try {
221
- const tx = await this.contract.withdraw(token, { from: holder });
222
- await this.confirmTransaction(tx, "TokenWithdrawn", (event) => ({
223
- token: event.args.token,
224
- holder: event.args.holder,
225
- amount: event.args.amount
226
- }));
316
+ const tx = await this.contract.withdraw(token, from);
317
+ await tx.wait();
227
318
  }
228
319
  catch (error) {
229
320
  log.error(`Error in withdraw: ${error.message}`);
230
- throw error;
231
321
  }
232
322
  }
233
323
  async registerWithIdentity(identity) {
234
324
  try {
235
325
  log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
236
326
  // Check if the ID commitment is already registered
237
- const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
238
- if (existingIndex !== null) {
239
- throw new MembershipExistsError(identity.IDCommitmentBigInt.toString(), existingIndex.toString());
327
+ const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
328
+ if (existingIndex) {
329
+ throw new Error(`ID commitment is already registered with index ${existingIndex}`);
240
330
  }
241
331
  // Check if there's enough remaining rate limit
242
332
  const remainingRateLimit = await this.getRemainingTotalRateLimit();
243
333
  if (remainingRateLimit < this.rateLimit) {
244
- throw new RateLimitExceededError(this.rateLimit, remainingRateLimit);
334
+ throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
245
335
  }
246
336
  const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
247
337
  const gasLimit = estimatedGas.add(10000);
248
- const tx = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
249
- const decodedData = await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
250
- idCommitment: event.args.idCommitment,
251
- membershipRateLimit: event.args.membershipRateLimit,
252
- index: event.args.index
253
- }));
338
+ const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
339
+ const txRegisterReceipt = await txRegisterResponse.wait();
340
+ if (txRegisterReceipt.status === 0) {
341
+ throw new Error("Transaction failed on-chain");
342
+ }
343
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
344
+ if (!memberRegistered || !memberRegistered.args) {
345
+ log.error("Failed to register membership: No MembershipRegistered event found");
346
+ return undefined;
347
+ }
348
+ const decodedData = {
349
+ idCommitment: memberRegistered.args.idCommitment,
350
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
351
+ index: memberRegistered.args.index
352
+ };
254
353
  log.info(`Successfully registered membership with index ${decodedData.index} ` +
255
354
  `and rate limit ${decodedData.membershipRateLimit}`);
256
355
  const network = await this.contract.provider.getNetwork();
257
356
  const address = this.contract.address;
258
- const membershipId = decodedData.index.toString();
357
+ const membershipId = Number(decodedData.index);
259
358
  return {
260
359
  identity,
261
360
  membership: {
262
361
  address,
263
- treeIndex: parseInt(membershipId),
362
+ treeIndex: membershipId,
264
363
  chainId: network.chainId.toString(),
265
364
  rateLimit: decodedData.membershipRateLimit.toNumber()
266
365
  }
267
366
  };
268
367
  }
269
368
  catch (error) {
270
- if (error instanceof RLNContractError) {
271
- throw error;
272
- }
273
369
  if (error instanceof Error) {
274
370
  const errorMessage = error.message;
275
371
  log.error("registerWithIdentity - error message:", errorMessage);
276
372
  log.error("registerWithIdentity - error stack:", error.stack);
277
- // Map contract errors to our custom errors
373
+ // Try to extract more specific error information
278
374
  if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
279
- throw new RateLimitExceededError(this.rateLimit, await this.getRemainingTotalRateLimit());
375
+ throw new Error("Registration failed: Cannot exceed maximum total rate limit");
280
376
  }
281
377
  else if (errorMessage.includes("InvalidIdCommitment")) {
282
- throw new InvalidMembershipError(identity.IDCommitmentBigInt.toString());
378
+ throw new Error("Registration failed: Invalid ID commitment");
283
379
  }
284
380
  else if (errorMessage.includes("InvalidMembershipRateLimit")) {
285
- throw new InvalidRateLimitError(this.rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, RATE_LIMIT_PARAMS.MAX_RATE);
381
+ throw new Error("Registration failed: Invalid membership rate limit");
286
382
  }
287
383
  else if (errorMessage.includes("execution reverted")) {
288
- throw new TransactionError("Contract execution reverted. Check contract requirements.");
384
+ throw new Error("Contract execution reverted. Check contract requirements.");
385
+ }
386
+ else {
387
+ throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
289
388
  }
290
- throw new RLNContractError(`Error in registerWithIdentity: ${errorMessage}`);
291
389
  }
292
- throw new RLNContractError("Unknown error in registerWithIdentity");
390
+ else {
391
+ throw new Error("Unknown error in registerWithIdentity", {
392
+ cause: error
393
+ });
394
+ }
293
395
  }
294
396
  }
295
397
  async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
296
398
  try {
297
399
  log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
298
- const tx = await this.contract.registerWithPermit(permit.owner, permit.deadline, permit.v, permit.r, permit.s, identity.IDCommitmentBigInt, this.rateLimit, idCommitmentsToErase.map((id) => BigNumber.from(id)));
299
- const decodedData = await this.confirmTransaction(tx, "MembershipRegistered", (event) => ({
300
- idCommitment: event.args.idCommitment,
301
- membershipRateLimit: event.args.membershipRateLimit,
302
- index: event.args.index
303
- }));
400
+ 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)));
401
+ const txRegisterReceipt = await txRegisterResponse.wait();
402
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
403
+ if (!memberRegistered || !memberRegistered.args) {
404
+ log.error("Failed to register membership with permit: No MembershipRegistered event found");
405
+ return undefined;
406
+ }
407
+ const decodedData = {
408
+ idCommitment: memberRegistered.args.idCommitment,
409
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
410
+ index: memberRegistered.args.index
411
+ };
304
412
  log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
305
413
  `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
306
414
  const network = await this.contract.provider.getNetwork();
307
415
  const address = this.contract.address;
308
- const membershipId = decodedData.index.toString();
416
+ const membershipId = Number(decodedData.index);
309
417
  return {
310
418
  identity,
311
419
  membership: {
312
420
  address,
313
- treeIndex: parseInt(membershipId),
421
+ treeIndex: membershipId,
314
422
  chainId: network.chainId.toString(),
315
423
  rateLimit: decodedData.membershipRateLimit.toNumber()
316
424
  }
@@ -318,29 +426,54 @@ class RLNBaseContract {
318
426
  }
319
427
  catch (error) {
320
428
  log.error(`Error in registerWithPermitAndErase: ${error.message}`);
321
- throw error;
429
+ return undefined;
322
430
  }
323
431
  }
324
432
  /**
325
433
  * Validates that the rate limit is within the allowed range
326
434
  * @throws Error if the rate limit is outside the allowed range
327
435
  */
328
- validateRateLimit(rateLimit) {
329
- if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
330
- rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
331
- throw new InvalidRateLimitError(rateLimit, RATE_LIMIT_PARAMS.MIN_RATE, RATE_LIMIT_PARAMS.MAX_RATE);
436
+ async validateRateLimit(rateLimit) {
437
+ const [minRate, maxRate] = await Promise.all([
438
+ this.contract.minMembershipRateLimit(),
439
+ this.contract.maxMembershipRateLimit()
440
+ ]);
441
+ const minRateNum = BigNumber.from(minRate).toNumber();
442
+ const maxRateNum = BigNumber.from(maxRate).toNumber();
443
+ if (rateLimit < minRateNum || rateLimit > maxRateNum) {
444
+ throw new Error(`Rate limit must be between ${minRateNum} and ${maxRateNum} messages per epoch`);
332
445
  }
333
446
  }
334
- /**
335
- * Helper to confirm a transaction and extract event data
336
- */
337
- async confirmTransaction(tx, expectedEvent, transform) {
338
- const receipt = await tx.wait();
339
- const event = receipt.events?.find((e) => e.event === expectedEvent);
340
- if (!event || !event.args) {
341
- throw new TransactionError(`Expected event ${expectedEvent} not found`);
447
+ get membersFilter() {
448
+ if (!this._membersFilter) {
449
+ throw Error("Members filter was not initialized.");
450
+ }
451
+ return this._membersFilter;
452
+ }
453
+ get membershipErasedFilter() {
454
+ if (!this._membershipErasedFilter) {
455
+ throw Error("MembershipErased filter was not initialized.");
456
+ }
457
+ return this._membershipErasedFilter;
458
+ }
459
+ get membersExpiredFilter() {
460
+ if (!this._membersExpiredFilter) {
461
+ throw Error("MembersExpired filter was not initialized.");
462
+ }
463
+ return this._membersExpiredFilter;
464
+ }
465
+ async getMemberIndex(idCommitmentBigInt) {
466
+ try {
467
+ const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitmentBigInt));
468
+ if (events.length === 0)
469
+ return undefined;
470
+ // Get the most recent registration event
471
+ const event = events[events.length - 1];
472
+ return event.args?.index;
473
+ }
474
+ catch (error) {
475
+ return undefined;
342
476
  }
343
- return transform(event);
344
477
  }
345
478
  }
346
479