@waku/rln 0.1.4 → 0.1.5-164df63.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 (223) hide show
  1. package/README.md +5 -0
  2. package/bundle/_virtual/index2.js +1 -1
  3. package/bundle/index.js +4 -1
  4. package/bundle/packages/rln/dist/contract/abi.js +502 -248
  5. package/bundle/packages/rln/dist/contract/constants.js +5 -4
  6. package/bundle/packages/rln/dist/contract/rln_base_contract.js +483 -0
  7. package/bundle/packages/rln/dist/contract/rln_contract.js +32 -358
  8. package/bundle/packages/rln/dist/contract/types.js +9 -0
  9. package/bundle/packages/rln/dist/create.js +1 -1
  10. package/bundle/packages/rln/dist/credentials_manager.js +215 -0
  11. package/bundle/packages/rln/dist/keystore/cipher.js +3 -3
  12. package/bundle/packages/rln/dist/keystore/keystore.js +12 -7
  13. package/bundle/packages/rln/dist/rln.js +56 -166
  14. package/bundle/packages/rln/dist/utils/bytes.js +8 -2
  15. package/bundle/packages/rln/dist/utils/metamask.js +2 -2
  16. package/bundle/packages/rln/dist/zerokit.js +5 -5
  17. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/checksum.js +3 -3
  18. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/cipher.js +4 -4
  19. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/class.js +7 -7
  20. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/functional.js +7 -7
  21. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/index.js +6 -6
  22. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/kdf.js +5 -5
  23. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/password.js +1 -1
  24. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/schema-validation-generated.js +1 -1
  25. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/schema-validation.js +2 -2
  26. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/lib/types.js +1 -1
  27. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/aes.js +3 -3
  28. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/pbkdf2.js +7 -7
  29. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/random.js +3 -3
  30. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/scrypt.js +3 -3
  31. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/sha256.js +3 -3
  32. package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/ethereum-cryptography/utils.js +7 -7
  33. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/_assert.js +1 -1
  34. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/_sha2.js +3 -3
  35. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/_u64.js +1 -1
  36. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/cryptoBrowser.js +1 -1
  37. package/bundle/packages/rln/node_modules/@noble/hashes/esm/_assert.js +43 -0
  38. package/bundle/packages/rln/node_modules/@noble/hashes/esm/_sha2.js +116 -0
  39. package/bundle/packages/rln/node_modules/@noble/hashes/esm/hmac.js +79 -0
  40. package/bundle/packages/rln/node_modules/@noble/hashes/esm/sha256.js +126 -0
  41. package/bundle/packages/rln/node_modules/@noble/hashes/esm/utils.js +43 -0
  42. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/hmac.js +3 -3
  43. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/pbkdf2.js +4 -4
  44. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/scrypt.js +5 -5
  45. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/sha256.js +3 -3
  46. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/sha512.js +4 -4
  47. package/bundle/{node_modules/@chainsafe/bls-keystore → packages/rln}/node_modules/@noble/hashes/utils.js +2 -2
  48. package/dist/.tsbuildinfo +1 -1
  49. package/dist/codec.test-utils.d.ts +36 -0
  50. package/dist/codec.test-utils.js +56 -0
  51. package/dist/codec.test-utils.js.map +1 -0
  52. package/dist/contract/abi.d.ts +21 -17
  53. package/dist/contract/abi.js +502 -248
  54. package/dist/contract/abi.js.map +1 -1
  55. package/dist/contract/constants.d.ts +22 -18
  56. package/dist/contract/constants.js +3 -3
  57. package/dist/contract/constants.js.map +1 -1
  58. package/dist/contract/index.d.ts +1 -0
  59. package/dist/contract/index.js +1 -0
  60. package/dist/contract/index.js.map +1 -1
  61. package/dist/contract/rln_base_contract.d.ts +90 -0
  62. package/dist/contract/rln_base_contract.js +466 -0
  63. package/dist/contract/rln_base_contract.js.map +1 -0
  64. package/dist/contract/rln_contract.d.ts +5 -115
  65. package/dist/contract/rln_contract.js +30 -355
  66. package/dist/contract/rln_contract.js.map +1 -1
  67. package/dist/contract/test-setup.d.ts +26 -0
  68. package/dist/contract/test-setup.js +56 -0
  69. package/dist/contract/test-setup.js.map +1 -0
  70. package/dist/contract/test-utils.d.ts +39 -0
  71. package/dist/contract/test-utils.js +118 -0
  72. package/dist/contract/test-utils.js.map +1 -0
  73. package/dist/contract/types.d.ts +45 -0
  74. package/dist/contract/types.js +8 -0
  75. package/dist/contract/types.js.map +1 -0
  76. package/dist/create.js +1 -1
  77. package/dist/create.js.map +1 -1
  78. package/dist/credentials_manager.d.ts +44 -0
  79. package/dist/credentials_manager.js +197 -0
  80. package/dist/credentials_manager.js.map +1 -0
  81. package/dist/index.d.ts +6 -2
  82. package/dist/index.js +5 -2
  83. package/dist/index.js.map +1 -1
  84. package/dist/keystore/keystore.js +11 -6
  85. package/dist/keystore/keystore.js.map +1 -1
  86. package/dist/keystore/types.d.ts +4 -3
  87. package/dist/rln.d.ts +9 -52
  88. package/dist/rln.js +54 -163
  89. package/dist/rln.js.map +1 -1
  90. package/dist/types.d.ts +27 -0
  91. package/dist/types.js +2 -0
  92. package/dist/types.js.map +1 -0
  93. package/dist/utils/bytes.js +8 -2
  94. package/dist/utils/bytes.js.map +1 -1
  95. package/dist/zerokit.d.ts +3 -3
  96. package/dist/zerokit.js +5 -5
  97. package/dist/zerokit.js.map +1 -1
  98. package/package.json +1 -91
  99. package/src/codec.test-utils.ts +80 -0
  100. package/src/contract/abi.ts +502 -248
  101. package/src/contract/constants.ts +3 -3
  102. package/src/contract/index.ts +1 -0
  103. package/src/contract/rln_base_contract.ts +712 -0
  104. package/src/contract/rln_contract.ts +37 -579
  105. package/src/contract/test-setup.ts +86 -0
  106. package/src/contract/test-utils.ts +179 -0
  107. package/src/contract/types.ts +53 -0
  108. package/src/create.ts +1 -1
  109. package/src/credentials_manager.ts +282 -0
  110. package/src/index.ts +19 -2
  111. package/src/keystore/keystore.ts +23 -12
  112. package/src/keystore/types.ts +4 -3
  113. package/src/rln.ts +67 -258
  114. package/src/types.ts +31 -0
  115. package/src/utils/bytes.ts +10 -2
  116. package/src/zerokit.ts +3 -3
  117. package/bundle/_virtual/__node-resolve_empty.js +0 -6
  118. package/bundle/_virtual/_node-resolve_empty.js +0 -3
  119. package/bundle/_virtual/bn.js +0 -3
  120. package/bundle/_virtual/common.js +0 -3
  121. package/bundle/_virtual/common2.js +0 -3
  122. package/bundle/_virtual/hash.js +0 -3
  123. package/bundle/_virtual/inherits_browser.js +0 -3
  124. package/bundle/_virtual/ripemd.js +0 -3
  125. package/bundle/_virtual/sha.js +0 -3
  126. package/bundle/_virtual/sha3.js +0 -3
  127. package/bundle/_virtual/utils3.js +0 -3
  128. package/bundle/node_modules/@ethersproject/abi/lib.esm/_version.js +0 -3
  129. package/bundle/node_modules/@ethersproject/abi/lib.esm/abi-coder.js +0 -96
  130. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/abstract-coder.js +0 -148
  131. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/address.js +0 -26
  132. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/anonymous.js +0 -20
  133. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/array.js +0 -210
  134. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/boolean.js +0 -18
  135. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/bytes.js +0 -30
  136. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/fixed-bytes.js +0 -26
  137. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/null.js +0 -22
  138. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/number.js +0 -43
  139. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/string.js +0 -19
  140. package/bundle/node_modules/@ethersproject/abi/lib.esm/coders/tuple.js +0 -58
  141. package/bundle/node_modules/@ethersproject/abi/lib.esm/fragments.js +0 -854
  142. package/bundle/node_modules/@ethersproject/abi/lib.esm/interface.js +0 -609
  143. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/_version.js +0 -3
  144. package/bundle/node_modules/@ethersproject/abstract-provider/lib.esm/index.js +0 -66
  145. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/_version.js +0 -3
  146. package/bundle/node_modules/@ethersproject/abstract-signer/lib.esm/index.js +0 -302
  147. package/bundle/node_modules/@ethersproject/address/lib.esm/_version.js +0 -3
  148. package/bundle/node_modules/@ethersproject/address/lib.esm/index.js +0 -110
  149. package/bundle/node_modules/@ethersproject/base64/lib.esm/base64.js +0 -20
  150. package/bundle/node_modules/@ethersproject/basex/lib.esm/index.js +0 -120
  151. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/_version.js +0 -3
  152. package/bundle/node_modules/@ethersproject/bignumber/lib.esm/bignumber.js +0 -287
  153. package/bundle/node_modules/@ethersproject/bytes/lib.esm/_version.js +0 -3
  154. package/bundle/node_modules/@ethersproject/bytes/lib.esm/index.js +0 -402
  155. package/bundle/node_modules/@ethersproject/constants/lib.esm/addresses.js +0 -3
  156. package/bundle/node_modules/@ethersproject/constants/lib.esm/bignumbers.js +0 -8
  157. package/bundle/node_modules/@ethersproject/constants/lib.esm/hashes.js +0 -3
  158. package/bundle/node_modules/@ethersproject/contracts/lib.esm/_version.js +0 -3
  159. package/bundle/node_modules/@ethersproject/contracts/lib.esm/index.js +0 -893
  160. package/bundle/node_modules/@ethersproject/hash/lib.esm/_version.js +0 -3
  161. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/decoder.js +0 -256
  162. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/include.js +0 -36
  163. package/bundle/node_modules/@ethersproject/hash/lib.esm/ens-normalize/lib.js +0 -135
  164. package/bundle/node_modules/@ethersproject/hash/lib.esm/id.js +0 -8
  165. package/bundle/node_modules/@ethersproject/hash/lib.esm/namehash.js +0 -64
  166. package/bundle/node_modules/@ethersproject/hash/lib.esm/typed-data.js +0 -443
  167. package/bundle/node_modules/@ethersproject/keccak256/lib.esm/index.js +0 -8
  168. package/bundle/node_modules/@ethersproject/logger/lib.esm/_version.js +0 -3
  169. package/bundle/node_modules/@ethersproject/logger/lib.esm/index.js +0 -352
  170. package/bundle/node_modules/@ethersproject/networks/lib.esm/_version.js +0 -3
  171. package/bundle/node_modules/@ethersproject/networks/lib.esm/index.js +0 -266
  172. package/bundle/node_modules/@ethersproject/properties/lib.esm/_version.js +0 -3
  173. package/bundle/node_modules/@ethersproject/properties/lib.esm/index.js +0 -127
  174. package/bundle/node_modules/@ethersproject/providers/lib.esm/_version.js +0 -3
  175. package/bundle/node_modules/@ethersproject/providers/lib.esm/base-provider.js +0 -2007
  176. package/bundle/node_modules/@ethersproject/providers/lib.esm/formatter.js +0 -422
  177. package/bundle/node_modules/@ethersproject/providers/lib.esm/json-rpc-provider.js +0 -674
  178. package/bundle/node_modules/@ethersproject/providers/lib.esm/web3-provider.js +0 -132
  179. package/bundle/node_modules/@ethersproject/rlp/lib.esm/_version.js +0 -3
  180. package/bundle/node_modules/@ethersproject/rlp/lib.esm/index.js +0 -120
  181. package/bundle/node_modules/@ethersproject/sha2/lib.esm/sha2.js +0 -8
  182. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/_version.js +0 -3
  183. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/elliptic.js +0 -2478
  184. package/bundle/node_modules/@ethersproject/signing-key/lib.esm/index.js +0 -76
  185. package/bundle/node_modules/@ethersproject/strings/lib.esm/_version.js +0 -3
  186. package/bundle/node_modules/@ethersproject/strings/lib.esm/utf8.js +0 -219
  187. package/bundle/node_modules/@ethersproject/transactions/lib.esm/_version.js +0 -3
  188. package/bundle/node_modules/@ethersproject/transactions/lib.esm/index.js +0 -279
  189. package/bundle/node_modules/@ethersproject/web/lib.esm/_version.js +0 -3
  190. package/bundle/node_modules/@ethersproject/web/lib.esm/geturl.js +0 -69
  191. package/bundle/node_modules/@ethersproject/web/lib.esm/index.js +0 -404
  192. package/bundle/node_modules/bech32/index.js +0 -187
  193. package/bundle/node_modules/bn.js/lib/bn.js +0 -3361
  194. package/bundle/node_modules/hash.js/lib/hash/common.js +0 -97
  195. package/bundle/node_modules/hash.js/lib/hash/hmac.js +0 -51
  196. package/bundle/node_modules/hash.js/lib/hash/ripemd.js +0 -152
  197. package/bundle/node_modules/hash.js/lib/hash/sha/1.js +0 -81
  198. package/bundle/node_modules/hash.js/lib/hash/sha/224.js +0 -33
  199. package/bundle/node_modules/hash.js/lib/hash/sha/256.js +0 -113
  200. package/bundle/node_modules/hash.js/lib/hash/sha/384.js +0 -39
  201. package/bundle/node_modules/hash.js/lib/hash/sha/512.js +0 -336
  202. package/bundle/node_modules/hash.js/lib/hash/sha/common.js +0 -53
  203. package/bundle/node_modules/hash.js/lib/hash/sha.js +0 -14
  204. package/bundle/node_modules/hash.js/lib/hash/utils.js +0 -282
  205. package/bundle/node_modules/hash.js/lib/hash.js +0 -33
  206. package/bundle/node_modules/inherits/inherits_browser.js +0 -33
  207. package/bundle/node_modules/js-sha3/src/sha3.js +0 -660
  208. package/bundle/node_modules/minimalistic-assert/index.js +0 -13
  209. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/index.js +0 -0
  210. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/md5.js +0 -0
  211. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/nil.js +0 -0
  212. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/parse.js +0 -0
  213. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/regex.js +0 -0
  214. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/rng.js +0 -0
  215. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/sha1.js +0 -0
  216. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/stringify.js +0 -0
  217. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v1.js +0 -0
  218. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v3.js +0 -0
  219. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v35.js +0 -0
  220. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v4.js +0 -0
  221. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/v5.js +0 -0
  222. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/validate.js +0 -0
  223. /package/bundle/{node_modules → packages/rln/node_modules}/@chainsafe/bls-keystore/node_modules/uuid/dist/esm-browser/version.js +0 -0
@@ -0,0 +1,712 @@
1
+ /* eslint-disable no-console */
2
+ import { Logger } from "@waku/utils";
3
+ import { ethers } from "ethers";
4
+
5
+ import { IdentityCredential } from "../identity.js";
6
+ import { DecryptedCredentials } from "../keystore/types.js";
7
+
8
+ import { RLN_ABI } from "./abi.js";
9
+ import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from "./constants.js";
10
+ import {
11
+ CustomQueryOptions,
12
+ FetchMembersOptions,
13
+ Member,
14
+ MembershipInfo,
15
+ MembershipRegisteredEvent,
16
+ MembershipState,
17
+ RLNContractInitOptions
18
+ } from "./types.js";
19
+
20
+ const log = new Logger("waku:rln:contract:base");
21
+
22
+ export class RLNBaseContract {
23
+ public contract: ethers.Contract;
24
+ private deployBlock: undefined | number;
25
+ private rateLimit: number;
26
+
27
+ protected _members: Map<number, Member> = new Map();
28
+ private _membersFilter: ethers.EventFilter;
29
+ private _membershipErasedFilter: ethers.EventFilter;
30
+ private _membersExpiredFilter: ethers.EventFilter;
31
+
32
+ /**
33
+ * Constructor for RLNBaseContract.
34
+ * Allows injecting a mocked contract for testing purposes.
35
+ */
36
+ public constructor(options: RLNContractInitOptions) {
37
+ const {
38
+ address,
39
+ signer,
40
+ rateLimit = DEFAULT_RATE_LIMIT,
41
+ contract
42
+ } = options;
43
+
44
+ log.info("Initializing RLNBaseContract", { address, rateLimit });
45
+
46
+ this.contract = contract || new ethers.Contract(address, RLN_ABI, signer);
47
+ this.rateLimit = rateLimit;
48
+
49
+ try {
50
+ log.info("Setting up event filters");
51
+ // Initialize event filters
52
+ this._membersFilter = this.contract.filters.MembershipRegistered();
53
+ this._membershipErasedFilter = this.contract.filters.MembershipErased();
54
+ this._membersExpiredFilter = this.contract.filters.MembershipExpired();
55
+ log.info("Event filters initialized successfully");
56
+ } catch (error) {
57
+ log.error("Failed to initialize event filters", { error });
58
+ throw new Error(
59
+ "Failed to initialize event filters: " + (error as Error).message
60
+ );
61
+ }
62
+
63
+ // Initialize members and subscriptions
64
+ this.fetchMembers()
65
+ .then(() => {
66
+ this.subscribeToMembers();
67
+ })
68
+ .catch((error) => {
69
+ log.error("Failed to initialize members", { error });
70
+ });
71
+
72
+ // Validate rate limit asynchronously
73
+ this.validateRateLimit(rateLimit).catch((error) => {
74
+ log.error("Failed to validate initial rate limit", { error });
75
+ });
76
+ }
77
+
78
+ /**
79
+ * Gets the current rate limit for this contract instance
80
+ */
81
+ public getRateLimit(): number {
82
+ return this.rateLimit;
83
+ }
84
+
85
+ /**
86
+ * Gets the contract address
87
+ */
88
+ public get address(): string {
89
+ return this.contract.address;
90
+ }
91
+
92
+ /**
93
+ * Gets the contract provider
94
+ */
95
+ public get provider(): ethers.providers.Provider {
96
+ return this.contract.provider;
97
+ }
98
+
99
+ /**
100
+ * Gets the minimum allowed rate limit from the contract
101
+ * @returns Promise<number> The minimum rate limit in messages per epoch
102
+ */
103
+ public async getMinRateLimit(): Promise<number> {
104
+ const minRate = await this.contract.minMembershipRateLimit();
105
+ return ethers.BigNumber.from(minRate).toNumber();
106
+ }
107
+
108
+ /**
109
+ * Gets the maximum allowed rate limit from the contract
110
+ * @returns Promise<number> The maximum rate limit in messages per epoch
111
+ */
112
+ public async getMaxRateLimit(): Promise<number> {
113
+ const maxRate = await this.contract.maxMembershipRateLimit();
114
+ return ethers.BigNumber.from(maxRate).toNumber();
115
+ }
116
+
117
+ /**
118
+ * Gets the maximum total rate limit across all memberships
119
+ * @returns Promise<number> The maximum total rate limit in messages per epoch
120
+ */
121
+ public async getMaxTotalRateLimit(): Promise<number> {
122
+ const maxTotalRate = await this.contract.maxTotalRateLimit();
123
+ return maxTotalRate.toNumber();
124
+ }
125
+
126
+ /**
127
+ * Gets the current total rate limit usage across all memberships
128
+ * @returns Promise<number> The current total rate limit usage in messages per epoch
129
+ */
130
+ public async getCurrentTotalRateLimit(): Promise<number> {
131
+ const currentTotal = await this.contract.currentTotalRateLimit();
132
+ return currentTotal.toNumber();
133
+ }
134
+
135
+ /**
136
+ * Gets the remaining available total rate limit that can be allocated
137
+ * @returns Promise<number> The remaining rate limit that can be allocated
138
+ */
139
+ public async getRemainingTotalRateLimit(): Promise<number> {
140
+ const [maxTotal, currentTotal] = await Promise.all([
141
+ this.contract.maxTotalRateLimit(),
142
+ this.contract.currentTotalRateLimit()
143
+ ]);
144
+ return Number(maxTotal) - Number(currentTotal);
145
+ }
146
+
147
+ /**
148
+ * Updates the rate limit for future registrations
149
+ * @param newRateLimit The new rate limit to use
150
+ */
151
+ public async setRateLimit(newRateLimit: number): Promise<void> {
152
+ await this.validateRateLimit(newRateLimit);
153
+ this.rateLimit = newRateLimit;
154
+ }
155
+
156
+ public get members(): Member[] {
157
+ const sortedMembers = Array.from(this._members.values()).sort(
158
+ (left, right) => left.index.toNumber() - right.index.toNumber()
159
+ );
160
+ return sortedMembers;
161
+ }
162
+
163
+ public async fetchMembers(options: FetchMembersOptions = {}): Promise<void> {
164
+ const registeredMemberEvents = await RLNBaseContract.queryFilter(
165
+ this.contract,
166
+ {
167
+ fromBlock: this.deployBlock,
168
+ ...options,
169
+ membersFilter: this.membersFilter
170
+ }
171
+ );
172
+ const removedMemberEvents = await RLNBaseContract.queryFilter(
173
+ this.contract,
174
+ {
175
+ fromBlock: this.deployBlock,
176
+ ...options,
177
+ membersFilter: this.membershipErasedFilter
178
+ }
179
+ );
180
+ const expiredMemberEvents = await RLNBaseContract.queryFilter(
181
+ this.contract,
182
+ {
183
+ fromBlock: this.deployBlock,
184
+ ...options,
185
+ membersFilter: this.membersExpiredFilter
186
+ }
187
+ );
188
+
189
+ const events = [
190
+ ...registeredMemberEvents,
191
+ ...removedMemberEvents,
192
+ ...expiredMemberEvents
193
+ ];
194
+ this.processEvents(events);
195
+ }
196
+
197
+ public static async queryFilter(
198
+ contract: ethers.Contract,
199
+ options: CustomQueryOptions
200
+ ): Promise<ethers.Event[]> {
201
+ const FETCH_CHUNK = 5;
202
+ const BLOCK_RANGE = 3000;
203
+
204
+ const {
205
+ fromBlock,
206
+ membersFilter,
207
+ fetchRange = BLOCK_RANGE,
208
+ fetchChunks = FETCH_CHUNK
209
+ } = options;
210
+
211
+ if (fromBlock === undefined) {
212
+ return contract.queryFilter(membersFilter);
213
+ }
214
+
215
+ if (!contract.provider) {
216
+ throw Error("No provider found on the contract.");
217
+ }
218
+
219
+ const toBlock = await contract.provider.getBlockNumber();
220
+
221
+ if (toBlock - fromBlock < fetchRange) {
222
+ return contract.queryFilter(membersFilter, fromBlock, toBlock);
223
+ }
224
+
225
+ const events: ethers.Event[][] = [];
226
+ const chunks = RLNBaseContract.splitToChunks(
227
+ fromBlock,
228
+ toBlock,
229
+ fetchRange
230
+ );
231
+
232
+ for (const portion of RLNBaseContract.takeN<[number, number]>(
233
+ chunks,
234
+ fetchChunks
235
+ )) {
236
+ const promises = portion.map(([left, right]) =>
237
+ RLNBaseContract.ignoreErrors(
238
+ contract.queryFilter(membersFilter, left, right),
239
+ []
240
+ )
241
+ );
242
+ const fetchedEvents = await Promise.all(promises);
243
+ events.push(fetchedEvents.flatMap((v) => v));
244
+ }
245
+
246
+ return events.flatMap((v) => v);
247
+ }
248
+
249
+ public processEvents(events: ethers.Event[]): void {
250
+ const toRemoveTable = new Map<number, number[]>();
251
+ const toInsertTable = new Map<number, ethers.Event[]>();
252
+
253
+ events.forEach((evt) => {
254
+ if (!evt.args) {
255
+ return;
256
+ }
257
+
258
+ if (
259
+ evt.event === "MembershipErased" ||
260
+ evt.event === "MembershipExpired"
261
+ ) {
262
+ let index = evt.args.index;
263
+
264
+ if (!index) {
265
+ return;
266
+ }
267
+
268
+ if (typeof index === "number" || typeof index === "string") {
269
+ index = ethers.BigNumber.from(index);
270
+ }
271
+
272
+ const toRemoveVal = toRemoveTable.get(evt.blockNumber);
273
+ if (toRemoveVal != undefined) {
274
+ toRemoveVal.push(index.toNumber());
275
+ toRemoveTable.set(evt.blockNumber, toRemoveVal);
276
+ } else {
277
+ toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
278
+ }
279
+ } else if (evt.event === "MembershipRegistered") {
280
+ let eventsPerBlock = toInsertTable.get(evt.blockNumber);
281
+ if (eventsPerBlock == undefined) {
282
+ eventsPerBlock = [];
283
+ }
284
+
285
+ eventsPerBlock.push(evt);
286
+ toInsertTable.set(evt.blockNumber, eventsPerBlock);
287
+ }
288
+ });
289
+ }
290
+
291
+ public static splitToChunks(
292
+ from: number,
293
+ to: number,
294
+ step: number
295
+ ): Array<[number, number]> {
296
+ const chunks: Array<[number, number]> = [];
297
+
298
+ let left = from;
299
+ while (left < to) {
300
+ const right = left + step < to ? left + step : to;
301
+
302
+ chunks.push([left, right] as [number, number]);
303
+
304
+ left = right;
305
+ }
306
+
307
+ return chunks;
308
+ }
309
+
310
+ public static *takeN<T>(array: T[], size: number): Iterable<T[]> {
311
+ let start = 0;
312
+
313
+ while (start < array.length) {
314
+ const portion = array.slice(start, start + size);
315
+
316
+ yield portion;
317
+
318
+ start += size;
319
+ }
320
+ }
321
+
322
+ public static async ignoreErrors<T>(
323
+ promise: Promise<T>,
324
+ defaultValue: T
325
+ ): Promise<T> {
326
+ try {
327
+ return await promise;
328
+ } catch (err: unknown) {
329
+ if (err instanceof Error) {
330
+ log.info(`Ignoring an error during query: ${err.message}`);
331
+ } else {
332
+ log.info(`Ignoring an unknown error during query`);
333
+ }
334
+ return defaultValue;
335
+ }
336
+ }
337
+
338
+ public subscribeToMembers(): void {
339
+ this.contract.on(
340
+ this.membersFilter,
341
+ (
342
+ _idCommitment: bigint,
343
+ _membershipRateLimit: ethers.BigNumber,
344
+ _index: ethers.BigNumber,
345
+ event: ethers.Event
346
+ ) => {
347
+ this.processEvents([event]);
348
+ }
349
+ );
350
+
351
+ this.contract.on(
352
+ this.membershipErasedFilter,
353
+ (
354
+ _idCommitment: bigint,
355
+ _membershipRateLimit: ethers.BigNumber,
356
+ _index: ethers.BigNumber,
357
+ event: ethers.Event
358
+ ) => {
359
+ this.processEvents([event]);
360
+ }
361
+ );
362
+
363
+ this.contract.on(
364
+ this.membersExpiredFilter,
365
+ (
366
+ _idCommitment: bigint,
367
+ _membershipRateLimit: ethers.BigNumber,
368
+ _index: ethers.BigNumber,
369
+ event: ethers.Event
370
+ ) => {
371
+ this.processEvents([event]);
372
+ }
373
+ );
374
+ }
375
+
376
+ public async getMembershipInfo(
377
+ idCommitmentBigInt: bigint
378
+ ): Promise<MembershipInfo | undefined> {
379
+ try {
380
+ const membershipData =
381
+ await this.contract.memberships(idCommitmentBigInt);
382
+ const currentBlock = await this.contract.provider.getBlockNumber();
383
+ console.log("membershipData", membershipData);
384
+
385
+ const [
386
+ depositAmount,
387
+ activeDuration,
388
+ gracePeriodStartTimestamp,
389
+ gracePeriodDuration,
390
+ rateLimit,
391
+ index,
392
+ holder,
393
+ token
394
+ ] = membershipData;
395
+
396
+ const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
397
+
398
+ let state: MembershipState;
399
+ if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
400
+ state = MembershipState.Active;
401
+ } else if (currentBlock < gracePeriodEnd.toNumber()) {
402
+ state = MembershipState.GracePeriod;
403
+ } else {
404
+ state = MembershipState.Expired;
405
+ }
406
+
407
+ return {
408
+ index,
409
+ idCommitment: idCommitmentBigInt.toString(),
410
+ rateLimit: Number(rateLimit),
411
+ startBlock: gracePeriodStartTimestamp.toNumber(),
412
+ endBlock: gracePeriodEnd.toNumber(),
413
+ state,
414
+ depositAmount,
415
+ activeDuration,
416
+ gracePeriodDuration,
417
+ holder,
418
+ token
419
+ };
420
+ } catch (error) {
421
+ log.error("Error in getMembershipInfo:", error);
422
+ return undefined;
423
+ }
424
+ }
425
+
426
+ public async extendMembership(
427
+ idCommitmentBigInt: bigint
428
+ ): Promise<ethers.ContractTransaction> {
429
+ const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
430
+ await tx.wait();
431
+ return tx;
432
+ }
433
+
434
+ public async eraseMembership(
435
+ idCommitmentBigInt: bigint,
436
+ eraseFromMembershipSet: boolean = true
437
+ ): Promise<ethers.ContractTransaction> {
438
+ console.log(Object.keys(this.contract));
439
+ const tx = await this.contract.eraseMemberships(
440
+ [idCommitmentBigInt],
441
+ eraseFromMembershipSet
442
+ );
443
+ await tx.wait();
444
+ return tx;
445
+ }
446
+
447
+ public async withdraw(token: string, from: string): Promise<void> {
448
+ try {
449
+ const tx = await this.contract.withdraw(token, from);
450
+ await tx.wait();
451
+ } catch (error) {
452
+ log.error(`Error in withdraw: ${(error as Error).message}`);
453
+ }
454
+ }
455
+
456
+ public async registerMembership(
457
+ idCommitmentBigInt: bigint,
458
+ rateLimit: number = DEFAULT_RATE_LIMIT
459
+ ): Promise<ethers.ContractTransaction> {
460
+ if (
461
+ rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
462
+ rateLimit > RATE_LIMIT_PARAMS.MAX_RATE
463
+ ) {
464
+ throw new Error(
465
+ `Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`
466
+ );
467
+ }
468
+ return this.contract.register(idCommitmentBigInt, rateLimit, []);
469
+ }
470
+
471
+ public async registerWithIdentity(
472
+ identity: IdentityCredential
473
+ ): Promise<DecryptedCredentials | undefined> {
474
+ try {
475
+ log.info(
476
+ `Registering identity with rate limit: ${this.rateLimit} messages/epoch`
477
+ );
478
+
479
+ // Check if the ID commitment is already registered
480
+ const existingIndex = await this.getMemberIndex(
481
+ identity.IDCommitmentBigInt
482
+ );
483
+ if (existingIndex) {
484
+ throw new Error(
485
+ `ID commitment is already registered with index ${existingIndex}`
486
+ );
487
+ }
488
+
489
+ // Check if there's enough remaining rate limit
490
+ const remainingRateLimit = await this.getRemainingTotalRateLimit();
491
+ if (remainingRateLimit < this.rateLimit) {
492
+ throw new Error(
493
+ `Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`
494
+ );
495
+ }
496
+
497
+ const estimatedGas = await this.contract.estimateGas.register(
498
+ identity.IDCommitmentBigInt,
499
+ this.rateLimit,
500
+ []
501
+ );
502
+ const gasLimit = estimatedGas.add(10000);
503
+
504
+ const txRegisterResponse: ethers.ContractTransaction =
505
+ await this.contract.register(
506
+ identity.IDCommitmentBigInt,
507
+ this.rateLimit,
508
+ [],
509
+ { gasLimit }
510
+ );
511
+
512
+ const txRegisterReceipt = await txRegisterResponse.wait();
513
+
514
+ if (txRegisterReceipt.status === 0) {
515
+ throw new Error("Transaction failed on-chain");
516
+ }
517
+
518
+ const memberRegistered = txRegisterReceipt.events?.find(
519
+ (event: ethers.Event) => event.event === "MembershipRegistered"
520
+ );
521
+
522
+ if (!memberRegistered || !memberRegistered.args) {
523
+ log.error(
524
+ "Failed to register membership: No MembershipRegistered event found"
525
+ );
526
+ return undefined;
527
+ }
528
+
529
+ const decodedData: MembershipRegisteredEvent = {
530
+ idCommitment: memberRegistered.args.idCommitment,
531
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
532
+ index: memberRegistered.args.index
533
+ };
534
+
535
+ log.info(
536
+ `Successfully registered membership with index ${decodedData.index} ` +
537
+ `and rate limit ${decodedData.membershipRateLimit}`
538
+ );
539
+
540
+ const network = await this.contract.provider.getNetwork();
541
+ const address = this.contract.address;
542
+ const membershipId = Number(decodedData.index);
543
+
544
+ return {
545
+ identity,
546
+ membership: {
547
+ address,
548
+ treeIndex: membershipId,
549
+ chainId: network.chainId.toString(),
550
+ rateLimit: decodedData.membershipRateLimit.toNumber()
551
+ }
552
+ };
553
+ } catch (error) {
554
+ if (error instanceof Error) {
555
+ const errorMessage = error.message;
556
+ log.error("registerWithIdentity - error message:", errorMessage);
557
+ log.error("registerWithIdentity - error stack:", error.stack);
558
+
559
+ // Try to extract more specific error information
560
+ if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
561
+ throw new Error(
562
+ "Registration failed: Cannot exceed maximum total rate limit"
563
+ );
564
+ } else if (errorMessage.includes("InvalidIdCommitment")) {
565
+ throw new Error("Registration failed: Invalid ID commitment");
566
+ } else if (errorMessage.includes("InvalidMembershipRateLimit")) {
567
+ throw new Error("Registration failed: Invalid membership rate limit");
568
+ } else if (errorMessage.includes("execution reverted")) {
569
+ throw new Error(
570
+ "Contract execution reverted. Check contract requirements."
571
+ );
572
+ } else {
573
+ throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
574
+ }
575
+ } else {
576
+ throw new Error("Unknown error in registerWithIdentity", {
577
+ cause: error
578
+ });
579
+ }
580
+ }
581
+ }
582
+
583
+ public async registerWithPermitAndErase(
584
+ identity: IdentityCredential,
585
+ permit: {
586
+ owner: string;
587
+ deadline: number;
588
+ v: number;
589
+ r: string;
590
+ s: string;
591
+ },
592
+ idCommitmentsToErase: string[]
593
+ ): Promise<DecryptedCredentials | undefined> {
594
+ try {
595
+ log.info(
596
+ `Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`
597
+ );
598
+
599
+ const txRegisterResponse: ethers.ContractTransaction =
600
+ await this.contract.registerWithPermit(
601
+ permit.owner,
602
+ permit.deadline,
603
+ permit.v,
604
+ permit.r,
605
+ permit.s,
606
+ identity.IDCommitmentBigInt,
607
+ this.rateLimit,
608
+ idCommitmentsToErase.map((id) => ethers.BigNumber.from(id))
609
+ );
610
+ const txRegisterReceipt = await txRegisterResponse.wait();
611
+
612
+ const memberRegistered = txRegisterReceipt.events?.find(
613
+ (event: ethers.Event) => event.event === "MembershipRegistered"
614
+ );
615
+
616
+ if (!memberRegistered || !memberRegistered.args) {
617
+ log.error(
618
+ "Failed to register membership with permit: No MembershipRegistered event found"
619
+ );
620
+ return undefined;
621
+ }
622
+
623
+ const decodedData: MembershipRegisteredEvent = {
624
+ idCommitment: memberRegistered.args.idCommitment,
625
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
626
+ index: memberRegistered.args.index
627
+ };
628
+
629
+ log.info(
630
+ `Successfully registered membership with permit. Index: ${decodedData.index}, ` +
631
+ `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`
632
+ );
633
+
634
+ const network = await this.contract.provider.getNetwork();
635
+ const address = this.contract.address;
636
+ const membershipId = Number(decodedData.index);
637
+
638
+ return {
639
+ identity,
640
+ membership: {
641
+ address,
642
+ treeIndex: membershipId,
643
+ chainId: network.chainId.toString(),
644
+ rateLimit: decodedData.membershipRateLimit.toNumber()
645
+ }
646
+ };
647
+ } catch (error) {
648
+ log.error(
649
+ `Error in registerWithPermitAndErase: ${(error as Error).message}`
650
+ );
651
+ return undefined;
652
+ }
653
+ }
654
+
655
+ /**
656
+ * Validates that the rate limit is within the allowed range
657
+ * @throws Error if the rate limit is outside the allowed range
658
+ */
659
+ private async validateRateLimit(rateLimit: number): Promise<void> {
660
+ const [minRate, maxRate] = await Promise.all([
661
+ this.contract.minMembershipRateLimit(),
662
+ this.contract.maxMembershipRateLimit()
663
+ ]);
664
+
665
+ const minRateNum = ethers.BigNumber.from(minRate).toNumber();
666
+ const maxRateNum = ethers.BigNumber.from(maxRate).toNumber();
667
+
668
+ if (rateLimit < minRateNum || rateLimit > maxRateNum) {
669
+ throw new Error(
670
+ `Rate limit must be between ${minRateNum} and ${maxRateNum} messages per epoch`
671
+ );
672
+ }
673
+ }
674
+
675
+ private get membersFilter(): ethers.EventFilter {
676
+ if (!this._membersFilter) {
677
+ throw Error("Members filter was not initialized.");
678
+ }
679
+ return this._membersFilter;
680
+ }
681
+
682
+ private get membershipErasedFilter(): ethers.EventFilter {
683
+ if (!this._membershipErasedFilter) {
684
+ throw Error("MembershipErased filter was not initialized.");
685
+ }
686
+ return this._membershipErasedFilter;
687
+ }
688
+
689
+ private get membersExpiredFilter(): ethers.EventFilter {
690
+ if (!this._membersExpiredFilter) {
691
+ throw Error("MembersExpired filter was not initialized.");
692
+ }
693
+ return this._membersExpiredFilter;
694
+ }
695
+
696
+ private async getMemberIndex(
697
+ idCommitmentBigInt: bigint
698
+ ): Promise<ethers.BigNumber | undefined> {
699
+ try {
700
+ const events = await this.contract.queryFilter(
701
+ this.contract.filters.MembershipRegistered(idCommitmentBigInt)
702
+ );
703
+ if (events.length === 0) return undefined;
704
+
705
+ // Get the most recent registration event
706
+ const event = events[events.length - 1];
707
+ return event.args?.index;
708
+ } catch (error) {
709
+ return undefined;
710
+ }
711
+ }
712
+ }