logos-messaging/js-rln
1
0
Fork 0
mirror of https://github.com/logos-messaging/js-rln.git synced 2026-01-07 16:13:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: update readme

Browse Source
This commit is contained in:
Ya-wen, Jeng 2024-07-17 19:36:46 +02:00
parent e562feb744
commit 732b2af45a
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -86,7 +86,7 @@ await rlnInstance.start(); // will use default Sepolia contract
#### Generating RLN Membership Credentials #### Generating RLN Membership Credentials
```js ```js
let credentials = rlnInstance.generateIdentityCredentials(); let credentials = rlnInstance.zerokit.generateIdentityCredentials();
``` ```
### Generating RLN Membership Keypair Using a Seed ### Generating RLN Membership Keypair Using a Seed
@ -94,13 +94,13 @@ let credentials = rlnInstance.generateIdentityCredentials();
This can be used to generate credentials from a signature hash (e.g. signed by an Ethereum account). This can be used to generate credentials from a signature hash (e.g. signed by an Ethereum account).
```js ```js
let credentials = rlnInstance.generateSeededIdentityCredentials(seed); let credentials = rlnInstance.zerokit.generateSeededIdentityCredential(seed);
``` ```
### Adding Membership Keys Into Merkle Tree ### Adding Membership Keys Into Merkle Tree
```js ```js
rlnInstance.insertMember(credentials.IDCommitment); rlnInstance.zerokit.insertMember(credentials.IDCommitment);
``` ```
### Registering Membership on a contract ### Registering Membership on a contract
@ -126,7 +126,7 @@ const uint8Msg = Uint8Array.from(
const epoch = new Uint8Array(32); const epoch = new Uint8Array(32);
// generating a proof // generating a proof
const proof = await rlnInstance.generateProof( const proof = await rlnInstance.zerokit.generateRLNProof(
uint8Msg, uint8Msg,
index, index,
epoch, epoch,
@ -139,7 +139,7 @@ const proof = await rlnInstance.generateProof(
```js ```js
try { try {
// verify the proof // verify the proof
const verificationResult = rlnInstance.verifyProof(proof, uint8Msg); const verificationResult = rlnInstance.zerokit.verifyRLNProof(proof, uint8Msg);
console.log("Is proof verified?", verificationResult ? "yes" : "no"); console.log("Is proof verified?", verificationResult ? "yes" : "no");
} catch (err) { } catch (err) {
console.log("Invalid proof"); console.log("Invalid proof");