@waku/rln 0.0.2-09108d9.0 → 0.0.2-2eccb11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/bundle/_virtual/utils.js +2 -2
- package/bundle/_virtual/utils2.js +2 -2
- package/bundle/index.js +2 -1
- package/bundle/packages/rln/dist/contract/abi.js +648 -0
- package/bundle/packages/rln/dist/contract/constants.js +25 -65
- package/bundle/packages/rln/dist/contract/rln_contract.js +335 -74
- package/bundle/packages/rln/dist/message.js +1 -1
- package/bundle/packages/rln/dist/rln.js +42 -20
- package/bundle/packages/rln/dist/zerokit.js +34 -14
- package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +1 -1
- package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +2 -2
- package/bundle/packages/rln/node_modules/@noble/hashes/_sha2.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/hmac.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/pbkdf2.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/scrypt.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/sha256.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/sha512.js +1 -1
- package/bundle/packages/rln/node_modules/@noble/hashes/utils.js +1 -1
- package/dist/.tsbuildinfo +1 -1
- package/dist/contract/abi.d.ts +46 -0
- package/dist/contract/abi.js +647 -0
- package/dist/contract/abi.js.map +1 -0
- package/dist/contract/constants.d.ts +63 -3
- package/dist/contract/constants.js +23 -64
- package/dist/contract/constants.js.map +1 -1
- package/dist/contract/rln_contract.d.ts +100 -17
- package/dist/contract/rln_contract.js +334 -72
- package/dist/contract/rln_contract.js.map +1 -1
- package/dist/index.d.ts +3 -3
- package/dist/index.js +3 -3
- package/dist/index.js.map +1 -1
- package/dist/message.js +1 -1
- package/dist/message.js.map +1 -1
- package/dist/rln.d.ts +5 -1
- package/dist/rln.js +42 -19
- package/dist/rln.js.map +1 -1
- package/dist/zerokit.d.ts +10 -6
- package/dist/zerokit.js +34 -14
- package/dist/zerokit.js.map +1 -1
- package/package.json +1 -1
- package/src/contract/abi.ts +646 -0
- package/src/contract/constants.ts +26 -65
- package/src/contract/rln_contract.ts +500 -108
- package/src/index.ts +4 -9
- package/src/message.ts +1 -1
- package/src/rln.ts +63 -21
- package/src/zerokit.ts +74 -15
@@ -6,9 +6,10 @@ import type { IdentityCredential } from "../identity.js";
|
|
6
6
|
import type { DecryptedCredentials } from "../keystore/index.js";
|
7
7
|
import type { RLNInstance } from "../rln.js";
|
8
8
|
import { MerkleRootTracker } from "../root_tracker.js";
|
9
|
-
import { zeroPadLE } from "../utils/
|
9
|
+
import { zeroPadLE } from "../utils/bytes.js";
|
10
10
|
|
11
|
-
import {
|
11
|
+
import { RLN_ABI } from "./abi.js";
|
12
|
+
import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./constants.js";
|
12
13
|
|
13
14
|
const log = new Logger("waku:rln:contract");
|
14
15
|
|
@@ -17,18 +18,21 @@ type Member = {
|
|
17
18
|
index: ethers.BigNumber;
|
18
19
|
};
|
19
20
|
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
|
25
|
-
};
|
21
|
+
interface RLNContractOptions {
|
22
|
+
signer: ethers.Signer;
|
23
|
+
address: string;
|
24
|
+
rateLimit?: number;
|
25
|
+
}
|
26
26
|
|
27
|
-
|
28
|
-
|
29
|
-
}
|
27
|
+
interface RLNContractInitOptions extends RLNContractOptions {
|
28
|
+
contract?: ethers.Contract;
|
29
|
+
}
|
30
30
|
|
31
|
-
|
31
|
+
export interface MembershipRegisteredEvent {
|
32
|
+
idCommitment: string;
|
33
|
+
membershipRateLimit: ethers.BigNumber;
|
34
|
+
index: ethers.BigNumber;
|
35
|
+
}
|
32
36
|
|
33
37
|
type FetchMembersOptions = {
|
34
38
|
fromBlock?: number;
|
@@ -36,80 +40,159 @@ type FetchMembersOptions = {
|
|
36
40
|
fetchChunks?: number;
|
37
41
|
};
|
38
42
|
|
43
|
+
export interface MembershipInfo {
|
44
|
+
index: ethers.BigNumber;
|
45
|
+
idCommitment: string;
|
46
|
+
rateLimit: number;
|
47
|
+
startBlock: number;
|
48
|
+
endBlock: number;
|
49
|
+
state: MembershipState;
|
50
|
+
}
|
51
|
+
|
52
|
+
export enum MembershipState {
|
53
|
+
Active = "Active",
|
54
|
+
GracePeriod = "GracePeriod",
|
55
|
+
Expired = "Expired",
|
56
|
+
ErasedAwaitsWithdrawal = "ErasedAwaitsWithdrawal"
|
57
|
+
}
|
58
|
+
|
39
59
|
export class RLNContract {
|
40
|
-
|
60
|
+
public contract: ethers.Contract;
|
41
61
|
private merkleRootTracker: MerkleRootTracker;
|
42
62
|
|
43
63
|
private deployBlock: undefined | number;
|
44
|
-
private
|
45
|
-
private storageContract: undefined | ethers.Contract;
|
46
|
-
private _membersFilter: undefined | ethers.EventFilter;
|
64
|
+
private rateLimit: number;
|
47
65
|
|
48
66
|
private _members: Map<number, Member> = new Map();
|
49
|
-
|
67
|
+
private _membersFilter: ethers.EventFilter;
|
68
|
+
private _membersRemovedFilter: ethers.EventFilter;
|
69
|
+
private _membersExpiredFilter: ethers.EventFilter;
|
70
|
+
|
71
|
+
/**
|
72
|
+
* Asynchronous initializer for RLNContract.
|
73
|
+
* Allows injecting a mocked contract for testing purposes.
|
74
|
+
*/
|
50
75
|
public static async init(
|
51
76
|
rlnInstance: RLNInstance,
|
52
77
|
options: RLNContractInitOptions
|
53
78
|
): Promise<RLNContract> {
|
54
79
|
const rlnContract = new RLNContract(rlnInstance, options);
|
55
80
|
|
56
|
-
await rlnContract.initStorageContract(options.signer);
|
57
81
|
await rlnContract.fetchMembers(rlnInstance);
|
58
82
|
rlnContract.subscribeToMembers(rlnInstance);
|
59
83
|
|
60
84
|
return rlnContract;
|
61
85
|
}
|
62
86
|
|
63
|
-
|
87
|
+
private constructor(
|
64
88
|
rlnInstance: RLNInstance,
|
65
|
-
|
89
|
+
options: RLNContractInitOptions
|
66
90
|
) {
|
91
|
+
const {
|
92
|
+
address,
|
93
|
+
signer,
|
94
|
+
rateLimit = DEFAULT_RATE_LIMIT,
|
95
|
+
contract
|
96
|
+
} = options;
|
97
|
+
|
98
|
+
if (
|
99
|
+
rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
|
100
|
+
rateLimit > RATE_LIMIT_PARAMS.MAX_RATE
|
101
|
+
) {
|
102
|
+
throw new Error(
|
103
|
+
`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE} messages per epoch`
|
104
|
+
);
|
105
|
+
}
|
106
|
+
|
107
|
+
this.rateLimit = rateLimit;
|
108
|
+
|
67
109
|
const initialRoot = rlnInstance.zerokit.getMerkleRoot();
|
68
110
|
|
69
|
-
|
70
|
-
|
71
|
-
RLN_REGISTRY_ABI,
|
72
|
-
signer
|
73
|
-
);
|
111
|
+
// Use the injected contract if provided; otherwise, instantiate a new one.
|
112
|
+
this.contract = contract || new ethers.Contract(address, RLN_ABI, signer);
|
74
113
|
this.merkleRootTracker = new MerkleRootTracker(5, initialRoot);
|
114
|
+
|
115
|
+
// Initialize event filters for all relevant events
|
116
|
+
this._membersFilter = this.contract.filters.MembershipRegistered();
|
117
|
+
this._membersRemovedFilter = this.contract.filters.MembershipErased();
|
118
|
+
this._membersExpiredFilter = this.contract.filters.MembershipExpired();
|
75
119
|
}
|
76
120
|
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
):
|
81
|
-
|
82
|
-
|
83
|
-
: await this.registryContract.usingStorageIndex();
|
84
|
-
const storageAddress = await this.registryContract.storages(storageIndex);
|
121
|
+
/**
|
122
|
+
* Gets the current rate limit for this contract instance
|
123
|
+
*/
|
124
|
+
public getRateLimit(): number {
|
125
|
+
return this.rateLimit;
|
126
|
+
}
|
85
127
|
|
86
|
-
|
87
|
-
|
88
|
-
|
128
|
+
/**
|
129
|
+
* Gets the contract address
|
130
|
+
*/
|
131
|
+
public get address(): string {
|
132
|
+
return this.contract.address;
|
133
|
+
}
|
89
134
|
|
90
|
-
|
91
|
-
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
this._membersFilter = this.storageContract.filters.MemberRegistered();
|
135
|
+
/**
|
136
|
+
* Gets the contract provider
|
137
|
+
*/
|
138
|
+
public get provider(): ethers.providers.Provider {
|
139
|
+
return this.contract.provider;
|
140
|
+
}
|
97
141
|
|
98
|
-
|
142
|
+
/**
|
143
|
+
* Gets the minimum allowed rate limit from the contract
|
144
|
+
* @returns Promise<number> The minimum rate limit in messages per epoch
|
145
|
+
*/
|
146
|
+
public async getMinRateLimit(): Promise<number> {
|
147
|
+
const minRate = await this.contract.minMembershipRateLimit();
|
148
|
+
return minRate.toNumber();
|
99
149
|
}
|
100
150
|
|
101
|
-
|
102
|
-
|
103
|
-
|
104
|
-
|
105
|
-
|
151
|
+
/**
|
152
|
+
* Gets the maximum allowed rate limit from the contract
|
153
|
+
* @returns Promise<number> The maximum rate limit in messages per epoch
|
154
|
+
*/
|
155
|
+
public async getMaxRateLimit(): Promise<number> {
|
156
|
+
const maxRate = await this.contract.maxMembershipRateLimit();
|
157
|
+
return maxRate.toNumber();
|
106
158
|
}
|
107
159
|
|
108
|
-
|
109
|
-
|
110
|
-
|
111
|
-
|
112
|
-
|
160
|
+
/**
|
161
|
+
* Gets the maximum total rate limit across all memberships
|
162
|
+
* @returns Promise<number> The maximum total rate limit in messages per epoch
|
163
|
+
*/
|
164
|
+
public async getMaxTotalRateLimit(): Promise<number> {
|
165
|
+
const maxTotalRate = await this.contract.maxTotalRateLimit();
|
166
|
+
return maxTotalRate.toNumber();
|
167
|
+
}
|
168
|
+
|
169
|
+
/**
|
170
|
+
* Gets the current total rate limit usage across all memberships
|
171
|
+
* @returns Promise<number> The current total rate limit usage in messages per epoch
|
172
|
+
*/
|
173
|
+
public async getCurrentTotalRateLimit(): Promise<number> {
|
174
|
+
const currentTotal = await this.contract.currentTotalRateLimit();
|
175
|
+
return currentTotal.toNumber();
|
176
|
+
}
|
177
|
+
|
178
|
+
/**
|
179
|
+
* Gets the remaining available total rate limit that can be allocated
|
180
|
+
* @returns Promise<number> The remaining rate limit that can be allocated
|
181
|
+
*/
|
182
|
+
public async getRemainingTotalRateLimit(): Promise<number> {
|
183
|
+
const [maxTotal, currentTotal] = await Promise.all([
|
184
|
+
this.contract.maxTotalRateLimit(),
|
185
|
+
this.contract.currentTotalRateLimit()
|
186
|
+
]);
|
187
|
+
return maxTotal.sub(currentTotal).toNumber();
|
188
|
+
}
|
189
|
+
|
190
|
+
/**
|
191
|
+
* Updates the rate limit for future registrations
|
192
|
+
* @param newRateLimit The new rate limit to use
|
193
|
+
*/
|
194
|
+
public async setRateLimit(newRateLimit: number): Promise<void> {
|
195
|
+
this.rateLimit = newRateLimit;
|
113
196
|
}
|
114
197
|
|
115
198
|
public get members(): Member[] {
|
@@ -123,7 +206,21 @@ export class RLNContract {
|
|
123
206
|
if (!this._membersFilter) {
|
124
207
|
throw Error("Members filter was not initialized.");
|
125
208
|
}
|
126
|
-
return this._membersFilter
|
209
|
+
return this._membersFilter;
|
210
|
+
}
|
211
|
+
|
212
|
+
private get membersRemovedFilter(): ethers.EventFilter {
|
213
|
+
if (!this._membersRemovedFilter) {
|
214
|
+
throw Error("MembersErased filter was not initialized.");
|
215
|
+
}
|
216
|
+
return this._membersRemovedFilter;
|
217
|
+
}
|
218
|
+
|
219
|
+
private get membersExpiredFilter(): ethers.EventFilter {
|
220
|
+
if (!this._membersExpiredFilter) {
|
221
|
+
throw Error("MembersExpired filter was not initialized.");
|
222
|
+
}
|
223
|
+
return this._membersExpiredFilter;
|
127
224
|
}
|
128
225
|
|
129
226
|
public async fetchMembers(
|
@@ -135,7 +232,23 @@ export class RLNContract {
|
|
135
232
|
...options,
|
136
233
|
membersFilter: this.membersFilter
|
137
234
|
});
|
138
|
-
this.
|
235
|
+
const removedMemberEvents = await queryFilter(this.contract, {
|
236
|
+
fromBlock: this.deployBlock,
|
237
|
+
...options,
|
238
|
+
membersFilter: this.membersRemovedFilter
|
239
|
+
});
|
240
|
+
const expiredMemberEvents = await queryFilter(this.contract, {
|
241
|
+
fromBlock: this.deployBlock,
|
242
|
+
...options,
|
243
|
+
membersFilter: this.membersExpiredFilter
|
244
|
+
});
|
245
|
+
|
246
|
+
const events = [
|
247
|
+
...registeredMemberEvents,
|
248
|
+
...removedMemberEvents,
|
249
|
+
...expiredMemberEvents
|
250
|
+
];
|
251
|
+
this.processEvents(rlnInstance, events);
|
139
252
|
}
|
140
253
|
|
141
254
|
public processEvents(rlnInstance: RLNInstance, events: ethers.Event[]): void {
|
@@ -147,8 +260,23 @@ export class RLNContract {
|
|
147
260
|
return;
|
148
261
|
}
|
149
262
|
|
150
|
-
if (
|
151
|
-
|
263
|
+
if (
|
264
|
+
evt.event === "MembershipErased" ||
|
265
|
+
evt.event === "MembershipExpired"
|
266
|
+
) {
|
267
|
+
// Both MembershipErased and MembershipExpired events should remove members
|
268
|
+
let index = evt.args.index;
|
269
|
+
|
270
|
+
// Ensure index is an ethers.BigNumber
|
271
|
+
if (!index) {
|
272
|
+
return;
|
273
|
+
}
|
274
|
+
|
275
|
+
// Convert index to ethers.BigNumber if it's not already
|
276
|
+
if (typeof index === "number" || typeof index === "string") {
|
277
|
+
index = ethers.BigNumber.from(index);
|
278
|
+
}
|
279
|
+
|
152
280
|
const toRemoveVal = toRemoveTable.get(evt.blockNumber);
|
153
281
|
if (toRemoveVal != undefined) {
|
154
282
|
toRemoveVal.push(index.toNumber());
|
@@ -156,7 +284,7 @@ export class RLNContract {
|
|
156
284
|
} else {
|
157
285
|
toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
|
158
286
|
}
|
159
|
-
} else {
|
287
|
+
} else if (evt.event === "MembershipRegistered") {
|
160
288
|
let eventsPerBlock = toInsertTable.get(evt.blockNumber);
|
161
289
|
if (eventsPerBlock == undefined) {
|
162
290
|
eventsPerBlock = [];
|
@@ -165,6 +293,7 @@ export class RLNContract {
|
|
165
293
|
eventsPerBlock.push(evt);
|
166
294
|
toInsertTable.set(evt.blockNumber, eventsPerBlock);
|
167
295
|
}
|
296
|
+
// MembershipExtended events don't change the membership set, so we don't need to handle them here
|
168
297
|
});
|
169
298
|
|
170
299
|
this.removeMembers(rlnInstance, toRemoveTable);
|
@@ -177,18 +306,29 @@ export class RLNContract {
|
|
177
306
|
): void {
|
178
307
|
toInsert.forEach((events: ethers.Event[], blockNumber: number) => {
|
179
308
|
events.forEach((evt) => {
|
180
|
-
|
181
|
-
const index: ethers.BigNumber = evt?.args?.index;
|
309
|
+
if (!evt.args) return;
|
182
310
|
|
311
|
+
const _idCommitment = evt.args.idCommitment as string;
|
312
|
+
let index = evt.args.index;
|
313
|
+
|
314
|
+
// Ensure index is an ethers.BigNumber
|
183
315
|
if (!_idCommitment || !index) {
|
184
316
|
return;
|
185
317
|
}
|
186
318
|
|
187
|
-
|
319
|
+
// Convert index to ethers.BigNumber if it's not already
|
320
|
+
if (typeof index === "number" || typeof index === "string") {
|
321
|
+
index = ethers.BigNumber.from(index);
|
322
|
+
}
|
323
|
+
|
324
|
+
const idCommitment = zeroPadLE(hexToBytes(_idCommitment), 32);
|
188
325
|
rlnInstance.zerokit.insertMember(idCommitment);
|
189
|
-
|
190
|
-
|
191
|
-
|
326
|
+
|
327
|
+
// Always store the numeric index as the key, but the BigNumber as the value
|
328
|
+
const numericIndex = index.toNumber();
|
329
|
+
this._members.set(numericIndex, {
|
330
|
+
index, // This is always a BigNumber
|
331
|
+
idCommitment: _idCommitment
|
192
332
|
});
|
193
333
|
});
|
194
334
|
|
@@ -201,7 +341,7 @@ export class RLNContract {
|
|
201
341
|
rlnInstance: RLNInstance,
|
202
342
|
toRemove: Map<number, number[]>
|
203
343
|
): void {
|
204
|
-
const removeDescending = new Map([...toRemove].
|
344
|
+
const removeDescending = new Map([...toRemove].reverse());
|
205
345
|
removeDescending.forEach((indexes: number[], blockNumber: number) => {
|
206
346
|
indexes.forEach((index) => {
|
207
347
|
if (this._members.has(index)) {
|
@@ -215,63 +355,306 @@ export class RLNContract {
|
|
215
355
|
}
|
216
356
|
|
217
357
|
public subscribeToMembers(rlnInstance: RLNInstance): void {
|
218
|
-
this.contract.on(
|
219
|
-
this.
|
358
|
+
this.contract.on(
|
359
|
+
this.membersFilter,
|
360
|
+
(
|
361
|
+
_idCommitment: string,
|
362
|
+
_membershipRateLimit: ethers.BigNumber,
|
363
|
+
_index: ethers.BigNumber,
|
364
|
+
event: ethers.Event
|
365
|
+
) => {
|
366
|
+
this.processEvents(rlnInstance, [event]);
|
367
|
+
}
|
368
|
+
);
|
369
|
+
|
370
|
+
this.contract.on(
|
371
|
+
this.membersRemovedFilter,
|
372
|
+
(
|
373
|
+
_idCommitment: string,
|
374
|
+
_membershipRateLimit: ethers.BigNumber,
|
375
|
+
_index: ethers.BigNumber,
|
376
|
+
event: ethers.Event
|
377
|
+
) => {
|
378
|
+
this.processEvents(rlnInstance, [event]);
|
379
|
+
}
|
380
|
+
);
|
381
|
+
|
382
|
+
this.contract.on(
|
383
|
+
this.membersExpiredFilter,
|
384
|
+
(
|
385
|
+
_idCommitment: string,
|
386
|
+
_membershipRateLimit: ethers.BigNumber,
|
387
|
+
_index: ethers.BigNumber,
|
388
|
+
event: ethers.Event
|
389
|
+
) => {
|
390
|
+
this.processEvents(rlnInstance, [event]);
|
391
|
+
}
|
220
392
|
);
|
221
393
|
}
|
222
394
|
|
223
395
|
public async registerWithIdentity(
|
224
396
|
identity: IdentityCredential
|
225
397
|
): Promise<DecryptedCredentials | undefined> {
|
226
|
-
|
227
|
-
|
228
|
-
|
398
|
+
try {
|
399
|
+
log.info(
|
400
|
+
`Registering identity with rate limit: ${this.rateLimit} messages/epoch`
|
229
401
|
);
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
234
|
-
|
235
|
-
|
402
|
+
|
403
|
+
const txRegisterResponse: ethers.ContractTransaction =
|
404
|
+
await this.contract.register(
|
405
|
+
identity.IDCommitmentBigInt,
|
406
|
+
this.rateLimit,
|
407
|
+
[],
|
408
|
+
{ gasLimit: 300000 }
|
409
|
+
);
|
410
|
+
const txRegisterReceipt = await txRegisterResponse.wait();
|
411
|
+
|
412
|
+
const memberRegistered = txRegisterReceipt.events?.find(
|
413
|
+
(event) => event.event === "MembershipRegistered"
|
414
|
+
);
|
415
|
+
|
416
|
+
if (!memberRegistered || !memberRegistered.args) {
|
417
|
+
log.error(
|
418
|
+
"Failed to register membership: No MembershipRegistered event found"
|
419
|
+
);
|
420
|
+
return undefined;
|
421
|
+
}
|
422
|
+
|
423
|
+
const decodedData: MembershipRegisteredEvent = {
|
424
|
+
idCommitment: memberRegistered.args.idCommitment,
|
425
|
+
membershipRateLimit: memberRegistered.args.membershipRateLimit,
|
426
|
+
index: memberRegistered.args.index
|
427
|
+
};
|
428
|
+
|
429
|
+
log.info(
|
430
|
+
`Successfully registered membership with index ${decodedData.index} ` +
|
431
|
+
`and rate limit ${decodedData.membershipRateLimit}`
|
236
432
|
);
|
237
|
-
const txRegisterReceipt = await txRegisterResponse.wait();
|
238
433
|
|
239
|
-
|
240
|
-
|
434
|
+
const network = await this.contract.provider.getNetwork();
|
435
|
+
const address = this.contract.address;
|
436
|
+
const membershipId = decodedData.index.toNumber();
|
241
437
|
|
242
|
-
|
438
|
+
return {
|
439
|
+
identity,
|
440
|
+
membership: {
|
441
|
+
address,
|
442
|
+
treeIndex: membershipId,
|
443
|
+
chainId: network.chainId
|
444
|
+
}
|
445
|
+
};
|
446
|
+
} catch (error) {
|
447
|
+
log.error(`Error in registerWithIdentity: ${(error as Error).message}`);
|
243
448
|
return undefined;
|
244
449
|
}
|
450
|
+
}
|
245
451
|
|
246
|
-
|
247
|
-
|
248
|
-
|
249
|
-
|
452
|
+
/**
|
453
|
+
* Helper method to get remaining messages in current epoch
|
454
|
+
* @param membershipId The ID of the membership to check
|
455
|
+
* @returns number of remaining messages allowed in current epoch
|
456
|
+
*/
|
457
|
+
public async getRemainingMessages(membershipId: number): Promise<number> {
|
458
|
+
try {
|
459
|
+
const [startTime, , rateLimit] =
|
460
|
+
await this.contract.getMembershipInfo(membershipId);
|
461
|
+
|
462
|
+
// Calculate current epoch
|
463
|
+
const currentTime = Math.floor(Date.now() / 1000);
|
464
|
+
const epochsPassed = Math.floor(
|
465
|
+
(currentTime - startTime) / RATE_LIMIT_PARAMS.EPOCH_LENGTH
|
466
|
+
);
|
467
|
+
const currentEpochStart =
|
468
|
+
startTime + epochsPassed * RATE_LIMIT_PARAMS.EPOCH_LENGTH;
|
469
|
+
|
470
|
+
// Get message count in current epoch using contract's function
|
471
|
+
const messageCount = await this.contract.getMessageCount(
|
472
|
+
membershipId,
|
473
|
+
currentEpochStart
|
474
|
+
);
|
475
|
+
return Math.max(0, rateLimit.sub(messageCount).toNumber());
|
476
|
+
} catch (error) {
|
477
|
+
log.error(
|
478
|
+
`Error getting remaining messages: ${(error as Error).message}`
|
479
|
+
);
|
480
|
+
return 0; // Fail safe: assume no messages remaining on error
|
481
|
+
}
|
482
|
+
}
|
250
483
|
|
251
|
-
|
252
|
-
|
253
|
-
|
484
|
+
public async registerWithPermitAndErase(
|
485
|
+
identity: IdentityCredential,
|
486
|
+
permit: {
|
487
|
+
owner: string;
|
488
|
+
deadline: number;
|
489
|
+
v: number;
|
490
|
+
r: string;
|
491
|
+
s: string;
|
492
|
+
},
|
493
|
+
idCommitmentsToErase: string[]
|
494
|
+
): Promise<DecryptedCredentials | undefined> {
|
495
|
+
try {
|
496
|
+
log.info(
|
497
|
+
`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`
|
498
|
+
);
|
499
|
+
|
500
|
+
const txRegisterResponse: ethers.ContractTransaction =
|
501
|
+
await this.contract.registerWithPermit(
|
502
|
+
permit.owner,
|
503
|
+
permit.deadline,
|
504
|
+
permit.v,
|
505
|
+
permit.r,
|
506
|
+
permit.s,
|
507
|
+
identity.IDCommitmentBigInt,
|
508
|
+
this.rateLimit,
|
509
|
+
idCommitmentsToErase.map((id) => ethers.BigNumber.from(id))
|
510
|
+
);
|
511
|
+
const txRegisterReceipt = await txRegisterResponse.wait();
|
512
|
+
|
513
|
+
const memberRegistered = txRegisterReceipt.events?.find(
|
514
|
+
(event) => event.event === "MembershipRegistered"
|
515
|
+
);
|
254
516
|
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
chainId: network.chainId
|
517
|
+
if (!memberRegistered || !memberRegistered.args) {
|
518
|
+
log.error(
|
519
|
+
"Failed to register membership with permit: No MembershipRegistered event found"
|
520
|
+
);
|
521
|
+
return undefined;
|
261
522
|
}
|
262
|
-
|
523
|
+
|
524
|
+
const decodedData: MembershipRegisteredEvent = {
|
525
|
+
idCommitment: memberRegistered.args.idCommitment,
|
526
|
+
membershipRateLimit: memberRegistered.args.membershipRateLimit,
|
527
|
+
index: memberRegistered.args.index
|
528
|
+
};
|
529
|
+
|
530
|
+
log.info(
|
531
|
+
`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
|
532
|
+
`Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`
|
533
|
+
);
|
534
|
+
|
535
|
+
const network = await this.contract.provider.getNetwork();
|
536
|
+
const address = this.contract.address;
|
537
|
+
const membershipId = decodedData.index.toNumber();
|
538
|
+
|
539
|
+
return {
|
540
|
+
identity,
|
541
|
+
membership: {
|
542
|
+
address,
|
543
|
+
treeIndex: membershipId,
|
544
|
+
chainId: network.chainId
|
545
|
+
}
|
546
|
+
};
|
547
|
+
} catch (error) {
|
548
|
+
log.error(
|
549
|
+
`Error in registerWithPermitAndErase: ${(error as Error).message}`
|
550
|
+
);
|
551
|
+
return undefined;
|
552
|
+
}
|
263
553
|
}
|
264
554
|
|
265
555
|
public roots(): Uint8Array[] {
|
266
556
|
return this.merkleRootTracker.roots();
|
267
557
|
}
|
558
|
+
|
559
|
+
public async withdraw(token: string, holder: string): Promise<void> {
|
560
|
+
try {
|
561
|
+
const tx = await this.contract.withdraw(token, { from: holder });
|
562
|
+
await tx.wait();
|
563
|
+
} catch (error) {
|
564
|
+
log.error(`Error in withdraw: ${(error as Error).message}`);
|
565
|
+
}
|
566
|
+
}
|
567
|
+
|
568
|
+
public async getMembershipInfo(
|
569
|
+
idCommitment: string
|
570
|
+
): Promise<MembershipInfo | undefined> {
|
571
|
+
try {
|
572
|
+
const [startBlock, endBlock, rateLimit] =
|
573
|
+
await this.contract.getMembershipInfo(idCommitment);
|
574
|
+
const currentBlock = await this.contract.provider.getBlockNumber();
|
575
|
+
|
576
|
+
let state: MembershipState;
|
577
|
+
if (currentBlock < startBlock) {
|
578
|
+
state = MembershipState.Active;
|
579
|
+
} else if (currentBlock < endBlock) {
|
580
|
+
state = MembershipState.GracePeriod;
|
581
|
+
} else {
|
582
|
+
state = MembershipState.Expired;
|
583
|
+
}
|
584
|
+
|
585
|
+
const index = await this.getMemberIndex(idCommitment);
|
586
|
+
if (!index) return undefined;
|
587
|
+
|
588
|
+
return {
|
589
|
+
index,
|
590
|
+
idCommitment,
|
591
|
+
rateLimit: rateLimit.toNumber(),
|
592
|
+
startBlock: startBlock.toNumber(),
|
593
|
+
endBlock: endBlock.toNumber(),
|
594
|
+
state
|
595
|
+
};
|
596
|
+
} catch (error) {
|
597
|
+
return undefined;
|
598
|
+
}
|
599
|
+
}
|
600
|
+
|
601
|
+
public async extendMembership(
|
602
|
+
idCommitment: string
|
603
|
+
): Promise<ethers.ContractReceipt> {
|
604
|
+
const tx = await this.contract.extendMemberships([idCommitment]);
|
605
|
+
return await tx.wait();
|
606
|
+
}
|
607
|
+
|
608
|
+
public async eraseMembership(
|
609
|
+
idCommitment: string,
|
610
|
+
eraseFromMembershipSet: boolean = true
|
611
|
+
): Promise<ethers.ContractReceipt> {
|
612
|
+
const tx = await this.contract.eraseMemberships(
|
613
|
+
[idCommitment],
|
614
|
+
eraseFromMembershipSet
|
615
|
+
);
|
616
|
+
return await tx.wait();
|
617
|
+
}
|
618
|
+
|
619
|
+
public async registerMembership(
|
620
|
+
idCommitment: string,
|
621
|
+
rateLimit: number = DEFAULT_RATE_LIMIT
|
622
|
+
): Promise<ethers.ContractReceipt> {
|
623
|
+
if (
|
624
|
+
rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
|
625
|
+
rateLimit > RATE_LIMIT_PARAMS.MAX_RATE
|
626
|
+
) {
|
627
|
+
throw new Error(
|
628
|
+
`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`
|
629
|
+
);
|
630
|
+
}
|
631
|
+
const tx = await this.contract.register(idCommitment, rateLimit, []);
|
632
|
+
return await tx.wait();
|
633
|
+
}
|
634
|
+
|
635
|
+
private async getMemberIndex(
|
636
|
+
idCommitment: string
|
637
|
+
): Promise<ethers.BigNumber | undefined> {
|
638
|
+
try {
|
639
|
+
const events = await this.contract.queryFilter(
|
640
|
+
this.contract.filters.MembershipRegistered(idCommitment)
|
641
|
+
);
|
642
|
+
if (events.length === 0) return undefined;
|
643
|
+
|
644
|
+
// Get the most recent registration event
|
645
|
+
const event = events[events.length - 1];
|
646
|
+
return event.args?.index;
|
647
|
+
} catch (error) {
|
648
|
+
return undefined;
|
649
|
+
}
|
650
|
+
}
|
268
651
|
}
|
269
652
|
|
270
|
-
|
653
|
+
interface CustomQueryOptions extends FetchMembersOptions {
|
271
654
|
membersFilter: ethers.EventFilter;
|
272
|
-
}
|
655
|
+
}
|
273
656
|
|
274
|
-
//
|
657
|
+
// These values should be tested on other networks
|
275
658
|
const FETCH_CHUNK = 5;
|
276
659
|
const BLOCK_RANGE = 3000;
|
277
660
|
|
@@ -286,18 +669,18 @@ async function queryFilter(
|
|
286
669
|
fetchChunks = FETCH_CHUNK
|
287
670
|
} = options;
|
288
671
|
|
289
|
-
if (
|
672
|
+
if (fromBlock === undefined) {
|
290
673
|
return contract.queryFilter(membersFilter);
|
291
674
|
}
|
292
675
|
|
293
|
-
if (!contract.
|
294
|
-
throw Error("No provider found on the contract
|
676
|
+
if (!contract.provider) {
|
677
|
+
throw Error("No provider found on the contract.");
|
295
678
|
}
|
296
679
|
|
297
|
-
const toBlock = await contract.
|
680
|
+
const toBlock = await contract.provider.getBlockNumber();
|
298
681
|
|
299
682
|
if (toBlock - fromBlock < fetchRange) {
|
300
|
-
return contract.queryFilter(membersFilter);
|
683
|
+
return contract.queryFilter(membersFilter, fromBlock, toBlock);
|
301
684
|
}
|
302
685
|
|
303
686
|
const events: ethers.Event[][] = [];
|
@@ -319,7 +702,7 @@ function splitToChunks(
|
|
319
702
|
to: number,
|
320
703
|
step: number
|
321
704
|
): Array<[number, number]> {
|
322
|
-
const chunks = [];
|
705
|
+
const chunks: Array<[number, number]> = [];
|
323
706
|
|
324
707
|
let left = from;
|
325
708
|
while (left < to) {
|
@@ -345,9 +728,18 @@ function* takeN<T>(array: T[], size: number): Iterable<T[]> {
|
|
345
728
|
}
|
346
729
|
}
|
347
730
|
|
348
|
-
function ignoreErrors<T>(
|
349
|
-
|
350
|
-
|
731
|
+
async function ignoreErrors<T>(
|
732
|
+
promise: Promise<T>,
|
733
|
+
defaultValue: T
|
734
|
+
): Promise<T> {
|
735
|
+
try {
|
736
|
+
return await promise;
|
737
|
+
} catch (err: unknown) {
|
738
|
+
if (err instanceof Error) {
|
739
|
+
log.info(`Ignoring an error during query: ${err.message}`);
|
740
|
+
} else {
|
741
|
+
log.info(`Ignoring an unknown error during query`);
|
742
|
+
}
|
351
743
|
return defaultValue;
|
352
|
-
}
|
744
|
+
}
|
353
745
|
}
|