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