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