@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
@@ -21,8 +21,8 @@ import { isCredentialValid, isKeystoreValid } from "./schema_validator.js";
21
21
  import type {
22
22
  Keccak256Hash,
23
23
  KeystoreEntity,
24
+ KeystoreMembershipInfo,
24
25
  MembershipHash,
25
- MembershipInfo,
26
26
  Password,
27
27
  Sha256Hash
28
28
  } from "./types.js";
@@ -274,7 +274,8 @@ export class Keystore {
274
274
  membership: {
275
275
  treeIndex: _.get(obj, "treeIndex"),
276
276
  chainId: _.get(obj, "membershipContract.chainId"),
277
- address: _.get(obj, "membershipContract.address")
277
+ address: _.get(obj, "membershipContract.address"),
278
+ rateLimit: _.get(obj, "userMessageLimit")
278
279
  }
279
280
  };
280
281
  } catch (err) {
@@ -283,11 +284,18 @@ export class Keystore {
283
284
  }
284
285
  }
285
286
 
286
- private static fromArraylikeToBytes(obj: {
287
- [key: number]: number;
288
- }): Uint8Array {
289
- const bytes = [];
287
+ private static fromArraylikeToBytes(
288
+ obj:
289
+ | number[]
290
+ | {
291
+ [key: number]: number;
292
+ }
293
+ ): Uint8Array {
294
+ if (Array.isArray(obj)) {
295
+ return new Uint8Array(obj);
296
+ }
290
297
 
298
+ const bytes = [];
291
299
  let index = 0;
292
300
  let lastElement = obj[index];
293
301
 
@@ -302,7 +310,9 @@ export class Keystore {
302
310
 
303
311
  // follows nwaku implementation
304
312
  // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L111
305
- private static computeMembershipHash(info: MembershipInfo): MembershipHash {
313
+ private static computeMembershipHash(
314
+ info: KeystoreMembershipInfo
315
+ ): MembershipHash {
306
316
  return bytesToHex(
307
317
  sha256(utf8ToBytes(`${info.chainId}${info.address}${info.treeIndex}`))
308
318
  ).toUpperCase();
@@ -315,15 +325,16 @@ export class Keystore {
315
325
  JSON.stringify({
316
326
  treeIndex: options.membership.treeIndex,
317
327
  identityCredential: {
318
- idCommitment: options.identity.IDCommitment,
319
- idNullifier: options.identity.IDNullifier,
320
- idSecretHash: options.identity.IDSecretHash,
321
- idTrapdoor: options.identity.IDTrapdoor
328
+ idCommitment: Array.from(options.identity.IDCommitment),
329
+ idNullifier: Array.from(options.identity.IDNullifier),
330
+ idSecretHash: Array.from(options.identity.IDSecretHash),
331
+ idTrapdoor: Array.from(options.identity.IDTrapdoor)
322
332
  },
323
333
  membershipContract: {
324
334
  chainId: options.membership.chainId,
325
335
  address: options.membership.address
326
- }
336
+ },
337
+ userMessageLimit: options.membership.rateLimit
327
338
  })
328
339
  );
329
340
  }
@@ -7,15 +7,16 @@ export type Password = string | Uint8Array;
7
7
 
8
8
  // see reference
9
9
  // https://github.com/waku-org/nwaku/blob/f05528d4be3d3c876a8b07f9bb7dfaae8aa8ec6e/waku/waku_keystore/protocol_types.nim#L111
10
- export type MembershipInfo = {
11
- chainId: number;
10
+ export type KeystoreMembershipInfo = {
11
+ chainId: string;
12
12
  address: string;
13
13
  treeIndex: number;
14
+ rateLimit: number;
14
15
  };
15
16
 
16
17
  export type KeystoreEntity = {
17
18
  identity: IdentityCredential;
18
- membership: MembershipInfo;
19
+ membership: KeystoreMembershipInfo;
19
20
  };
20
21
 
21
22
  export type DecryptedCredentials = KeystoreEntity;
package/src/rln.ts CHANGED
@@ -7,7 +7,6 @@ import type {
7
7
  import { Logger } from "@waku/utils";
8
8
  import init from "@waku/zerokit-rln-wasm";
9
9
  import * as zerokitRLN from "@waku/zerokit-rln-wasm";
10
- import { ethers } from "ethers";
11
10
 
12
11
  import {
13
12
  createRLNDecoder,
@@ -16,258 +15,52 @@ import {
16
15
  type RLNEncoder
17
16
  } from "./codec.js";
18
17
  import { DEFAULT_RATE_LIMIT } from "./contract/constants.js";
19
- import { RLNContract, SEPOLIA_CONTRACT } from "./contract/index.js";
20
- import { IdentityCredential } from "./identity.js";
21
- import { Keystore } from "./keystore/index.js";
18
+ import { RLNCredentialsManager } from "./credentials_manager.js";
22
19
  import type {
23
20
  DecryptedCredentials,
24
21
  EncryptedCredentials
25
22
  } from "./keystore/index.js";
26
- import { KeystoreEntity, Password } from "./keystore/types.js";
27
23
  import verificationKey from "./resources/verification_key";
28
24
  import * as wc from "./resources/witness_calculator";
29
25
  import { WitnessCalculator } from "./resources/witness_calculator";
30
- import { extractMetaMaskSigner } from "./utils/index.js";
31
26
  import { Zerokit } from "./zerokit.js";
32
27
 
33
28
  const log = new Logger("waku:rln");
34
29
 
35
- async function loadWitnessCalculator(): Promise<WitnessCalculator> {
36
- try {
37
- const url = new URL("./resources/rln.wasm", import.meta.url);
38
- const response = await fetch(url);
39
-
40
- if (!response.ok) {
41
- throw new Error(
42
- `Failed to fetch witness calculator: ${response.status} ${response.statusText}`
43
- );
44
- }
45
-
46
- return await wc.builder(
47
- new Uint8Array(await response.arrayBuffer()),
48
- false
49
- );
50
- } catch (error) {
51
- log.error("Error loading witness calculator:", error);
52
- throw new Error(
53
- `Failed to load witness calculator: ${error instanceof Error ? error.message : String(error)}`
54
- );
55
- }
56
- }
57
-
58
- async function loadZkey(): Promise<Uint8Array> {
59
- try {
60
- const url = new URL("./resources/rln_final.zkey", import.meta.url);
61
- const response = await fetch(url);
62
-
63
- if (!response.ok) {
64
- throw new Error(
65
- `Failed to fetch zkey: ${response.status} ${response.statusText}`
66
- );
67
- }
68
-
69
- return new Uint8Array(await response.arrayBuffer());
70
- } catch (error) {
71
- log.error("Error loading zkey:", error);
72
- throw new Error(
73
- `Failed to load zkey: ${error instanceof Error ? error.message : String(error)}`
74
- );
75
- }
76
- }
77
-
78
- /**
79
- * Create an instance of RLN
80
- * @returns RLNInstance
81
- */
82
- export async function create(): Promise<RLNInstance> {
83
- try {
84
- // eslint-disable-next-line @typescript-eslint/no-explicit-any
85
- await (init as any)?.();
86
- zerokitRLN.init_panic_hook();
87
-
88
- const witnessCalculator = await loadWitnessCalculator();
89
- const zkey = await loadZkey();
90
-
91
- const stringEncoder = new TextEncoder();
92
- const vkey = stringEncoder.encode(JSON.stringify(verificationKey));
93
-
94
- const DEPTH = 20;
95
- const zkRLN = zerokitRLN.newRLN(DEPTH, zkey, vkey);
96
- const zerokit = new Zerokit(zkRLN, witnessCalculator, DEFAULT_RATE_LIMIT);
97
-
98
- return new RLNInstance(zerokit);
99
- } catch (error) {
100
- log.error("Failed to initialize RLN:", error);
101
- throw error;
102
- }
103
- }
104
-
105
- type StartRLNOptions = {
106
- /**
107
- * If not set - will extract MetaMask account and get signer from it.
108
- */
109
- signer?: ethers.Signer;
110
- /**
111
- * If not set - will use default SEPOLIA_CONTRACT address.
112
- */
113
- address?: string;
114
- /**
115
- * Credentials to use for generating proofs and connecting to the contract and network.
116
- * If provided used for validating the network chainId and connecting to registry contract.
117
- */
118
- credentials?: EncryptedCredentials | DecryptedCredentials;
119
- /**
120
- * Rate limit for the member.
121
- */
122
- rateLimit?: number;
123
- };
124
-
125
- type RegisterMembershipOptions =
126
- | { signature: string }
127
- | { identity: IdentityCredential };
128
-
129
30
  type WakuRLNEncoderOptions = WakuEncoderOptions & {
130
31
  credentials: EncryptedCredentials | DecryptedCredentials;
131
32
  };
132
33
 
133
- export class RLNInstance {
134
- private started = false;
135
- private starting = false;
136
-
137
- private _contract: undefined | RLNContract;
138
- private _signer: undefined | ethers.Signer;
139
-
140
- private keystore = Keystore.create();
141
- private _credentials: undefined | DecryptedCredentials;
142
-
143
- public constructor(public zerokit: Zerokit) {}
144
-
145
- public get contract(): undefined | RLNContract {
146
- return this._contract;
147
- }
148
-
149
- public get signer(): undefined | ethers.Signer {
150
- return this._signer;
151
- }
152
-
153
- public async start(options: StartRLNOptions = {}): Promise<void> {
154
- if (this.started || this.starting) {
155
- return;
156
- }
157
-
158
- this.starting = true;
159
-
34
+ export class RLNInstance extends RLNCredentialsManager {
35
+ /**
36
+ * Create an instance of RLN
37
+ * @returns RLNInstance
38
+ */
39
+ public static async create(): Promise<RLNInstance> {
160
40
  try {
161
- const { credentials, keystore } =
162
- await RLNInstance.decryptCredentialsIfNeeded(options.credentials);
163
- const { signer, address } = await this.determineStartOptions(
164
- options,
165
- credentials
166
- );
167
-
168
- if (keystore) {
169
- this.keystore = keystore;
170
- }
171
-
172
- this._credentials = credentials;
173
- this._signer = signer!;
174
- this._contract = await RLNContract.init(this, {
175
- address: address!,
176
- signer: signer!,
177
- rateLimit: options.rateLimit ?? this.zerokit.getRateLimit
178
- });
179
- this.started = true;
180
- } finally {
181
- this.starting = false;
182
- }
183
- }
184
-
185
- private async determineStartOptions(
186
- options: StartRLNOptions,
187
- credentials: KeystoreEntity | undefined
188
- ): Promise<StartRLNOptions> {
189
- let chainId = credentials?.membership.chainId;
190
- const address =
191
- credentials?.membership.address ||
192
- options.address ||
193
- SEPOLIA_CONTRACT.address;
194
-
195
- if (address === SEPOLIA_CONTRACT.address) {
196
- chainId = SEPOLIA_CONTRACT.chainId;
197
- }
41
+ // eslint-disable-next-line @typescript-eslint/no-explicit-any
42
+ await (init as any)?.();
43
+ zerokitRLN.init_panic_hook();
198
44
 
199
- const signer = options.signer || (await extractMetaMaskSigner());
200
- const currentChainId = await signer.getChainId();
45
+ const witnessCalculator = await RLNInstance.loadWitnessCalculator();
46
+ const zkey = await RLNInstance.loadZkey();
201
47
 
202
- if (chainId && chainId !== currentChainId) {
203
- throw Error(
204
- `Failed to start RLN contract, chain ID of contract is different from current one: contract-${chainId}, current network-${currentChainId}`
205
- );
206
- }
207
-
208
- return {
209
- signer,
210
- address
211
- };
212
- }
213
-
214
- private static async decryptCredentialsIfNeeded(
215
- credentials?: EncryptedCredentials | DecryptedCredentials
216
- ): Promise<{ credentials?: DecryptedCredentials; keystore?: Keystore }> {
217
- if (!credentials) {
218
- return {};
219
- }
220
-
221
- if ("identity" in credentials) {
222
- return { credentials };
223
- }
224
-
225
- const keystore = Keystore.fromString(credentials.keystore);
226
-
227
- if (!keystore) {
228
- return {};
229
- }
230
-
231
- const decryptedCredentials = await keystore.readCredential(
232
- credentials.id,
233
- credentials.password
234
- );
48
+ const stringEncoder = new TextEncoder();
49
+ const vkey = stringEncoder.encode(JSON.stringify(verificationKey));
235
50
 
236
- return {
237
- keystore,
238
- credentials: decryptedCredentials
239
- };
240
- }
241
-
242
- public async registerMembership(
243
- options: RegisterMembershipOptions
244
- ): Promise<undefined | DecryptedCredentials> {
245
- if (!this.contract) {
246
- throw Error("RLN Contract is not initialized.");
247
- }
248
-
249
- let identity = "identity" in options && options.identity;
250
-
251
- if ("signature" in options) {
252
- identity = this.zerokit.generateSeededIdentityCredential(
253
- options.signature
254
- );
255
- }
51
+ const DEPTH = 20;
52
+ const zkRLN = zerokitRLN.newRLN(DEPTH, zkey, vkey);
53
+ const zerokit = new Zerokit(zkRLN, witnessCalculator, DEFAULT_RATE_LIMIT);
256
54
 
257
- if (!identity) {
258
- throw Error("Missing signature or identity to register membership.");
55
+ return new RLNInstance(zerokit);
56
+ } catch (error) {
57
+ log.error("Failed to initialize RLN:", error);
58
+ throw error;
259
59
  }
260
-
261
- return this.contract.registerWithIdentity(identity);
262
60
  }
263
61
 
264
- /**
265
- * Changes credentials in use by relying on provided Keystore earlier in rln.start
266
- * @param id: string, hash of credentials to select from Keystore
267
- * @param password: string or bytes to use to decrypt credentials from Keystore
268
- */
269
- public async useCredentials(id: string, password: Password): Promise<void> {
270
- this._credentials = await this.keystore?.readCredential(id, password);
62
+ private constructor(public zerokit: Zerokit) {
63
+ super(zerokit);
271
64
  }
272
65
 
273
66
  public async createEncoder(
@@ -275,7 +68,7 @@ export class RLNInstance {
275
68
  ): Promise<RLNEncoder> {
276
69
  const { credentials: decryptedCredentials } =
277
70
  await RLNInstance.decryptCredentialsIfNeeded(options.credentials);
278
- const credentials = decryptedCredentials || this._credentials;
71
+ const credentials = decryptedCredentials || this.credentials;
279
72
 
280
73
  if (!credentials) {
281
74
  throw Error(
@@ -293,33 +86,6 @@ export class RLNInstance {
293
86
  });
294
87
  }
295
88
 
296
- private async verifyCredentialsAgainstContract(
297
- credentials: KeystoreEntity
298
- ): Promise<void> {
299
- if (!this._contract) {
300
- throw Error(
301
- "Failed to verify chain coordinates: no contract initialized."
302
- );
303
- }
304
-
305
- const registryAddress = credentials.membership.address;
306
- const currentRegistryAddress = this._contract.address;
307
- if (registryAddress !== currentRegistryAddress) {
308
- throw Error(
309
- `Failed to verify chain coordinates: credentials contract address=${registryAddress} is not equal to registryContract address=${currentRegistryAddress}`
310
- );
311
- }
312
-
313
- const chainId = credentials.membership.chainId;
314
- const network = await this._contract.provider.getNetwork();
315
- const currentChainId = network.chainId;
316
- if (chainId !== currentChainId) {
317
- throw Error(
318
- `Failed to verify chain coordinates: credentials chainID=${chainId} is not equal to registryContract chainID=${currentChainId}`
319
- );
320
- }
321
- }
322
-
323
89
  public createDecoder(
324
90
  contentTopic: ContentTopic
325
91
  ): RLNDecoder<IDecodedMessage> {
@@ -328,4 +94,47 @@ export class RLNInstance {
328
94
  decoder: createDecoder(contentTopic)
329
95
  });
330
96
  }
97
+
98
+ public static async loadWitnessCalculator(): Promise<WitnessCalculator> {
99
+ try {
100
+ const url = new URL("./resources/rln.wasm", import.meta.url);
101
+ const response = await fetch(url);
102
+
103
+ if (!response.ok) {
104
+ throw new Error(
105
+ `Failed to fetch witness calculator: ${response.status} ${response.statusText}`
106
+ );
107
+ }
108
+
109
+ return await wc.builder(
110
+ new Uint8Array(await response.arrayBuffer()),
111
+ false
112
+ );
113
+ } catch (error) {
114
+ log.error("Error loading witness calculator:", error);
115
+ throw new Error(
116
+ `Failed to load witness calculator: ${error instanceof Error ? error.message : String(error)}`
117
+ );
118
+ }
119
+ }
120
+
121
+ public static async loadZkey(): Promise<Uint8Array> {
122
+ try {
123
+ const url = new URL("./resources/rln_final.zkey", import.meta.url);
124
+ const response = await fetch(url);
125
+
126
+ if (!response.ok) {
127
+ throw new Error(
128
+ `Failed to fetch zkey: ${response.status} ${response.statusText}`
129
+ );
130
+ }
131
+
132
+ return new Uint8Array(await response.arrayBuffer());
133
+ } catch (error) {
134
+ log.error("Error loading zkey:", error);
135
+ throw new Error(
136
+ `Failed to load zkey: ${error instanceof Error ? error.message : String(error)}`
137
+ );
138
+ }
139
+ }
331
140
  }
package/src/types.ts ADDED
@@ -0,0 +1,31 @@
1
+ import { ethers } from "ethers";
2
+
3
+ import { IdentityCredential } from "./identity.js";
4
+ import {
5
+ DecryptedCredentials,
6
+ EncryptedCredentials
7
+ } from "./keystore/types.js";
8
+
9
+ export type StartRLNOptions = {
10
+ /**
11
+ * If not set - will extract MetaMask account and get signer from it.
12
+ */
13
+ signer?: ethers.Signer;
14
+ /**
15
+ * If not set - will use default SEPOLIA_CONTRACT address.
16
+ */
17
+ address?: string;
18
+ /**
19
+ * Credentials to use for generating proofs and connecting to the contract and network.
20
+ * If provided used for validating the network chainId and connecting to registry contract.
21
+ */
22
+ credentials?: EncryptedCredentials | DecryptedCredentials;
23
+ /**
24
+ * Rate limit for the member.
25
+ */
26
+ rateLimit?: number;
27
+ };
28
+
29
+ export type RegisterMembershipOptions =
30
+ | { signature: string }
31
+ | { identity: IdentityCredential };
@@ -65,8 +65,16 @@ export function buildBigIntFromUint8Array(
65
65
  array: Uint8Array,
66
66
  byteOffset: number = 0
67
67
  ): bigint {
68
- const dataView = new DataView(array.buffer);
69
- return dataView.getBigUint64(byteOffset, true);
68
+ // Convert byte array to BigInt in big-endian format (to match nwaku)
69
+ let result = 0n;
70
+ // Process all 32 bytes (or the available bytes if less)
71
+ const length = Math.min(array.length - byteOffset, 32);
72
+
73
+ for (let i = 0; i < length; i++) {
74
+ result = (result << 8n) | BigInt(array[byteOffset + i]);
75
+ }
76
+
77
+ return result;
70
78
  }
71
79
 
72
80
  /**
package/src/zerokit.ts CHANGED
@@ -16,7 +16,7 @@ export class Zerokit {
16
16
  public constructor(
17
17
  private readonly zkRLN: number,
18
18
  private readonly witnessCalculator: WitnessCalculator,
19
- private readonly rateLimit: number = DEFAULT_RATE_LIMIT
19
+ private readonly _rateLimit: number = DEFAULT_RATE_LIMIT
20
20
  ) {}
21
21
 
22
22
  public get getZkRLN(): number {
@@ -27,8 +27,8 @@ export class Zerokit {
27
27
  return this.witnessCalculator;
28
28
  }
29
29
 
30
- public get getRateLimit(): number {
31
- return this.rateLimit;
30
+ public get rateLimit(): number {
31
+ return this._rateLimit;
32
32
  }
33
33
 
34
34
  public generateIdentityCredentials(): IdentityCredential {
@@ -1,6 +0,0 @@
1
- import * as _nodeResolve_empty from './_node-resolve_empty.js';
2
- import { getAugmentedNamespace } from './_commonjsHelpers.js';
3
-
4
- var require$$0 = /*@__PURE__*/getAugmentedNamespace(_nodeResolve_empty);
5
-
6
- export { require$$0 as default };
@@ -1,3 +0,0 @@
1
- var _nodeResolve_empty = {};
2
-
3
- export { _nodeResolve_empty as default };
@@ -1,3 +0,0 @@
1
- var bn = {exports: {}};
2
-
3
- export { bn as __module };
@@ -1,3 +0,0 @@
1
- var common = {};
2
-
3
- export { common as __exports };
@@ -1,3 +0,0 @@
1
- var common = {};
2
-
3
- export { common as __exports };
@@ -1,3 +0,0 @@
1
- var hash = {};
2
-
3
- export { hash as __exports };
@@ -1,3 +0,0 @@
1
- var inherits_browser = {exports: {}};
2
-
3
- export { inherits_browser as __module };
@@ -1,3 +0,0 @@
1
- var ripemd = {};
2
-
3
- export { ripemd as __exports };
@@ -1,3 +0,0 @@
1
- var sha = {};
2
-
3
- export { sha as __exports };
@@ -1,3 +0,0 @@
1
- var sha3 = {exports: {}};
2
-
3
- export { sha3 as __module };
@@ -1,3 +0,0 @@
1
- var utils = {};
2
-
3
- export { utils as __exports };
@@ -1,3 +0,0 @@
1
- const version = "abi/5.8.0";
2
-
3
- export { version };