@waku/rln 0.1.5-cad3e7a.0 → 0.1.5-d0da8f8.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 (179) hide show
  1. package/bundle/_virtual/utils.js +2 -2
  2. package/bundle/_virtual/utils2.js +2 -2
  3. package/bundle/index.js +4 -3
  4. package/bundle/packages/rln/dist/contract/constants.js +2 -1
  5. package/bundle/packages/rln/dist/contract/{rln_light_contract.js → rln_base_contract.js} +189 -186
  6. package/bundle/packages/rln/dist/contract/rln_contract.js +10 -420
  7. package/bundle/packages/rln/dist/contract/types.js +9 -0
  8. package/bundle/packages/rln/dist/create.js +1 -1
  9. package/bundle/packages/rln/dist/{rln_light.js → credentials_manager.js} +114 -48
  10. package/bundle/packages/rln/dist/identity.js +0 -9
  11. package/bundle/packages/rln/dist/keystore/keystore.js +31 -17
  12. package/bundle/packages/rln/dist/rln.js +57 -167
  13. package/bundle/packages/rln/dist/utils/bytes.js +8 -2
  14. package/bundle/packages/rln/dist/utils/metamask.js +2 -2
  15. package/bundle/packages/rln/dist/zerokit.js +5 -5
  16. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +1 -1
  17. package/bundle/packages/rln/node_modules/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +2 -2
  18. package/bundle/packages/rln/node_modules/@noble/hashes/_sha2.js +1 -1
  19. package/bundle/packages/rln/node_modules/@noble/hashes/hmac.js +1 -1
  20. package/bundle/packages/rln/node_modules/@noble/hashes/pbkdf2.js +1 -1
  21. package/bundle/packages/rln/node_modules/@noble/hashes/scrypt.js +1 -1
  22. package/bundle/packages/rln/node_modules/@noble/hashes/sha256.js +1 -1
  23. package/bundle/packages/rln/node_modules/@noble/hashes/sha512.js +1 -1
  24. package/bundle/packages/rln/node_modules/@noble/hashes/utils.js +1 -1
  25. package/dist/.tsbuildinfo +1 -1
  26. package/dist/contract/constants.d.ts +1 -1
  27. package/dist/contract/constants.js +1 -1
  28. package/dist/contract/constants.js.map +1 -1
  29. package/dist/contract/index.d.ts +1 -0
  30. package/dist/contract/index.js +1 -0
  31. package/dist/contract/index.js.map +1 -1
  32. package/dist/contract/{rln_light_contract.d.ts → rln_base_contract.d.ts} +24 -58
  33. package/dist/contract/{rln_light_contract.js → rln_base_contract.js} +187 -184
  34. package/dist/contract/rln_base_contract.js.map +1 -0
  35. package/dist/contract/rln_contract.d.ts +5 -122
  36. package/dist/contract/rln_contract.js +8 -417
  37. package/dist/contract/rln_contract.js.map +1 -1
  38. package/dist/contract/types.d.ts +45 -0
  39. package/dist/contract/types.js +8 -0
  40. package/dist/contract/types.js.map +1 -0
  41. package/dist/create.js +1 -1
  42. package/dist/create.js.map +1 -1
  43. package/dist/credentials_manager.d.ts +44 -0
  44. package/dist/credentials_manager.js +197 -0
  45. package/dist/credentials_manager.js.map +1 -0
  46. package/dist/identity.d.ts +0 -1
  47. package/dist/identity.js +0 -9
  48. package/dist/identity.js.map +1 -1
  49. package/dist/index.d.ts +5 -4
  50. package/dist/index.js +4 -3
  51. package/dist/index.js.map +1 -1
  52. package/dist/keystore/keystore.d.ts +1 -0
  53. package/dist/keystore/keystore.js +31 -17
  54. package/dist/keystore/keystore.js.map +1 -1
  55. package/dist/keystore/types.d.ts +3 -3
  56. package/dist/rln.d.ts +9 -52
  57. package/dist/rln.js +55 -164
  58. package/dist/rln.js.map +1 -1
  59. package/dist/types.d.ts +27 -0
  60. package/dist/types.js +2 -0
  61. package/dist/types.js.map +1 -0
  62. package/dist/utils/bytes.js +8 -2
  63. package/dist/utils/bytes.js.map +1 -1
  64. package/dist/zerokit.d.ts +3 -3
  65. package/dist/zerokit.js +5 -5
  66. package/dist/zerokit.js.map +1 -1
  67. package/package.json +1 -1
  68. package/src/contract/constants.ts +1 -1
  69. package/src/contract/index.ts +1 -0
  70. package/src/contract/{rln_light_contract.ts → rln_base_contract.ts} +306 -323
  71. package/src/contract/rln_contract.ts +9 -663
  72. package/src/contract/types.ts +53 -0
  73. package/src/create.ts +1 -1
  74. package/src/credentials_manager.ts +282 -0
  75. package/src/identity.ts +0 -10
  76. package/src/index.ts +7 -5
  77. package/src/keystore/keystore.ts +57 -31
  78. package/src/keystore/types.ts +3 -3
  79. package/src/rln.ts +68 -259
  80. package/src/types.ts +31 -0
  81. package/src/utils/bytes.ts +10 -2
  82. package/src/zerokit.ts +3 -3
  83. package/bundle/_virtual/__node-resolve_empty.js +0 -6
  84. package/bundle/_virtual/_node-resolve_empty.js +0 -3
  85. package/bundle/_virtual/bn.js +0 -3
  86. package/bundle/_virtual/common.js +0 -3
  87. package/bundle/_virtual/common2.js +0 -3
  88. package/bundle/_virtual/hash.js +0 -3
  89. package/bundle/_virtual/inherits_browser.js +0 -3
  90. package/bundle/_virtual/ripemd.js +0 -3
  91. package/bundle/_virtual/sha.js +0 -3
  92. package/bundle/_virtual/sha3.js +0 -3
  93. package/bundle/_virtual/utils3.js +0 -3
  94. package/bundle/node_modules/@ethersproject/abi/lib.esm/_version.js +0 -3
  95. package/bundle/node_modules/@ethersproject/abi/lib.esm/abi-coder.js +0 -96
  96. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/abstract-coder.js +0 -148
  97. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/address.js +0 -26
  98. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/anonymous.js +0 -20
  99. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/array.js +0 -210
  100. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/boolean.js +0 -18
  101. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/bytes.js +0 -30
  102. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/fixed-bytes.js +0 -26
  103. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/null.js +0 -22
  104. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/number.js +0 -43
  105. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/string.js +0 -19
  106. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/tuple.js +0 -58
  107. package/bundle/node_modules/@ethersproject/abi/lib.esm/fragments.js +0 -854
  108. package/bundle/node_modules/@ethersproject/abi/lib.esm/interface.js +0 -609
  109. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/_version.js +0 -3
  110. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/index.js +0 -66
  111. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/_version.js +0 -3
  112. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/index.js +0 -302
  113. package/bundle/node_modules/@ethersproject/address/lib.esm/_version.js +0 -3
  114. package/bundle/node_modules/@ethersproject/address/lib.esm/index.js +0 -110
  115. package/bundle/node_modules/@ethersproject/base64/lib.esm/base64.js +0 -20
  116. package/bundle/node_modules/@ethersproject/basex/lib.esm/index.js +0 -120
  117. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/_version.js +0 -3
  118. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/bignumber.js +0 -287
  119. package/bundle/node_modules/@ethersproject/bytes/lib.esm/_version.js +0 -3
  120. package/bundle/node_modules/@ethersproject/bytes/lib.esm/index.js +0 -402
  121. package/bundle/node_modules/@ethersproject/constants/lib.esm/addresses.js +0 -3
  122. package/bundle/node_modules/@ethersproject/constants/lib.esm/bignumbers.js +0 -8
  123. package/bundle/node_modules/@ethersproject/constants/lib.esm/hashes.js +0 -3
  124. package/bundle/node_modules/@ethersproject/contracts/lib.esm/_version.js +0 -3
  125. package/bundle/node_modules/@ethersproject/contracts/lib.esm/index.js +0 -893
  126. package/bundle/node_modules/@ethersproject/hash/lib.esm/_version.js +0 -3
  127. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/decoder.js +0 -256
  128. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/include.js +0 -36
  129. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/lib.js +0 -135
  130. package/bundle/node_modules/@ethersproject/hash/lib.esm/id.js +0 -8
  131. package/bundle/node_modules/@ethersproject/hash/lib.esm/namehash.js +0 -64
  132. package/bundle/node_modules/@ethersproject/hash/lib.esm/typed-data.js +0 -443
  133. package/bundle/node_modules/@ethersproject/keccak256/lib.esm/index.js +0 -8
  134. package/bundle/node_modules/@ethersproject/keccak256/node_modules/js-sha3/src/sha3.js +0 -660
  135. package/bundle/node_modules/@ethersproject/logger/lib.esm/_version.js +0 -3
  136. package/bundle/node_modules/@ethersproject/logger/lib.esm/index.js +0 -352
  137. package/bundle/node_modules/@ethersproject/networks/lib.esm/_version.js +0 -3
  138. package/bundle/node_modules/@ethersproject/networks/lib.esm/index.js +0 -248
  139. package/bundle/node_modules/@ethersproject/properties/lib.esm/_version.js +0 -3
  140. package/bundle/node_modules/@ethersproject/properties/lib.esm/index.js +0 -127
  141. package/bundle/node_modules/@ethersproject/providers/lib.esm/_version.js +0 -3
  142. package/bundle/node_modules/@ethersproject/providers/lib.esm/base-provider.js +0 -2007
  143. package/bundle/node_modules/@ethersproject/providers/lib.esm/formatter.js +0 -422
  144. package/bundle/node_modules/@ethersproject/providers/lib.esm/json-rpc-provider.js +0 -674
  145. package/bundle/node_modules/@ethersproject/providers/lib.esm/web3-provider.js +0 -132
  146. package/bundle/node_modules/@ethersproject/rlp/lib.esm/_version.js +0 -3
  147. package/bundle/node_modules/@ethersproject/rlp/lib.esm/index.js +0 -120
  148. package/bundle/node_modules/@ethersproject/sha2/lib.esm/sha2.js +0 -8
  149. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/_version.js +0 -3
  150. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/elliptic.js +0 -2430
  151. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/index.js +0 -76
  152. package/bundle/node_modules/@ethersproject/strings/lib.esm/_version.js +0 -3
  153. package/bundle/node_modules/@ethersproject/strings/lib.esm/utf8.js +0 -219
  154. package/bundle/node_modules/@ethersproject/transactions/lib.esm/_version.js +0 -3
  155. package/bundle/node_modules/@ethersproject/transactions/lib.esm/index.js +0 -279
  156. package/bundle/node_modules/@ethersproject/web/lib.esm/_version.js +0 -3
  157. package/bundle/node_modules/@ethersproject/web/lib.esm/geturl.js +0 -69
  158. package/bundle/node_modules/@ethersproject/web/lib.esm/index.js +0 -404
  159. package/bundle/node_modules/bech32/index.js +0 -187
  160. package/bundle/node_modules/bn.js/lib/bn.js +0 -3361
  161. package/bundle/node_modules/hash.js/lib/hash/common.js +0 -97
  162. package/bundle/node_modules/hash.js/lib/hash/hmac.js +0 -51
  163. package/bundle/node_modules/hash.js/lib/hash/ripemd.js +0 -152
  164. package/bundle/node_modules/hash.js/lib/hash/sha/1.js +0 -81
  165. package/bundle/node_modules/hash.js/lib/hash/sha/224.js +0 -33
  166. package/bundle/node_modules/hash.js/lib/hash/sha/256.js +0 -113
  167. package/bundle/node_modules/hash.js/lib/hash/sha/384.js +0 -39
  168. package/bundle/node_modules/hash.js/lib/hash/sha/512.js +0 -336
  169. package/bundle/node_modules/hash.js/lib/hash/sha/common.js +0 -53
  170. package/bundle/node_modules/hash.js/lib/hash/sha.js +0 -14
  171. package/bundle/node_modules/hash.js/lib/hash/utils.js +0 -282
  172. package/bundle/node_modules/hash.js/lib/hash.js +0 -33
  173. package/bundle/node_modules/inherits/inherits_browser.js +0 -33
  174. package/bundle/node_modules/minimalistic-assert/index.js +0 -13
  175. package/dist/contract/rln_light_contract.js.map +0 -1
  176. package/dist/rln_light.d.ts +0 -64
  177. package/dist/rln_light.js +0 -144
  178. package/dist/rln_light.js.map +0 -1
  179. package/src/rln_light.ts +0 -235
@@ -1 +1 @@
1
- {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/contract/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,OAAO;IAChB,OAAO,EAAE,4CAA4C;IACrD,GAAG,EAAE,OAAO;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,EAAE,EAAE,iDAAiD;IAC1D,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG,CAAC,kDAAkD;CACpD,CAAC;AAEX,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,gBAAgB,CAAC,GAAG;IAC9B,QAAQ,EAAE,gBAAgB,CAAC,IAAI;IAC/B,cAAc,EAAE,OAAO,EAAE,kDAAkD;IAC3E,YAAY,EAAE,GAAG,CAAC,uCAAuC;CACjD,CAAC;AAEX,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC"}
1
+ {"version":3,"file":"constants.js","sourceRoot":"","sources":["../../src/contract/constants.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AAEnC,MAAM,CAAC,MAAM,cAAc,GAAG;IAC5B,OAAO,EAAE,KAAK;IACd,OAAO,EAAE,4CAA4C;IACrD,GAAG,EAAE,OAAO;CACb,CAAC;AAEF;;;;GAIG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,GAAG,EAAE,EAAE,EAAE,iDAAiD;IAC1D,MAAM,EAAE,GAAG;IACX,IAAI,EAAE,GAAG,CAAC,kDAAkD;CACpD,CAAC;AAEX,+BAA+B;AAC/B,MAAM,CAAC,MAAM,iBAAiB,GAAG;IAC/B,QAAQ,EAAE,gBAAgB,CAAC,GAAG;IAC9B,QAAQ,EAAE,gBAAgB,CAAC,IAAI;IAC/B,cAAc,EAAE,OAAO,EAAE,kDAAkD;IAC3E,YAAY,EAAE,GAAG,CAAC,uCAAuC;CACjD,CAAC;AAEX,MAAM,CAAC,MAAM,kBAAkB,GAAG,iBAAiB,CAAC,QAAQ,CAAC"}
@@ -1,2 +1,3 @@
1
1
  export { RLNContract } from "./rln_contract.js";
2
2
  export * from "./constants.js";
3
+ export * from "./types.js";
@@ -1,3 +1,4 @@
1
1
  export { RLNContract } from "./rln_contract.js";
2
2
  export * from "./constants.js";
3
+ export * from "./types.js";
3
4
  //# sourceMappingURL=index.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,cAAc,gBAAgB,CAAC"}
1
+ {"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/contract/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,YAAY,CAAC"}
@@ -1,56 +1,20 @@
1
1
  import { ethers } from "ethers";
2
- import type { IdentityCredential } from "../identity.js";
3
- import type { DecryptedCredentials } from "../keystore/index.js";
4
- type Member = {
5
- idCommitment: string;
6
- index: ethers.BigNumber;
7
- };
8
- interface RLNContractOptions {
9
- signer: ethers.Signer;
10
- address: string;
11
- rateLimit?: number;
12
- }
13
- interface RLNContractInitOptions extends RLNContractOptions {
14
- contract?: ethers.Contract;
15
- }
16
- export interface MembershipRegisteredEvent {
17
- idCommitment: string;
18
- membershipRateLimit: ethers.BigNumber;
19
- index: ethers.BigNumber;
20
- }
21
- type FetchMembersOptions = {
22
- fromBlock?: number;
23
- fetchRange?: number;
24
- fetchChunks?: number;
25
- };
26
- export interface MembershipInfo {
27
- index: ethers.BigNumber;
28
- idCommitment: string;
29
- rateLimit: number;
30
- startBlock: number;
31
- endBlock: number;
32
- state: MembershipState;
33
- }
34
- export declare enum MembershipState {
35
- Active = "Active",
36
- GracePeriod = "GracePeriod",
37
- Expired = "Expired",
38
- ErasedAwaitsWithdrawal = "ErasedAwaitsWithdrawal"
39
- }
40
- export declare class RLNLightContract {
2
+ import { IdentityCredential } from "../identity.js";
3
+ import { DecryptedCredentials } from "../keystore/types.js";
4
+ import { CustomQueryOptions, FetchMembersOptions, Member, MembershipInfo, RLNContractInitOptions } from "./types.js";
5
+ export declare class RLNBaseContract {
41
6
  contract: ethers.Contract;
42
7
  private deployBlock;
43
8
  private rateLimit;
44
- private _members;
9
+ protected _members: Map<number, Member>;
45
10
  private _membersFilter;
46
11
  private _membershipErasedFilter;
47
12
  private _membersExpiredFilter;
48
13
  /**
49
- * Asynchronous initializer for RLNContract.
14
+ * Constructor for RLNBaseContract.
50
15
  * Allows injecting a mocked contract for testing purposes.
51
16
  */
52
- static init(options: RLNContractInitOptions): Promise<RLNLightContract>;
53
- private constructor();
17
+ constructor(options: RLNContractInitOptions);
54
18
  /**
55
19
  * Gets the current rate limit for this contract instance
56
20
  */
@@ -94,19 +58,19 @@ export declare class RLNLightContract {
94
58
  */
95
59
  setRateLimit(newRateLimit: number): Promise<void>;
96
60
  get members(): Member[];
97
- private get membersFilter();
98
- private get membershipErasedFilter();
99
- private get membersExpiredFilter();
100
61
  fetchMembers(options?: FetchMembersOptions): Promise<void>;
62
+ static queryFilter(contract: ethers.Contract, options: CustomQueryOptions): Promise<ethers.Event[]>;
101
63
  processEvents(events: ethers.Event[]): void;
64
+ static splitToChunks(from: number, to: number, step: number): Array<[number, number]>;
65
+ static takeN<T>(array: T[], size: number): Iterable<T[]>;
66
+ static ignoreErrors<T>(promise: Promise<T>, defaultValue: T): Promise<T>;
102
67
  subscribeToMembers(): void;
68
+ getMembershipInfo(idCommitmentBigInt: bigint): Promise<MembershipInfo | undefined>;
69
+ extendMembership(idCommitmentBigInt: bigint): Promise<ethers.ContractTransaction>;
70
+ eraseMembership(idCommitmentBigInt: bigint, eraseFromMembershipSet?: boolean): Promise<ethers.ContractTransaction>;
71
+ registerMembership(idCommitmentBigInt: bigint, rateLimit?: number): Promise<ethers.ContractTransaction>;
72
+ withdraw(token: string, from: string): Promise<void>;
103
73
  registerWithIdentity(identity: IdentityCredential): Promise<DecryptedCredentials | undefined>;
104
- /**
105
- * Helper method to get remaining messages in current epoch
106
- * @param membershipId The ID of the membership to check
107
- * @returns number of remaining messages allowed in current epoch
108
- */
109
- getRemainingMessages(membershipId: number): Promise<number>;
110
74
  registerWithPermitAndErase(identity: IdentityCredential, permit: {
111
75
  owner: string;
112
76
  deadline: number;
@@ -114,11 +78,13 @@ export declare class RLNLightContract {
114
78
  r: string;
115
79
  s: string;
116
80
  }, idCommitmentsToErase: string[]): Promise<DecryptedCredentials | undefined>;
117
- withdraw(token: string, holder: string): Promise<void>;
118
- getMembershipInfo(idCommitment: string): Promise<MembershipInfo | undefined>;
119
- extendMembership(idCommitment: string): Promise<ethers.ContractTransaction>;
120
- eraseMembership(idCommitment: string, eraseFromMembershipSet?: boolean): Promise<ethers.ContractTransaction>;
121
- registerMembership(idCommitment: string, rateLimit?: number): Promise<ethers.ContractTransaction>;
81
+ /**
82
+ * Validates that the rate limit is within the allowed range
83
+ * @throws Error if the rate limit is outside the allowed range
84
+ */
85
+ private validateRateLimit;
86
+ private get membersFilter();
87
+ private get membershipErasedFilter();
88
+ private get membersExpiredFilter();
122
89
  private getMemberIndex;
123
90
  }
124
- export {};
@@ -2,15 +2,9 @@ import { Logger } from "@waku/utils";
2
2
  import { ethers } from "ethers";
3
3
  import { RLN_ABI } from "./abi.js";
4
4
  import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./constants.js";
5
- const log = new Logger("waku:rln:contract");
6
- export var MembershipState;
7
- (function (MembershipState) {
8
- MembershipState["Active"] = "Active";
9
- MembershipState["GracePeriod"] = "GracePeriod";
10
- MembershipState["Expired"] = "Expired";
11
- MembershipState["ErasedAwaitsWithdrawal"] = "ErasedAwaitsWithdrawal";
12
- })(MembershipState || (MembershipState = {}));
13
- export class RLNLightContract {
5
+ import { MembershipState } from "./types.js";
6
+ const log = new Logger("waku:rln:contract:base");
7
+ export class RLNBaseContract {
14
8
  contract;
15
9
  deployBlock;
16
10
  rateLimit;
@@ -19,28 +13,38 @@ export class RLNLightContract {
19
13
  _membershipErasedFilter;
20
14
  _membersExpiredFilter;
21
15
  /**
22
- * Asynchronous initializer for RLNContract.
16
+ * Constructor for RLNBaseContract.
23
17
  * Allows injecting a mocked contract for testing purposes.
24
18
  */
25
- static async init(options) {
26
- const rlnContract = new RLNLightContract(options);
27
- await rlnContract.fetchMembers();
28
- rlnContract.subscribeToMembers();
29
- return rlnContract;
30
- }
31
19
  constructor(options) {
32
20
  const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
33
- if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
34
- rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
35
- throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE} messages per epoch`);
36
- }
37
- this.rateLimit = rateLimit;
38
- // Use the injected contract if provided; otherwise, instantiate a new one.
21
+ log.info("Initializing RLNBaseContract", { address, rateLimit });
39
22
  this.contract = contract || new ethers.Contract(address, RLN_ABI, signer);
40
- // Initialize event filters
41
- this._membersFilter = this.contract.filters.MembershipRegistered();
42
- this._membershipErasedFilter = this.contract.filters.MembershipErased();
43
- this._membersExpiredFilter = this.contract.filters.MembershipExpired();
23
+ this.rateLimit = rateLimit;
24
+ try {
25
+ log.info("Setting up event filters");
26
+ // Initialize event filters
27
+ this._membersFilter = this.contract.filters.MembershipRegistered();
28
+ this._membershipErasedFilter = this.contract.filters.MembershipErased();
29
+ this._membersExpiredFilter = this.contract.filters.MembershipExpired();
30
+ log.info("Event filters initialized successfully");
31
+ }
32
+ catch (error) {
33
+ log.error("Failed to initialize event filters", { error });
34
+ throw new Error("Failed to initialize event filters: " + error.message);
35
+ }
36
+ // Initialize members and subscriptions
37
+ this.fetchMembers()
38
+ .then(() => {
39
+ this.subscribeToMembers();
40
+ })
41
+ .catch((error) => {
42
+ log.error("Failed to initialize members", { error });
43
+ });
44
+ // Validate rate limit asynchronously
45
+ this.validateRateLimit(rateLimit).catch((error) => {
46
+ log.error("Failed to validate initial rate limit", { error });
47
+ });
44
48
  }
45
49
  /**
46
50
  * Gets the current rate limit for this contract instance
@@ -82,7 +86,7 @@ export class RLNLightContract {
82
86
  */
83
87
  async getMaxTotalRateLimit() {
84
88
  const maxTotalRate = await this.contract.maxTotalRateLimit();
85
- return ethers.BigNumber.from(maxTotalRate).toNumber();
89
+ return maxTotalRate.toNumber();
86
90
  }
87
91
  /**
88
92
  * Gets the current total rate limit usage across all memberships
@@ -90,7 +94,7 @@ export class RLNLightContract {
90
94
  */
91
95
  async getCurrentTotalRateLimit() {
92
96
  const currentTotal = await this.contract.currentTotalRateLimit();
93
- return ethers.BigNumber.from(currentTotal).toNumber();
97
+ return currentTotal.toNumber();
94
98
  }
95
99
  /**
96
100
  * Gets the remaining available total rate limit that can be allocated
@@ -101,51 +105,32 @@ export class RLNLightContract {
101
105
  this.contract.maxTotalRateLimit(),
102
106
  this.contract.currentTotalRateLimit()
103
107
  ]);
104
- return ethers.BigNumber.from(maxTotal)
105
- .sub(ethers.BigNumber.from(currentTotal))
106
- .toNumber();
108
+ return Number(maxTotal) - Number(currentTotal);
107
109
  }
108
110
  /**
109
111
  * Updates the rate limit for future registrations
110
112
  * @param newRateLimit The new rate limit to use
111
113
  */
112
114
  async setRateLimit(newRateLimit) {
115
+ await this.validateRateLimit(newRateLimit);
113
116
  this.rateLimit = newRateLimit;
114
117
  }
115
118
  get members() {
116
119
  const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
117
120
  return sortedMembers;
118
121
  }
119
- get membersFilter() {
120
- if (!this._membersFilter) {
121
- throw Error("Members filter was not initialized.");
122
- }
123
- return this._membersFilter;
124
- }
125
- get membershipErasedFilter() {
126
- if (!this._membershipErasedFilter) {
127
- throw Error("MembershipErased filter was not initialized.");
128
- }
129
- return this._membershipErasedFilter;
130
- }
131
- get membersExpiredFilter() {
132
- if (!this._membersExpiredFilter) {
133
- throw Error("MembersExpired filter was not initialized.");
134
- }
135
- return this._membersExpiredFilter;
136
- }
137
122
  async fetchMembers(options = {}) {
138
- const registeredMemberEvents = await queryFilter(this.contract, {
123
+ const registeredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
139
124
  fromBlock: this.deployBlock,
140
125
  ...options,
141
126
  membersFilter: this.membersFilter
142
127
  });
143
- const removedMemberEvents = await queryFilter(this.contract, {
128
+ const removedMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
144
129
  fromBlock: this.deployBlock,
145
130
  ...options,
146
131
  membersFilter: this.membershipErasedFilter
147
132
  });
148
- const expiredMemberEvents = await queryFilter(this.contract, {
133
+ const expiredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
149
134
  fromBlock: this.deployBlock,
150
135
  ...options,
151
136
  membersFilter: this.membersExpiredFilter
@@ -157,6 +142,29 @@ export class RLNLightContract {
157
142
  ];
158
143
  this.processEvents(events);
159
144
  }
145
+ static async queryFilter(contract, options) {
146
+ const FETCH_CHUNK = 5;
147
+ const BLOCK_RANGE = 3000;
148
+ const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
149
+ if (fromBlock === undefined) {
150
+ return contract.queryFilter(membersFilter);
151
+ }
152
+ if (!contract.provider) {
153
+ throw Error("No provider found on the contract.");
154
+ }
155
+ const toBlock = await contract.provider.getBlockNumber();
156
+ if (toBlock - fromBlock < fetchRange) {
157
+ return contract.queryFilter(membersFilter, fromBlock, toBlock);
158
+ }
159
+ const events = [];
160
+ const chunks = RLNBaseContract.splitToChunks(fromBlock, toBlock, fetchRange);
161
+ for (const portion of RLNBaseContract.takeN(chunks, fetchChunks)) {
162
+ const promises = portion.map(([left, right]) => RLNBaseContract.ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
163
+ const fetchedEvents = await Promise.all(promises);
164
+ events.push(fetchedEvents.flatMap((v) => v));
165
+ }
166
+ return events.flatMap((v) => v);
167
+ }
160
168
  processEvents(events) {
161
169
  const toRemoveTable = new Map();
162
170
  const toInsertTable = new Map();
@@ -192,6 +200,38 @@ export class RLNLightContract {
192
200
  }
193
201
  });
194
202
  }
203
+ static splitToChunks(from, to, step) {
204
+ const chunks = [];
205
+ let left = from;
206
+ while (left < to) {
207
+ const right = left + step < to ? left + step : to;
208
+ chunks.push([left, right]);
209
+ left = right;
210
+ }
211
+ return chunks;
212
+ }
213
+ static *takeN(array, size) {
214
+ let start = 0;
215
+ while (start < array.length) {
216
+ const portion = array.slice(start, start + size);
217
+ yield portion;
218
+ start += size;
219
+ }
220
+ }
221
+ static async ignoreErrors(promise, defaultValue) {
222
+ try {
223
+ return await promise;
224
+ }
225
+ catch (err) {
226
+ if (err instanceof Error) {
227
+ log.info(`Ignoring an error during query: ${err.message}`);
228
+ }
229
+ else {
230
+ log.info(`Ignoring an unknown error during query`);
231
+ }
232
+ return defaultValue;
233
+ }
234
+ }
195
235
  subscribeToMembers() {
196
236
  this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
197
237
  this.processEvents([event]);
@@ -203,11 +243,72 @@ export class RLNLightContract {
203
243
  this.processEvents([event]);
204
244
  });
205
245
  }
246
+ async getMembershipInfo(idCommitmentBigInt) {
247
+ try {
248
+ const membershipData = await this.contract.memberships(idCommitmentBigInt);
249
+ const currentBlock = await this.contract.provider.getBlockNumber();
250
+ const [depositAmount, activeDuration, gracePeriodStartTimestamp, gracePeriodDuration, rateLimit, index, holder, token] = membershipData;
251
+ const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
252
+ let state;
253
+ if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
254
+ state = MembershipState.Active;
255
+ }
256
+ else if (currentBlock < gracePeriodEnd.toNumber()) {
257
+ state = MembershipState.GracePeriod;
258
+ }
259
+ else {
260
+ state = MembershipState.Expired;
261
+ }
262
+ return {
263
+ index,
264
+ idCommitment: idCommitmentBigInt.toString(),
265
+ rateLimit: Number(rateLimit),
266
+ startBlock: gracePeriodStartTimestamp.toNumber(),
267
+ endBlock: gracePeriodEnd.toNumber(),
268
+ state,
269
+ depositAmount,
270
+ activeDuration,
271
+ gracePeriodDuration,
272
+ holder,
273
+ token
274
+ };
275
+ }
276
+ catch (error) {
277
+ log.error("Error in getMembershipInfo:", error);
278
+ return undefined;
279
+ }
280
+ }
281
+ async extendMembership(idCommitmentBigInt) {
282
+ const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
283
+ await tx.wait();
284
+ return tx;
285
+ }
286
+ async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
287
+ const tx = await this.contract["eraseMemberships(uint256[],bool)"]([idCommitmentBigInt], eraseFromMembershipSet);
288
+ await tx.wait();
289
+ return tx;
290
+ }
291
+ async registerMembership(idCommitmentBigInt, rateLimit = DEFAULT_RATE_LIMIT) {
292
+ if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
293
+ rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
294
+ throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
295
+ }
296
+ return this.contract.register(idCommitmentBigInt, rateLimit, []);
297
+ }
298
+ async withdraw(token, from) {
299
+ try {
300
+ const tx = await this.contract.withdraw(token, from);
301
+ await tx.wait();
302
+ }
303
+ catch (error) {
304
+ log.error(`Error in withdraw: ${error.message}`);
305
+ }
306
+ }
206
307
  async registerWithIdentity(identity) {
207
308
  try {
208
309
  log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
209
310
  // Check if the ID commitment is already registered
210
- const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt.toString());
311
+ const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
211
312
  if (existingIndex) {
212
313
  throw new Error(`ID commitment is already registered with index ${existingIndex}`);
213
314
  }
@@ -237,12 +338,12 @@ export class RLNLightContract {
237
338
  `and rate limit ${decodedData.membershipRateLimit}`);
238
339
  const network = await this.contract.provider.getNetwork();
239
340
  const address = this.contract.address;
240
- const membershipId = decodedData.index.toString();
341
+ const membershipId = Number(decodedData.index);
241
342
  return {
242
343
  identity,
243
344
  membership: {
244
345
  address,
245
- treeIndex: `0x${membershipId}`,
346
+ treeIndex: membershipId,
246
347
  chainId: network.chainId.toString(),
247
348
  rateLimit: decodedData.membershipRateLimit.toNumber()
248
349
  }
@@ -277,29 +378,6 @@ export class RLNLightContract {
277
378
  }
278
379
  }
279
380
  }
280
- /**
281
- * Helper method to get remaining messages in current epoch
282
- * @param membershipId The ID of the membership to check
283
- * @returns number of remaining messages allowed in current epoch
284
- */
285
- async getRemainingMessages(membershipId) {
286
- try {
287
- const [startTime, , rateLimit] = await this.contract.getMembershipInfo(membershipId);
288
- // Calculate current epoch
289
- const currentTime = Math.floor(Date.now() / 1000);
290
- const epochsPassed = Math.floor((currentTime - startTime) / RATE_LIMIT_PARAMS.EPOCH_LENGTH);
291
- const currentEpochStart = startTime + epochsPassed * RATE_LIMIT_PARAMS.EPOCH_LENGTH;
292
- // Get message count in current epoch using contract's function
293
- const messageCount = await this.contract.getMessageCount(membershipId, currentEpochStart);
294
- return Math.max(0, ethers.BigNumber.from(rateLimit)
295
- .sub(ethers.BigNumber.from(messageCount))
296
- .toNumber());
297
- }
298
- catch (error) {
299
- log.error(`Error getting remaining messages: ${error.message}`);
300
- return 0; // Fail safe: assume no messages remaining on error
301
- }
302
- }
303
381
  async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
304
382
  try {
305
383
  log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
@@ -319,12 +397,12 @@ export class RLNLightContract {
319
397
  `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
320
398
  const network = await this.contract.provider.getNetwork();
321
399
  const address = this.contract.address;
322
- const membershipId = decodedData.index.toString();
400
+ const membershipId = Number(decodedData.index);
323
401
  return {
324
402
  identity,
325
403
  membership: {
326
404
  address,
327
- treeIndex: `0x${membershipId}`,
405
+ treeIndex: membershipId,
328
406
  chainId: network.chainId.toString(),
329
407
  rateLimit: decodedData.membershipRateLimit.toNumber()
330
408
  }
@@ -335,61 +413,42 @@ export class RLNLightContract {
335
413
  return undefined;
336
414
  }
337
415
  }
338
- async withdraw(token, holder) {
339
- try {
340
- const tx = await this.contract.withdraw(token, { from: holder });
341
- await tx.wait();
342
- }
343
- catch (error) {
344
- log.error(`Error in withdraw: ${error.message}`);
416
+ /**
417
+ * Validates that the rate limit is within the allowed range
418
+ * @throws Error if the rate limit is outside the allowed range
419
+ */
420
+ async validateRateLimit(rateLimit) {
421
+ const [minRate, maxRate] = await Promise.all([
422
+ this.contract.minMembershipRateLimit(),
423
+ this.contract.maxMembershipRateLimit()
424
+ ]);
425
+ const minRateNum = ethers.BigNumber.from(minRate).toNumber();
426
+ const maxRateNum = ethers.BigNumber.from(maxRate).toNumber();
427
+ if (rateLimit < minRateNum || rateLimit > maxRateNum) {
428
+ throw new Error(`Rate limit must be between ${minRateNum} and ${maxRateNum} messages per epoch`);
345
429
  }
346
430
  }
347
- async getMembershipInfo(idCommitment) {
348
- try {
349
- const [startBlock, endBlock, rateLimit] = await this.contract.getMembershipInfo(idCommitment);
350
- const currentBlock = await this.contract.provider.getBlockNumber();
351
- let state;
352
- if (currentBlock < startBlock) {
353
- state = MembershipState.Active;
354
- }
355
- else if (currentBlock < endBlock) {
356
- state = MembershipState.GracePeriod;
357
- }
358
- else {
359
- state = MembershipState.Expired;
360
- }
361
- const index = await this.getMemberIndex(idCommitment);
362
- if (!index)
363
- return undefined;
364
- return {
365
- index,
366
- idCommitment,
367
- rateLimit: rateLimit.toNumber(),
368
- startBlock: startBlock.toNumber(),
369
- endBlock: endBlock.toNumber(),
370
- state
371
- };
372
- }
373
- catch (error) {
374
- return undefined;
431
+ get membersFilter() {
432
+ if (!this._membersFilter) {
433
+ throw Error("Members filter was not initialized.");
375
434
  }
435
+ return this._membersFilter;
376
436
  }
377
- async extendMembership(idCommitment) {
378
- return this.contract.extendMemberships([idCommitment]);
379
- }
380
- async eraseMembership(idCommitment, eraseFromMembershipSet = true) {
381
- return this.contract.eraseMemberships([idCommitment], eraseFromMembershipSet);
437
+ get membershipErasedFilter() {
438
+ if (!this._membershipErasedFilter) {
439
+ throw Error("MembershipErased filter was not initialized.");
440
+ }
441
+ return this._membershipErasedFilter;
382
442
  }
383
- async registerMembership(idCommitment, rateLimit = DEFAULT_RATE_LIMIT) {
384
- if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
385
- rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
386
- throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
443
+ get membersExpiredFilter() {
444
+ if (!this._membersExpiredFilter) {
445
+ throw Error("MembersExpired filter was not initialized.");
387
446
  }
388
- return this.contract.register(idCommitment, rateLimit, []);
447
+ return this._membersExpiredFilter;
389
448
  }
390
- async getMemberIndex(idCommitment) {
449
+ async getMemberIndex(idCommitmentBigInt) {
391
450
  try {
392
- const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitment));
451
+ const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitmentBigInt));
393
452
  if (events.length === 0)
394
453
  return undefined;
395
454
  // Get the most recent registration event
@@ -401,60 +460,4 @@ export class RLNLightContract {
401
460
  }
402
461
  }
403
462
  }
404
- // These values should be tested on other networks
405
- const FETCH_CHUNK = 5;
406
- const BLOCK_RANGE = 3000;
407
- async function queryFilter(contract, options) {
408
- const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
409
- if (fromBlock === undefined) {
410
- return contract.queryFilter(membersFilter);
411
- }
412
- if (!contract.provider) {
413
- throw Error("No provider found on the contract.");
414
- }
415
- const toBlock = await contract.provider.getBlockNumber();
416
- if (toBlock - fromBlock < fetchRange) {
417
- return contract.queryFilter(membersFilter, fromBlock, toBlock);
418
- }
419
- const events = [];
420
- const chunks = splitToChunks(fromBlock, toBlock, fetchRange);
421
- for (const portion of takeN(chunks, fetchChunks)) {
422
- const promises = portion.map(([left, right]) => ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
423
- const fetchedEvents = await Promise.all(promises);
424
- events.push(fetchedEvents.flatMap((v) => v));
425
- }
426
- return events.flatMap((v) => v);
427
- }
428
- function splitToChunks(from, to, step) {
429
- const chunks = [];
430
- let left = from;
431
- while (left < to) {
432
- const right = left + step < to ? left + step : to;
433
- chunks.push([left, right]);
434
- left = right;
435
- }
436
- return chunks;
437
- }
438
- function* takeN(array, size) {
439
- let start = 0;
440
- while (start < array.length) {
441
- const portion = array.slice(start, start + size);
442
- yield portion;
443
- start += size;
444
- }
445
- }
446
- async function ignoreErrors(promise, defaultValue) {
447
- try {
448
- return await promise;
449
- }
450
- catch (err) {
451
- if (err instanceof Error) {
452
- log.info(`Ignoring an error during query: ${err.message}`);
453
- }
454
- else {
455
- log.info(`Ignoring an unknown error during query`);
456
- }
457
- return defaultValue;
458
- }
459
- }
460
- //# sourceMappingURL=rln_light_contract.js.map
463
+ //# sourceMappingURL=rln_base_contract.js.map