@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
@@ -1,8 +1,8 @@
1
1
  import { RLN_ABI } from './abi.js';
2
2
 
3
- const SEPOLIA_CONTRACT = {
4
- chainId: 11155111,
5
- address: "0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3",
3
+ const LINEA_CONTRACT = {
4
+ chainId: 59141,
5
+ address: "0xb9cd878c90e49f797b4431fbf4fb333108cb90e6",
6
6
  abi: RLN_ABI
7
7
  };
8
8
  /**
@@ -12,6 +12,7 @@ const SEPOLIA_CONTRACT = {
12
12
  */
13
13
  const RATE_LIMIT_TIERS = {
14
14
  LOW: 20, // Suggested minimum rate - 20 messages per epoch
15
+ MEDIUM: 200,
15
16
  HIGH: 600 // Suggested maximum rate - 600 messages per epoch
16
17
  };
17
18
  // Global rate limit parameters
@@ -23,4 +24,4 @@ const RATE_LIMIT_PARAMS = {
23
24
  };
24
25
  const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
25
26
 
26
- export { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS, SEPOLIA_CONTRACT };
27
+ export { DEFAULT_RATE_LIMIT, LINEA_CONTRACT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS };
@@ -0,0 +1,483 @@
1
+ import '../../../interfaces/dist/protocols.js';
2
+ import '../../../interfaces/dist/connection_manager.js';
3
+ import '../../../interfaces/dist/health_indicator.js';
4
+ import '../../../../node_modules/multiformats/dist/src/bases/base10.js';
5
+ import '../../../../node_modules/multiformats/dist/src/bases/base16.js';
6
+ import '../../../../node_modules/multiformats/dist/src/bases/base2.js';
7
+ import '../../../../node_modules/multiformats/dist/src/bases/base256emoji.js';
8
+ import '../../../../node_modules/multiformats/dist/src/bases/base32.js';
9
+ import '../../../../node_modules/multiformats/dist/src/bases/base36.js';
10
+ import '../../../../node_modules/multiformats/dist/src/bases/base58.js';
11
+ import '../../../../node_modules/multiformats/dist/src/bases/base64.js';
12
+ import '../../../../node_modules/multiformats/dist/src/bases/base8.js';
13
+ import '../../../../node_modules/multiformats/dist/src/bases/identity.js';
14
+ import '../../../../node_modules/multiformats/dist/src/codecs/json.js';
15
+ import { Logger } from '../../../utils/dist/logger/index.js';
16
+ import { RLN_ABI } from './abi.js';
17
+ import { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS } from './constants.js';
18
+ import { MembershipState } from './types.js';
19
+ import { Contract } from '@ethersproject/contracts';
20
+ import { BigNumber } from '@ethersproject/bignumber';
21
+
22
+ /* eslint-disable no-console */
23
+ const log = new Logger("waku:rln:contract:base");
24
+ class RLNBaseContract {
25
+ contract;
26
+ deployBlock;
27
+ rateLimit;
28
+ _members = new Map();
29
+ _membersFilter;
30
+ _membershipErasedFilter;
31
+ _membersExpiredFilter;
32
+ /**
33
+ * Constructor for RLNBaseContract.
34
+ * Allows injecting a mocked contract for testing purposes.
35
+ */
36
+ constructor(options) {
37
+ const { address, signer, rateLimit = DEFAULT_RATE_LIMIT, contract } = options;
38
+ log.info("Initializing RLNBaseContract", { address, rateLimit });
39
+ this.contract = contract || new Contract(address, RLN_ABI, signer);
40
+ this.rateLimit = rateLimit;
41
+ try {
42
+ log.info("Setting up event filters");
43
+ // Initialize event filters
44
+ this._membersFilter = this.contract.filters.MembershipRegistered();
45
+ this._membershipErasedFilter = this.contract.filters.MembershipErased();
46
+ this._membersExpiredFilter = this.contract.filters.MembershipExpired();
47
+ log.info("Event filters initialized successfully");
48
+ }
49
+ catch (error) {
50
+ log.error("Failed to initialize event filters", { error });
51
+ throw new Error("Failed to initialize event filters: " + error.message);
52
+ }
53
+ // Initialize members and subscriptions
54
+ this.fetchMembers()
55
+ .then(() => {
56
+ this.subscribeToMembers();
57
+ })
58
+ .catch((error) => {
59
+ log.error("Failed to initialize members", { error });
60
+ });
61
+ // Validate rate limit asynchronously
62
+ this.validateRateLimit(rateLimit).catch((error) => {
63
+ log.error("Failed to validate initial rate limit", { error });
64
+ });
65
+ }
66
+ /**
67
+ * Gets the current rate limit for this contract instance
68
+ */
69
+ getRateLimit() {
70
+ return this.rateLimit;
71
+ }
72
+ /**
73
+ * Gets the contract address
74
+ */
75
+ get address() {
76
+ return this.contract.address;
77
+ }
78
+ /**
79
+ * Gets the contract provider
80
+ */
81
+ get provider() {
82
+ return this.contract.provider;
83
+ }
84
+ /**
85
+ * Gets the minimum allowed rate limit from the contract
86
+ * @returns Promise<number> The minimum rate limit in messages per epoch
87
+ */
88
+ async getMinRateLimit() {
89
+ const minRate = await this.contract.minMembershipRateLimit();
90
+ return BigNumber.from(minRate).toNumber();
91
+ }
92
+ /**
93
+ * Gets the maximum allowed rate limit from the contract
94
+ * @returns Promise<number> The maximum rate limit in messages per epoch
95
+ */
96
+ async getMaxRateLimit() {
97
+ const maxRate = await this.contract.maxMembershipRateLimit();
98
+ return BigNumber.from(maxRate).toNumber();
99
+ }
100
+ /**
101
+ * Gets the maximum total rate limit across all memberships
102
+ * @returns Promise<number> The maximum total rate limit in messages per epoch
103
+ */
104
+ async getMaxTotalRateLimit() {
105
+ const maxTotalRate = await this.contract.maxTotalRateLimit();
106
+ return maxTotalRate.toNumber();
107
+ }
108
+ /**
109
+ * Gets the current total rate limit usage across all memberships
110
+ * @returns Promise<number> The current total rate limit usage in messages per epoch
111
+ */
112
+ async getCurrentTotalRateLimit() {
113
+ const currentTotal = await this.contract.currentTotalRateLimit();
114
+ return currentTotal.toNumber();
115
+ }
116
+ /**
117
+ * Gets the remaining available total rate limit that can be allocated
118
+ * @returns Promise<number> The remaining rate limit that can be allocated
119
+ */
120
+ async getRemainingTotalRateLimit() {
121
+ const [maxTotal, currentTotal] = await Promise.all([
122
+ this.contract.maxTotalRateLimit(),
123
+ this.contract.currentTotalRateLimit()
124
+ ]);
125
+ return Number(maxTotal) - Number(currentTotal);
126
+ }
127
+ /**
128
+ * Updates the rate limit for future registrations
129
+ * @param newRateLimit The new rate limit to use
130
+ */
131
+ async setRateLimit(newRateLimit) {
132
+ await this.validateRateLimit(newRateLimit);
133
+ this.rateLimit = newRateLimit;
134
+ }
135
+ get members() {
136
+ const sortedMembers = Array.from(this._members.values()).sort((left, right) => left.index.toNumber() - right.index.toNumber());
137
+ return sortedMembers;
138
+ }
139
+ async fetchMembers(options = {}) {
140
+ const registeredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
141
+ fromBlock: this.deployBlock,
142
+ ...options,
143
+ membersFilter: this.membersFilter
144
+ });
145
+ const removedMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
146
+ fromBlock: this.deployBlock,
147
+ ...options,
148
+ membersFilter: this.membershipErasedFilter
149
+ });
150
+ const expiredMemberEvents = await RLNBaseContract.queryFilter(this.contract, {
151
+ fromBlock: this.deployBlock,
152
+ ...options,
153
+ membersFilter: this.membersExpiredFilter
154
+ });
155
+ const events = [
156
+ ...registeredMemberEvents,
157
+ ...removedMemberEvents,
158
+ ...expiredMemberEvents
159
+ ];
160
+ this.processEvents(events);
161
+ }
162
+ static async queryFilter(contract, options) {
163
+ const FETCH_CHUNK = 5;
164
+ const BLOCK_RANGE = 3000;
165
+ const { fromBlock, membersFilter, fetchRange = BLOCK_RANGE, fetchChunks = FETCH_CHUNK } = options;
166
+ if (fromBlock === undefined) {
167
+ return contract.queryFilter(membersFilter);
168
+ }
169
+ if (!contract.provider) {
170
+ throw Error("No provider found on the contract.");
171
+ }
172
+ const toBlock = await contract.provider.getBlockNumber();
173
+ if (toBlock - fromBlock < fetchRange) {
174
+ return contract.queryFilter(membersFilter, fromBlock, toBlock);
175
+ }
176
+ const events = [];
177
+ const chunks = RLNBaseContract.splitToChunks(fromBlock, toBlock, fetchRange);
178
+ for (const portion of RLNBaseContract.takeN(chunks, fetchChunks)) {
179
+ const promises = portion.map(([left, right]) => RLNBaseContract.ignoreErrors(contract.queryFilter(membersFilter, left, right), []));
180
+ const fetchedEvents = await Promise.all(promises);
181
+ events.push(fetchedEvents.flatMap((v) => v));
182
+ }
183
+ return events.flatMap((v) => v);
184
+ }
185
+ processEvents(events) {
186
+ const toRemoveTable = new Map();
187
+ const toInsertTable = new Map();
188
+ events.forEach((evt) => {
189
+ if (!evt.args) {
190
+ return;
191
+ }
192
+ if (evt.event === "MembershipErased" ||
193
+ evt.event === "MembershipExpired") {
194
+ let index = evt.args.index;
195
+ if (!index) {
196
+ return;
197
+ }
198
+ if (typeof index === "number" || typeof index === "string") {
199
+ index = BigNumber.from(index);
200
+ }
201
+ const toRemoveVal = toRemoveTable.get(evt.blockNumber);
202
+ if (toRemoveVal != undefined) {
203
+ toRemoveVal.push(index.toNumber());
204
+ toRemoveTable.set(evt.blockNumber, toRemoveVal);
205
+ }
206
+ else {
207
+ toRemoveTable.set(evt.blockNumber, [index.toNumber()]);
208
+ }
209
+ }
210
+ else if (evt.event === "MembershipRegistered") {
211
+ let eventsPerBlock = toInsertTable.get(evt.blockNumber);
212
+ if (eventsPerBlock == undefined) {
213
+ eventsPerBlock = [];
214
+ }
215
+ eventsPerBlock.push(evt);
216
+ toInsertTable.set(evt.blockNumber, eventsPerBlock);
217
+ }
218
+ });
219
+ }
220
+ static splitToChunks(from, to, step) {
221
+ const chunks = [];
222
+ let left = from;
223
+ while (left < to) {
224
+ const right = left + step < to ? left + step : to;
225
+ chunks.push([left, right]);
226
+ left = right;
227
+ }
228
+ return chunks;
229
+ }
230
+ static *takeN(array, size) {
231
+ let start = 0;
232
+ while (start < array.length) {
233
+ const portion = array.slice(start, start + size);
234
+ yield portion;
235
+ start += size;
236
+ }
237
+ }
238
+ static async ignoreErrors(promise, defaultValue) {
239
+ try {
240
+ return await promise;
241
+ }
242
+ catch (err) {
243
+ if (err instanceof Error) {
244
+ log.info(`Ignoring an error during query: ${err.message}`);
245
+ }
246
+ else {
247
+ log.info(`Ignoring an unknown error during query`);
248
+ }
249
+ return defaultValue;
250
+ }
251
+ }
252
+ subscribeToMembers() {
253
+ this.contract.on(this.membersFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
254
+ this.processEvents([event]);
255
+ });
256
+ this.contract.on(this.membershipErasedFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
257
+ this.processEvents([event]);
258
+ });
259
+ this.contract.on(this.membersExpiredFilter, (_idCommitment, _membershipRateLimit, _index, event) => {
260
+ this.processEvents([event]);
261
+ });
262
+ }
263
+ async getMembershipInfo(idCommitmentBigInt) {
264
+ try {
265
+ const membershipData = await this.contract.memberships(idCommitmentBigInt);
266
+ const currentBlock = await this.contract.provider.getBlockNumber();
267
+ console.log("membershipData", membershipData);
268
+ const [depositAmount, activeDuration, gracePeriodStartTimestamp, gracePeriodDuration, rateLimit, index, holder, token] = membershipData;
269
+ const gracePeriodEnd = gracePeriodStartTimestamp.add(gracePeriodDuration);
270
+ let state;
271
+ if (currentBlock < gracePeriodStartTimestamp.toNumber()) {
272
+ state = MembershipState.Active;
273
+ }
274
+ else if (currentBlock < gracePeriodEnd.toNumber()) {
275
+ state = MembershipState.GracePeriod;
276
+ }
277
+ else {
278
+ state = MembershipState.Expired;
279
+ }
280
+ return {
281
+ index,
282
+ idCommitment: idCommitmentBigInt.toString(),
283
+ rateLimit: Number(rateLimit),
284
+ startBlock: gracePeriodStartTimestamp.toNumber(),
285
+ endBlock: gracePeriodEnd.toNumber(),
286
+ state,
287
+ depositAmount,
288
+ activeDuration,
289
+ gracePeriodDuration,
290
+ holder,
291
+ token
292
+ };
293
+ }
294
+ catch (error) {
295
+ log.error("Error in getMembershipInfo:", error);
296
+ return undefined;
297
+ }
298
+ }
299
+ async extendMembership(idCommitmentBigInt) {
300
+ const tx = await this.contract.extendMemberships([idCommitmentBigInt]);
301
+ await tx.wait();
302
+ return tx;
303
+ }
304
+ async eraseMembership(idCommitmentBigInt, eraseFromMembershipSet = true) {
305
+ console.log(Object.keys(this.contract));
306
+ const tx = await this.contract.eraseMemberships([idCommitmentBigInt], eraseFromMembershipSet);
307
+ await tx.wait();
308
+ return tx;
309
+ }
310
+ async withdraw(token, from) {
311
+ try {
312
+ const tx = await this.contract.withdraw(token, from);
313
+ await tx.wait();
314
+ }
315
+ catch (error) {
316
+ log.error(`Error in withdraw: ${error.message}`);
317
+ }
318
+ }
319
+ async registerMembership(idCommitmentBigInt, rateLimit = DEFAULT_RATE_LIMIT) {
320
+ if (rateLimit < RATE_LIMIT_PARAMS.MIN_RATE ||
321
+ rateLimit > RATE_LIMIT_PARAMS.MAX_RATE) {
322
+ throw new Error(`Rate limit must be between ${RATE_LIMIT_PARAMS.MIN_RATE} and ${RATE_LIMIT_PARAMS.MAX_RATE}`);
323
+ }
324
+ return this.contract.register(idCommitmentBigInt, rateLimit, []);
325
+ }
326
+ async registerWithIdentity(identity) {
327
+ try {
328
+ log.info(`Registering identity with rate limit: ${this.rateLimit} messages/epoch`);
329
+ // Check if the ID commitment is already registered
330
+ const existingIndex = await this.getMemberIndex(identity.IDCommitmentBigInt);
331
+ if (existingIndex) {
332
+ throw new Error(`ID commitment is already registered with index ${existingIndex}`);
333
+ }
334
+ // Check if there's enough remaining rate limit
335
+ const remainingRateLimit = await this.getRemainingTotalRateLimit();
336
+ if (remainingRateLimit < this.rateLimit) {
337
+ throw new Error(`Not enough remaining rate limit. Requested: ${this.rateLimit}, Available: ${remainingRateLimit}`);
338
+ }
339
+ const estimatedGas = await this.contract.estimateGas.register(identity.IDCommitmentBigInt, this.rateLimit, []);
340
+ const gasLimit = estimatedGas.add(10000);
341
+ const txRegisterResponse = await this.contract.register(identity.IDCommitmentBigInt, this.rateLimit, [], { gasLimit });
342
+ const txRegisterReceipt = await txRegisterResponse.wait();
343
+ if (txRegisterReceipt.status === 0) {
344
+ throw new Error("Transaction failed on-chain");
345
+ }
346
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
347
+ if (!memberRegistered || !memberRegistered.args) {
348
+ log.error("Failed to register membership: No MembershipRegistered event found");
349
+ return undefined;
350
+ }
351
+ const decodedData = {
352
+ idCommitment: memberRegistered.args.idCommitment,
353
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
354
+ index: memberRegistered.args.index
355
+ };
356
+ log.info(`Successfully registered membership with index ${decodedData.index} ` +
357
+ `and rate limit ${decodedData.membershipRateLimit}`);
358
+ const network = await this.contract.provider.getNetwork();
359
+ const address = this.contract.address;
360
+ const membershipId = Number(decodedData.index);
361
+ return {
362
+ identity,
363
+ membership: {
364
+ address,
365
+ treeIndex: membershipId,
366
+ chainId: network.chainId.toString(),
367
+ rateLimit: decodedData.membershipRateLimit.toNumber()
368
+ }
369
+ };
370
+ }
371
+ catch (error) {
372
+ if (error instanceof Error) {
373
+ const errorMessage = error.message;
374
+ log.error("registerWithIdentity - error message:", errorMessage);
375
+ log.error("registerWithIdentity - error stack:", error.stack);
376
+ // Try to extract more specific error information
377
+ if (errorMessage.includes("CannotExceedMaxTotalRateLimit")) {
378
+ throw new Error("Registration failed: Cannot exceed maximum total rate limit");
379
+ }
380
+ else if (errorMessage.includes("InvalidIdCommitment")) {
381
+ throw new Error("Registration failed: Invalid ID commitment");
382
+ }
383
+ else if (errorMessage.includes("InvalidMembershipRateLimit")) {
384
+ throw new Error("Registration failed: Invalid membership rate limit");
385
+ }
386
+ else if (errorMessage.includes("execution reverted")) {
387
+ throw new Error("Contract execution reverted. Check contract requirements.");
388
+ }
389
+ else {
390
+ throw new Error(`Error in registerWithIdentity: ${errorMessage}`);
391
+ }
392
+ }
393
+ else {
394
+ throw new Error("Unknown error in registerWithIdentity", {
395
+ cause: error
396
+ });
397
+ }
398
+ }
399
+ }
400
+ async registerWithPermitAndErase(identity, permit, idCommitmentsToErase) {
401
+ try {
402
+ log.info(`Registering identity with permit and rate limit: ${this.rateLimit} messages/epoch`);
403
+ const txRegisterResponse = await this.contract.registerWithPermit(permit.owner, permit.deadline, permit.v, permit.r, permit.s, identity.IDCommitmentBigInt, this.rateLimit, idCommitmentsToErase.map((id) => BigNumber.from(id)));
404
+ const txRegisterReceipt = await txRegisterResponse.wait();
405
+ const memberRegistered = txRegisterReceipt.events?.find((event) => event.event === "MembershipRegistered");
406
+ if (!memberRegistered || !memberRegistered.args) {
407
+ log.error("Failed to register membership with permit: No MembershipRegistered event found");
408
+ return undefined;
409
+ }
410
+ const decodedData = {
411
+ idCommitment: memberRegistered.args.idCommitment,
412
+ membershipRateLimit: memberRegistered.args.membershipRateLimit,
413
+ index: memberRegistered.args.index
414
+ };
415
+ log.info(`Successfully registered membership with permit. Index: ${decodedData.index}, ` +
416
+ `Rate limit: ${decodedData.membershipRateLimit}, Erased ${idCommitmentsToErase.length} commitments`);
417
+ const network = await this.contract.provider.getNetwork();
418
+ const address = this.contract.address;
419
+ const membershipId = Number(decodedData.index);
420
+ return {
421
+ identity,
422
+ membership: {
423
+ address,
424
+ treeIndex: membershipId,
425
+ chainId: network.chainId.toString(),
426
+ rateLimit: decodedData.membershipRateLimit.toNumber()
427
+ }
428
+ };
429
+ }
430
+ catch (error) {
431
+ log.error(`Error in registerWithPermitAndErase: ${error.message}`);
432
+ return undefined;
433
+ }
434
+ }
435
+ /**
436
+ * Validates that the rate limit is within the allowed range
437
+ * @throws Error if the rate limit is outside the allowed range
438
+ */
439
+ async validateRateLimit(rateLimit) {
440
+ const [minRate, maxRate] = await Promise.all([
441
+ this.contract.minMembershipRateLimit(),
442
+ this.contract.maxMembershipRateLimit()
443
+ ]);
444
+ const minRateNum = BigNumber.from(minRate).toNumber();
445
+ const maxRateNum = BigNumber.from(maxRate).toNumber();
446
+ if (rateLimit < minRateNum || rateLimit > maxRateNum) {
447
+ throw new Error(`Rate limit must be between ${minRateNum} and ${maxRateNum} messages per epoch`);
448
+ }
449
+ }
450
+ get membersFilter() {
451
+ if (!this._membersFilter) {
452
+ throw Error("Members filter was not initialized.");
453
+ }
454
+ return this._membersFilter;
455
+ }
456
+ get membershipErasedFilter() {
457
+ if (!this._membershipErasedFilter) {
458
+ throw Error("MembershipErased filter was not initialized.");
459
+ }
460
+ return this._membershipErasedFilter;
461
+ }
462
+ get membersExpiredFilter() {
463
+ if (!this._membersExpiredFilter) {
464
+ throw Error("MembersExpired filter was not initialized.");
465
+ }
466
+ return this._membersExpiredFilter;
467
+ }
468
+ async getMemberIndex(idCommitmentBigInt) {
469
+ try {
470
+ const events = await this.contract.queryFilter(this.contract.filters.MembershipRegistered(idCommitmentBigInt));
471
+ if (events.length === 0)
472
+ return undefined;
473
+ // Get the most recent registration event
474
+ const event = events[events.length - 1];
475
+ return event.args?.index;
476
+ }
477
+ catch (error) {
478
+ return undefined;
479
+ }
480
+ }
481
+ }
482
+
483
+ export { RLNBaseContract };