@waku/rln 0.1.5-5e19700.0 → 0.1.5-ea6daae.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 (125) hide show
  1. package/README.md +0 -5
  2. package/bundle/_virtual/index2.js +1 -1
  3. package/bundle/_virtual/utils.js +2 -2
  4. package/bundle/_virtual/utils2.js +2 -2
  5. package/bundle/index.js +1 -3
  6. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/checksum.js +3 -3
  7. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/cipher.js +4 -4
  8. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/class.js +7 -7
  9. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/functional.js +7 -7
  10. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/index.js +6 -6
  11. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/kdf.js +5 -5
  12. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/password.js +1 -1
  13. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/schema-validation-generated.js +1 -1
  14. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/schema-validation.js +2 -2
  15. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/lib/types.js +1 -1
  16. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/_assert.js +1 -1
  17. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/_sha2.js +3 -3
  18. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/_u64.js +1 -1
  19. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/cryptoBrowser.js +1 -1
  20. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/hmac.js +3 -3
  21. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/pbkdf2.js +4 -4
  22. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/scrypt.js +5 -5
  23. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/sha256.js +3 -3
  24. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/sha512.js +4 -4
  25. package/bundle/{packages/rln → node_modules/@chainsafe/bls-keystore}/node_modules/@noble/hashes/utils.js +2 -2
  26. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/aes.js +3 -3
  27. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/pbkdf2.js +7 -7
  28. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +3 -3
  29. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/scrypt.js +3 -3
  30. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/sha256.js +3 -3
  31. package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +7 -7
  32. package/bundle/node_modules/@ethersproject/abi/lib.esm/_version.js +1 -1
  33. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/_version.js +1 -1
  34. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/_version.js +1 -1
  35. package/bundle/node_modules/@ethersproject/address/lib.esm/_version.js +1 -1
  36. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/_version.js +1 -1
  37. package/bundle/node_modules/@ethersproject/contracts/lib.esm/_version.js +1 -1
  38. package/bundle/node_modules/@ethersproject/contracts/lib.esm/index.js +1 -1
  39. package/bundle/node_modules/@ethersproject/hash/lib.esm/_version.js +1 -1
  40. package/bundle/node_modules/@ethersproject/keccak256/lib.esm/index.js +1 -1
  41. package/bundle/node_modules/@ethersproject/networks/lib.esm/_version.js +1 -1
  42. package/bundle/node_modules/@ethersproject/networks/lib.esm/index.js +19 -1
  43. package/bundle/node_modules/@ethersproject/properties/lib.esm/_version.js +1 -1
  44. package/bundle/node_modules/@ethersproject/providers/lib.esm/_version.js +1 -1
  45. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/_version.js +1 -1
  46. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/elliptic.js +58 -10
  47. package/bundle/node_modules/@ethersproject/strings/lib.esm/_version.js +1 -1
  48. package/bundle/node_modules/@ethersproject/transactions/lib.esm/_version.js +1 -1
  49. package/bundle/node_modules/@ethersproject/web/lib.esm/_version.js +1 -1
  50. package/bundle/node_modules/{@ethersproject/keccak256/node_modules/js-sha3 → js-sha3}/src/sha3.js +2 -2
  51. package/bundle/packages/rln/dist/contract/abi.js +248 -502
  52. package/bundle/packages/rln/dist/contract/constants.js +4 -4
  53. package/bundle/packages/rln/dist/contract/rln_contract.js +36 -120
  54. package/bundle/packages/rln/dist/keystore/cipher.js +3 -3
  55. package/bundle/packages/rln/dist/keystore/keystore.js +2 -3
  56. package/bundle/packages/rln/dist/rln.js +6 -6
  57. package/dist/.tsbuildinfo +1 -1
  58. package/dist/contract/abi.d.ts +17 -21
  59. package/dist/contract/abi.js +248 -502
  60. package/dist/contract/abi.js.map +1 -1
  61. package/dist/contract/constants.d.ts +18 -22
  62. package/dist/contract/constants.js +3 -3
  63. package/dist/contract/constants.js.map +1 -1
  64. package/dist/contract/rln_contract.d.ts +3 -10
  65. package/dist/contract/rln_contract.js +36 -120
  66. package/dist/contract/rln_contract.js.map +1 -1
  67. package/dist/index.d.ts +2 -5
  68. package/dist/index.js +2 -4
  69. package/dist/index.js.map +1 -1
  70. package/dist/keystore/keystore.js +1 -2
  71. package/dist/keystore/keystore.js.map +1 -1
  72. package/dist/keystore/types.d.ts +0 -1
  73. package/dist/rln.d.ts +1 -1
  74. package/dist/rln.js +6 -6
  75. package/dist/rln.js.map +1 -1
  76. package/package.json +1 -1
  77. package/src/contract/abi.ts +248 -502
  78. package/src/contract/constants.ts +3 -3
  79. package/src/contract/rln_contract.ts +46 -158
  80. package/src/index.ts +2 -17
  81. package/src/keystore/keystore.ts +1 -2
  82. package/src/keystore/types.ts +0 -1
  83. package/src/rln.ts +7 -7
  84. package/bundle/packages/rln/dist/contract/rln_light_contract.js +0 -473
  85. package/bundle/packages/rln/dist/rln_light.js +0 -149
  86. package/bundle/packages/rln/node_modules/@noble/hashes/esm/_assert.js +0 -43
  87. package/bundle/packages/rln/node_modules/@noble/hashes/esm/_sha2.js +0 -116
  88. package/bundle/packages/rln/node_modules/@noble/hashes/esm/hmac.js +0 -79
  89. package/bundle/packages/rln/node_modules/@noble/hashes/esm/sha256.js +0 -126
  90. package/bundle/packages/rln/node_modules/@noble/hashes/esm/utils.js +0 -43
  91. package/dist/codec.test-utils.d.ts +0 -36
  92. package/dist/codec.test-utils.js +0 -56
  93. package/dist/codec.test-utils.js.map +0 -1
  94. package/dist/contract/rln_light_contract.d.ts +0 -124
  95. package/dist/contract/rln_light_contract.js +0 -456
  96. package/dist/contract/rln_light_contract.js.map +0 -1
  97. package/dist/contract/test-setup.d.ts +0 -26
  98. package/dist/contract/test-setup.js +0 -56
  99. package/dist/contract/test-setup.js.map +0 -1
  100. package/dist/contract/test-utils.d.ts +0 -39
  101. package/dist/contract/test-utils.js +0 -118
  102. package/dist/contract/test-utils.js.map +0 -1
  103. package/dist/rln_light.d.ts +0 -64
  104. package/dist/rln_light.js +0 -144
  105. package/dist/rln_light.js.map +0 -1
  106. package/src/codec.test-utils.ts +0 -80
  107. package/src/contract/rln_light_contract.ts +0 -718
  108. package/src/contract/test-setup.ts +0 -86
  109. package/src/contract/test-utils.ts +0 -179
  110. package/src/rln_light.ts +0 -235
  111. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/index.js +0 -0
  112. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/md5.js +0 -0
  113. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/nil.js +0 -0
  114. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/parse.js +0 -0
  115. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/regex.js +0 -0
  116. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/rng.js +0 -0
  117. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/sha1.js +0 -0
  118. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/stringify.js +0 -0
  119. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v1.js +0 -0
  120. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v3.js +0 -0
  121. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v35.js +0 -0
  122. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v4.js +0 -0
  123. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v5.js +0 -0
  124. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/validate.js +0 -0
  125. /package/bundle/{packages/rln/node_modules → node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/version.js +0 -0
@@ -1,473 +0,0 @@
1
- import '../../../interfaces/dist/protocols.js';
2
- import '../../../interfaces/dist/connection_manager.js';
3
- import '../../../interfaces/dist/health_indicator.js';
4
- import '../../../../node_modules/multiformats/dist/src/bases/base10.js';
5
- import '../../../../node_modules/multiformats/dist/src/bases/base16.js';
6
- import '../../../../node_modules/multiformats/dist/src/bases/base2.js';
7
- import '../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
8
- import '../../../../node_modules/multiformats/dist/src/bases/base32.js';
9
- import '../../../../node_modules/multiformats/dist/src/bases/base36.js';
10
- import '../../../../node_modules/multiformats/dist/src/bases/base58.js';
11
- import '../../../../node_modules/multiformats/dist/src/bases/base64.js';
12
- import '../../../../node_modules/multiformats/dist/src/bases/base8.js';
13
- import '../../../../node_modules/multiformats/dist/src/bases/identity.js';
14
- import '../../../../node_modules/multiformats/dist/src/codecs/json.js';
15
- import { Logger } from '../../../utils/dist/logger/index.js';
16
- import { RLN_ABI } from './abi.js';
17
- import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
18
- import { Contract } from '../../../../node_modules/@ethersproject/contracts/lib.esm/index.js';
19
- import { BigNumber } from '../../../../node_modules/@ethersproject/bignumber/lib.esm/bignumber.js';
20
-
21
- const log = new Logger("waku:rln:contract");
22
- var MembershipState;
23
- (function (MembershipState) {
24
- MembershipState["Active"] = "Active";
25
- MembershipState["GracePeriod"] = "GracePeriod";
26
- MembershipState["Expired"] = "Expired";
27
- MembershipState["ErasedAwaitsWithdrawal"] = "ErasedAwaitsWithdrawal";
28
- })(MembershipState || (MembershipState = {}));
29
- class RLNLightContract {
30
- contract;
31
- deployBlock;
32
- rateLimit;
33
- _members = new Map();
34
- _membersFilter;
35
- _membershipErasedFilter;
36
- _membersExpiredFilter;
37
- /**
38
- * Asynchronous initializer for RLNContract.
39
- * Allows injecting a mocked contract for testing purposes.
40
- */
41
- static async init(options) {
42
- const rlnContract = new RLNLightContract(options);
43
- await rlnContract.fetchMembers();
44
- rlnContract.subscribeToMembers();
45
- return rlnContract;
46
- }
47
- constructor(options) {
48
- const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
49
- if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
50
- rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
51
- throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE} messages per epoch`);
52
- }
53
- this.rateLimit = rateLimit;
54
- // Use the injected contract if provided; otherwise, instantiate a new one.
55
- this.contract = contract || new Contract(address, RLN_ABI, signer);
56
- // Initialize event filters
57
- this._membersFilter = this.contract.filters.MembershipRegistered();
58
- this._membershipErasedFilter = this.contract.filters.MembershipErased();
59
- this._membersExpiredFilter = this.contract.filters.MembershipExpired();
60
- }
61
- /**
62
- * Gets the current rate limit for this contract instance
63
- */
64
- getRateLimit() {
65
- return this.rateLimit;
66
- }
67
- /**
68
- * Gets the contract address
69
- */
70
- get address() {
71
- return this.contract.address;
72
- }
73
- /**
74
- * Gets the contract provider
75
- */
76
- get provider() {
77
- return this.contract.provider;
78
- }
79
- /**
80
- * Gets the minimum allowed rate limit from the contract
81
- * @returns Promise<number> The minimum rate limit in messages per epoch
82
- */
83
- async getMinRateLimit() {
84
- const minRate = await this.contract.minMembershipRateLimit();
85
- return minRate.toNumber();
86
- }
87
- /**
88
- * Gets the maximum allowed rate limit from the contract
89
- * @returns Promise<number> The maximum rate limit in messages per epoch
90
- */
91
- async getMaxRateLimit() {
92
- const maxRate = await this.contract.maxMembershipRateLimit();
93
- return maxRate.toNumber();
94
- }
95
- /**
96
- * Gets the maximum total rate limit across all memberships
97
- * @returns Promise<number> The maximum total rate limit in messages per epoch
98
- */
99
- async getMaxTotalRateLimit() {
100
- const maxTotalRate = await this.contract.maxTotalRateLimit();
101
- return maxTotalRate.toNumber();
102
- }
103
- /**
104
- * Gets the current total rate limit usage across all memberships
105
- * @returns Promise<number> The current total rate limit usage in messages per epoch
106
- */
107
- async getCurrentTotalRateLimit() {
108
- const currentTotal = await this.contract.currentTotalRateLimit();
109
- return currentTotal.toNumber();
110
- }
111
- /**
112
- * Gets the remaining available total rate limit that can be allocated
113
- * @returns Promise<number> The remaining rate limit that can be allocated
114
- */
115
- async getRemainingTotalRateLimit() {
116
- const [maxTotal, currentTotal] = await Promise.all([
117
- this.contract.maxTotalRateLimit(),
118
- this.contract.currentTotalRateLimit()
119
- ]);
120
- return Number(maxTotal) - Number(currentTotal);
121
- }
122
- /**
123
- * Updates the rate limit for future registrations
124
- * @param newRateLimit The new rate limit to use
125
- */
126
- async setRateLimit(newRateLimit) {
127
- this.rateLimit = newRateLimit;
128
- }
129
- get members() {
130
- const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
131
- return sortedMembers;
132
- }
133
- get membersFilter() {
134
- if (!this._membersFilter) {
135
- throw Error("Members filter was not initialized.");
136
- }
137
- return this._membersFilter;
138
- }
139
- get membershipErasedFilter() {
140
- if (!this._membershipErasedFilter) {
141
- throw Error("MembershipErased filter was not initialized.");
142
- }
143
- return this._membershipErasedFilter;
144
- }
145
- get membersExpiredFilter() {
146
- if (!this._membersExpiredFilter) {
147
- throw Error("MembersExpired filter was not initialized.");
148
- }
149
- return this._membersExpiredFilter;
150
- }
151
- async fetchMembers(options = {}) {
152
- const registeredMemberEvents = await queryFilter(this.contract, {
153
- fromBlock: this.deployBlock,
154
- ...options,
155
- membersFilter: this.membersFilter
156
- });
157
- const removedMemberEvents = await queryFilter(this.contract, {
158
- fromBlock: this.deployBlock,
159
- ...options,
160
- membersFilter: this.membershipErasedFilter
161
- });
162
- const expiredMemberEvents = await queryFilter(this.contract, {
163
- fromBlock: this.deployBlock,
164
- ...options,
165
- membersFilter: this.membersExpiredFilter
166
- });
167
- const events = [
168
- ...registeredMemberEvents,
169
- ...removedMemberEvents,
170
- ...expiredMemberEvents
171
- ];
172
- this.processEvents(events);
173
- }
174
- processEvents(events) {
175
- const toRemoveTable = new Map();
176
- const toInsertTable = new Map();
177
- events.forEach((evt) => {
178
- if (!evt.args) {
179
- return;
180
- }
181
- if (evt.event === "MembershipErased" ||
182
- evt.event === "MembershipExpired") {
183
- let index = evt.args.index;
184
- if (!index) {
185
- return;
186
- }
187
- if (typeof index === "number" || typeof index === "string") {
188
- index = BigNumber.from(index);
189
- }
190
- const toRemoveVal = toRemoveTable.get(evt.blockNumber);
191
- if (toRemoveVal != undefined) {
192
- toRemoveVal.push(index.toNumber());
193
- toRemoveTable.set(evt.blockNumber, toRemoveVal);
194
- }
195
- else {
196
- toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
197
- }
198
- }
199
- else if (evt.event === "MembershipRegistered") {
200
- let eventsPerBlock = toInsertTable.get(evt.blockNumber);
201
- if (eventsPerBlock == undefined) {
202
- eventsPerBlock = [];
203
- }
204
- eventsPerBlock.push(evt);
205
- toInsertTable.set(evt.blockNumber, eventsPerBlock);
206
- }
207
- });
208
- }
209
- subscribeToMembers() {
210
- this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
211
- this.processEvents([event]);
212
- });
213
- this.contract.on(this.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
214
- this.processEvents([event]);
215
- });
216
- this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
217
- this.processEvents([event]);
218
- });
219
- }
220
- async registerWithIdentity(identity) {
221
- try {
222
- log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
223
- // Check if the ID commitment is already registered
224
- const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
225
- if (existingIndex) {
226
- throw new Error(`ID commitment is already registered with index ${existingIndex}`);
227
- }
228
- // Check if there's enough remaining rate limit
229
- const remainingRateLimit = await this.getRemainingTotalRateLimit();
230
- if (remainingRateLimit < this.rateLimit) {
231
- throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
232
- }
233
- const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
234
- const gasLimit = estimatedGas.add(10000);
235
- const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
236
- const txRegisterReceipt = await txRegisterResponse.wait();
237
- if (txRegisterReceipt.status === 0) {
238
- throw new Error("Transaction failed on-chain");
239
- }
240
- const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
241
- if (!memberRegistered || !memberRegistered.args) {
242
- log.error("Failed to register membership: No MembershipRegistered event found");
243
- return undefined;
244
- }
245
- const decodedData = {
246
- idCommitment: memberRegistered.args.idCommitment,
247
- membershipRateLimit: memberRegistered.args.membershipRateLimit,
248
- index: memberRegistered.args.index
249
- };
250
- log.info(`Successfully registered membership with index ${decodedData.index} ` +
251
- `and rate limit ${decodedData.membershipRateLimit}`);
252
- const network = await this.contract.provider.getNetwork();
253
- const address = this.contract.address;
254
- const membershipId = Number(decodedData.index);
255
- return {
256
- identity,
257
- membership: {
258
- address,
259
- treeIndex: membershipId,
260
- chainId: network.chainId,
261
- rateLimit: decodedData.membershipRateLimit.toNumber()
262
- }
263
- };
264
- }
265
- catch (error) {
266
- if (error instanceof Error) {
267
- const errorMessage = error.message;
268
- log.error("registerWithIdentity - error message:", errorMessage);
269
- log.error("registerWithIdentity - error stack:", error.stack);
270
- // Try to extract more specific error information
271
- if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
272
- throw new Error("Registration failed: Cannot exceed maximum total rate limit");
273
- }
274
- else if (errorMessage.includes("InvalidIdCommitment")) {
275
- throw new Error("Registration failed: Invalid ID commitment");
276
- }
277
- else if (errorMessage.includes("InvalidMembershipRateLimit")) {
278
- throw new Error("Registration failed: Invalid membership rate limit");
279
- }
280
- else if (errorMessage.includes("execution reverted")) {
281
- throw new Error("Contract execution reverted. Check contract requirements.");
282
- }
283
- else {
284
- throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
285
- }
286
- }
287
- else {
288
- throw new Error("Unknown error in registerWithIdentity", {
289
- cause: error
290
- });
291
- }
292
- }
293
- }
294
- /**
295
- * Helper method to get remaining messages in current epoch
296
- * @param membershipId The ID of the membership to check
297
- * @returns number of remaining messages allowed in current epoch
298
- */
299
- async getRemainingMessages(membershipId) {
300
- try {
301
- const [startTime, , rateLimit] = await this.contract.getMembershipInfo(membershipId);
302
- // Calculate current epoch
303
- const currentTime = Math.floor(Date.now() / 1000);
304
- const epochsPassed = Math.floor((currentTime - startTime) / RATE_LIMIT_PARAMS.EPOCH_LENGTH);
305
- const currentEpochStart = startTime + epochsPassed * RATE_LIMIT_PARAMS.EPOCH_LENGTH;
306
- // Get message count in current epoch using contract's function
307
- const messageCount = await this.contract.getMessageCount(membershipId, currentEpochStart);
308
- return Math.max(0, rateLimit.sub(messageCount).toNumber());
309
- }
310
- catch (error) {
311
- log.error(`Error getting remaining messages: ${error.message}`);
312
- return 0; // Fail safe: assume no messages remaining on error
313
- }
314
- }
315
- async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
316
- try {
317
- log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
318
- 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)));
319
- const txRegisterReceipt = await txRegisterResponse.wait();
320
- const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
321
- if (!memberRegistered || !memberRegistered.args) {
322
- log.error("Failed to register membership with permit: No MembershipRegistered event found");
323
- return undefined;
324
- }
325
- const decodedData = {
326
- idCommitment: memberRegistered.args.idCommitment,
327
- membershipRateLimit: memberRegistered.args.membershipRateLimit,
328
- index: memberRegistered.args.index
329
- };
330
- log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
331
- `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
332
- const network = await this.contract.provider.getNetwork();
333
- const address = this.contract.address;
334
- const membershipId = Number(decodedData.index);
335
- return {
336
- identity,
337
- membership: {
338
- address,
339
- treeIndex: membershipId,
340
- chainId: network.chainId,
341
- rateLimit: decodedData.membershipRateLimit.toNumber()
342
- }
343
- };
344
- }
345
- catch (error) {
346
- log.error(`Error in registerWithPermitAndErase: ${error.message}`);
347
- return undefined;
348
- }
349
- }
350
- async withdraw(token, holder) {
351
- try {
352
- const tx = await this.contract.withdraw(token, { from: holder });
353
- await tx.wait();
354
- }
355
- catch (error) {
356
- log.error(`Error in withdraw: ${error.message}`);
357
- }
358
- }
359
- async getMembershipInfo(idCommitment) {
360
- try {
361
- const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
362
- const currentBlock = await this.contract.provider.getBlockNumber();
363
- let state;
364
- if (currentBlock < startBlock) {
365
- state = MembershipState.Active;
366
- }
367
- else if (currentBlock < endBlock) {
368
- state = MembershipState.GracePeriod;
369
- }
370
- else {
371
- state = MembershipState.Expired;
372
- }
373
- const index = await this.getMemberIndex(idCommitment);
374
- if (!index)
375
- return undefined;
376
- return {
377
- index,
378
- idCommitment,
379
- rateLimit: rateLimit.toNumber(),
380
- startBlock: startBlock.toNumber(),
381
- endBlock: endBlock.toNumber(),
382
- state
383
- };
384
- }
385
- catch (error) {
386
- return undefined;
387
- }
388
- }
389
- async extendMembership(idCommitment) {
390
- return this.contract.extendMemberships([idCommitment]);
391
- }
392
- async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
393
- return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
394
- }
395
- async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
396
- if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
397
- rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
398
- throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
399
- }
400
- return this.contract.register(idCommitment, rateLimit, []);
401
- }
402
- async getMemberIndex(idCommitment) {
403
- try {
404
- const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitment));
405
- if (events.length === 0)
406
- return undefined;
407
- // Get the most recent registration event
408
- const event = events[events.length - 1];
409
- return event.args?.index;
410
- }
411
- catch (error) {
412
- return undefined;
413
- }
414
- }
415
- }
416
- // These values should be tested on other networks
417
- const FETCH_CHUNK = 5;
418
- const BLOCK_RANGE = 3000;
419
- async function queryFilter(contract, options) {
420
- const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
421
- if (fromBlock === undefined) {
422
- return contract.queryFilter(membersFilter);
423
- }
424
- if (!contract.provider) {
425
- throw Error("No provider found on the contract.");
426
- }
427
- const toBlock = await contract.provider.getBlockNumber();
428
- if (toBlock - fromBlock < fetchRange) {
429
- return contract.queryFilter(membersFilter, fromBlock, toBlock);
430
- }
431
- const events = [];
432
- const chunks = splitToChunks(fromBlock, toBlock, fetchRange);
433
- for (const portion of takeN(chunks, fetchChunks)) {
434
- const promises = portion.map(([left, right]) => ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
435
- const fetchedEvents = await Promise.all(promises);
436
- events.push(fetchedEvents.flatMap((v) => v));
437
- }
438
- return events.flatMap((v) => v);
439
- }
440
- function splitToChunks(from, to, step) {
441
- const chunks = [];
442
- let left = from;
443
- while (left < to) {
444
- const right = left + step < to ? left + step : to;
445
- chunks.push([left, right]);
446
- left = right;
447
- }
448
- return chunks;
449
- }
450
- function* takeN(array, size) {
451
- let start = 0;
452
- while (start < array.length) {
453
- const portion = array.slice(start, start + size);
454
- yield portion;
455
- start += size;
456
- }
457
- }
458
- async function ignoreErrors(promise, defaultValue) {
459
- try {
460
- return await promise;
461
- }
462
- catch (err) {
463
- if (err instanceof Error) {
464
- log.info(`Ignoring an error during query: ${err.message}`);
465
- }
466
- else {
467
- log.info(`Ignoring an unknown error during query`);
468
- }
469
- return defaultValue;
470
- }
471
- }
472
-
473
- export { MembershipState, RLNLightContract };
@@ -1,149 +0,0 @@
1
- import { hmac } from '../node_modules/@noble/hashes/esm/hmac.js';
2
- import { sha256 } from '../node_modules/@noble/hashes/esm/sha256.js';
3
- import '../../interfaces/dist/protocols.js';
4
- import '../../interfaces/dist/connection_manager.js';
5
- import '../../interfaces/dist/health_indicator.js';
6
- import '../../../node_modules/multiformats/dist/src/bases/base10.js';
7
- import '../../../node_modules/multiformats/dist/src/bases/base16.js';
8
- import '../../../node_modules/multiformats/dist/src/bases/base2.js';
9
- import '../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
10
- import '../../../node_modules/multiformats/dist/src/bases/base32.js';
11
- import '../../../node_modules/multiformats/dist/src/bases/base36.js';
12
- import '../../../node_modules/multiformats/dist/src/bases/base58.js';
13
- import '../../../node_modules/multiformats/dist/src/bases/base64.js';
14
- import '../../../node_modules/multiformats/dist/src/bases/base8.js';
15
- import '../../../node_modules/multiformats/dist/src/bases/identity.js';
16
- import '../../../node_modules/multiformats/dist/src/codecs/json.js';
17
- import { Logger } from '../../utils/dist/logger/index.js';
18
- import { LINEA_CONTRACT } from './contract/constants.js';
19
- import { RLNLightContract } from './contract/rln_light_contract.js';
20
- import { IdentityCredential } from './identity.js';
21
- import { Keystore } from './keystore/keystore.js';
22
- import { extractMetaMaskSigner } from './utils/metamask.js';
23
- import { buildBigIntFromUint8Array } from './utils/bytes.js';
24
- import './utils/epoch.js';
25
-
26
- new Logger("waku:rln");
27
- class RLNLightInstance {
28
- started = false;
29
- starting = false;
30
- _contract;
31
- _signer;
32
- keystore = Keystore.create();
33
- _credentials;
34
- constructor() { }
35
- get contract() {
36
- return this._contract;
37
- }
38
- get signer() {
39
- return this._signer;
40
- }
41
- async start(options = {}) {
42
- if (this.started || this.starting) {
43
- return;
44
- }
45
- this.starting = true;
46
- try {
47
- const { credentials, keystore } = await RLNLightInstance.decryptCredentialsIfNeeded(options.credentials);
48
- const { signer, address, rateLimit } = await this.determineStartOptions(options, credentials);
49
- if (keystore) {
50
- this.keystore = keystore;
51
- }
52
- this._credentials = credentials;
53
- this._signer = signer;
54
- this._contract = await RLNLightContract.init({
55
- address: address,
56
- signer: signer,
57
- rateLimit: rateLimit
58
- });
59
- this.started = true;
60
- }
61
- finally {
62
- this.starting = false;
63
- }
64
- }
65
- get credentials() {
66
- return this._credentials;
67
- }
68
- async determineStartOptions(options, credentials) {
69
- let chainId = credentials?.membership.chainId;
70
- const address = credentials?.membership.address ||
71
- options.address ||
72
- LINEA_CONTRACT.address;
73
- if (address === LINEA_CONTRACT.address) {
74
- chainId = LINEA_CONTRACT.chainId;
75
- }
76
- const signer = options.signer || (await extractMetaMaskSigner());
77
- const currentChainId = await signer.getChainId();
78
- if (chainId && chainId !== currentChainId) {
79
- throw Error(`Failed to start RLN contract, chain ID of contract is different from current one: contract-${chainId}, current network-${currentChainId}`);
80
- }
81
- return {
82
- signer,
83
- address
84
- };
85
- }
86
- static async decryptCredentialsIfNeeded(credentials) {
87
- if (!credentials) {
88
- return {};
89
- }
90
- if ("identity" in credentials) {
91
- return { credentials };
92
- }
93
- const keystore = Keystore.fromString(credentials.keystore);
94
- if (!keystore) {
95
- return {};
96
- }
97
- const decryptedCredentials = await keystore.readCredential(credentials.id, credentials.password);
98
- return {
99
- keystore,
100
- credentials: decryptedCredentials
101
- };
102
- }
103
- /**
104
- * Generates an identity credential from a seed string
105
- * This is a pure implementation that doesn't rely on Zerokit
106
- * @param seed A string seed to generate the identity from
107
- * @returns IdentityCredential
108
- */
109
- generateSeededIdentityCredential(seed) {
110
- // Convert the seed to bytes
111
- const encoder = new TextEncoder();
112
- const seedBytes = encoder.encode(seed);
113
- // Generate deterministic values using HMAC-SHA256
114
- // We use different context strings for each component to ensure they're different
115
- const idTrapdoor = hmac(sha256, seedBytes, encoder.encode("IDTrapdoor"));
116
- const idNullifier = hmac(sha256, seedBytes, encoder.encode("IDNullifier"));
117
- // Generate IDSecretHash as a hash of IDTrapdoor and IDNullifier
118
- const combinedBytes = new Uint8Array([...idTrapdoor, ...idNullifier]);
119
- const idSecretHash = sha256(combinedBytes);
120
- // Generate IDCommitment as a hash of IDSecretHash
121
- const idCommitment = sha256(idSecretHash);
122
- // Convert IDCommitment to BigInt
123
- const idCommitmentBigInt = buildBigIntFromUint8Array(idCommitment);
124
- return new IdentityCredential(idTrapdoor, idNullifier, idSecretHash, idCommitment, idCommitmentBigInt);
125
- }
126
- async registerMembership(options) {
127
- if (!this.contract) {
128
- throw Error("RLN Contract is not initialized.");
129
- }
130
- let identity = "identity" in options && options.identity;
131
- if ("signature" in options) {
132
- identity = this.generateSeededIdentityCredential(options.signature);
133
- }
134
- if (!identity) {
135
- throw Error("Missing signature or identity to register membership.");
136
- }
137
- return this.contract.registerWithIdentity(identity);
138
- }
139
- /**
140
- * Changes credentials in use by relying on provided Keystore earlier in rln.start
141
- * @param id: string, hash of credentials to select from Keystore
142
- * @param password: string or bytes to use to decrypt credentials from Keystore
143
- */
144
- async useCredentials(id, password) {
145
- this._credentials = await this.keystore?.readCredential(id, password);
146
- }
147
- }
148
-
149
- export { RLNLightInstance };
@@ -1,43 +0,0 @@
1
- function number(n) {
2
- if (!Number.isSafeInteger(n) || n < 0)
3
- throw new Error(`Wrong positive integer: ${n}`);
4
- }
5
- function bool(b) {
6
- if (typeof b !== 'boolean')
7
- throw new Error(`Expected boolean, not ${b}`);
8
- }
9
- function bytes(b, ...lengths) {
10
- if (!(b instanceof Uint8Array))
11
- throw new TypeError('Expected Uint8Array');
12
- if (lengths.length > 0 && !lengths.includes(b.length))
13
- throw new TypeError(`Expected Uint8Array of length ${lengths}, not of length=${b.length}`);
14
- }
15
- function hash(hash) {
16
- if (typeof hash !== 'function' || typeof hash.create !== 'function')
17
- throw new Error('Hash should be wrapped by utils.wrapConstructor');
18
- number(hash.outputLen);
19
- number(hash.blockLen);
20
- }
21
- function exists(instance, checkFinished = true) {
22
- if (instance.destroyed)
23
- throw new Error('Hash instance has been destroyed');
24
- if (checkFinished && instance.finished)
25
- throw new Error('Hash#digest() has already been called');
26
- }
27
- function output(out, instance) {
28
- bytes(out);
29
- const min = instance.outputLen;
30
- if (out.length < min) {
31
- throw new Error(`digestInto() expects output buffer of length at least ${min}`);
32
- }
33
- }
34
- const assert = {
35
- number,
36
- bool,
37
- bytes,
38
- hash,
39
- exists,
40
- output,
41
- };
42
-
43
- export { bool, bytes, assert as default, exists, hash, number, output };