@waku/rln 0.0.14 → 0.1.0-e52107d

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -70,10 +70,10 @@ import * as rln from "@waku/rln";
70
70
  const rlnInstance = await rln.create();
71
71
  ```
72
72
 
73
- ### Generating RLN Membership Keypair
73
+ #### Generating RLN Membership Credentials
74
74
 
75
75
  ```js
76
- let memKeys = rlnInstance.generateMembershipKey();
76
+ let credentials = rlnInstance.generateIdentityCredentials();
77
77
  ```
78
78
 
79
79
  ### Generating RLN Membership Keypair Using a Seed
@@ -81,13 +81,13 @@ let memKeys = rlnInstance.generateMembershipKey();
81
81
  This can be used to generate credentials from a signature hash (e.g. signed by an Ethereum account).
82
82
 
83
83
  ```js
84
- let memKeys = rlnInstance.generateSeededMembershipKey(seed);
84
+ let credentials = rlnInstance.generateSeededIdentityCredentials(seed);
85
85
  ```
86
86
 
87
87
  ### Adding Membership Keys Into Merkle Tree
88
88
 
89
89
  ```js
90
- rlnInstance.insertMember(memKeys.IDCommitment);
90
+ rlnInstance.insertMember(credentials.IDCommitment);
91
91
  ```
92
92
 
93
93
  ### Generating a Proof
@@ -106,7 +106,7 @@ const proof = await rlnInstance.generateProof(
106
106
  uint8Msg,
107
107
  index,
108
108
  epoch,
109
- memKeys.IDKey
109
+ credentials.IDSecretHash
110
110
  );
111
111
  ```
112
112