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

update README, fix tests

Browse Source
This commit is contained in:
Sasha 2024-01-24 20:59:00 +01:00
parent 82a986437a
commit 453085245e
No known key found for this signature in database
4 changed files with 35 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -71,7 +71,16 @@ Browse http://localhost:8080 and open the dev tools console to see the proof bei
```js
import * as rln from "@waku/rln";
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
```
### Starting RLN to listen to a contract
```js
import * as rln from "@waku/rln";
const rlnInstance = await rln.createRLN();
await rlnInstance.start(); // will use default Sepolia contract
```
#### Generating RLN Membership Credentials
@ -94,6 +103,17 @@ let credentials = rlnInstance.generateSeededIdentityCredentials(seed);
rlnInstance.insertMember(credentials.IDCommitment);
```
### Registering Membership on a contract
```js
import * as rln from "@waku/rln";
const rlnInstance = await rln.createRLN();
await rlnInstance.start(); // will use default Sepolia contract
const membershipInfo = await rlnInstance.contract.registerWithKey(credentials);
```
### Generating a Proof
```js

18
src/codec.spec.ts
View File

@ -44,7 +44,7 @@ const EMPTY_PROTO_MESSAGE = {
describe("RLN codec with version 0", () => {
it("toWire", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -85,7 +85,7 @@ describe("RLN codec with version 0", () => {
});
it("toProtoObj", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -128,7 +128,7 @@ describe("RLN codec with version 0", () => {
describe("RLN codec with version 1", () => {
it("Symmetric, toWire", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -175,7 +175,7 @@ describe("RLN codec with version 1", () => {
});
it("Symmetric, toProtoObj", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -221,7 +221,7 @@ describe("RLN codec with version 1", () => {
});
it("Asymmetric, toWire", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -269,7 +269,7 @@ describe("RLN codec with version 1", () => {
});
it("Asymmetric, toProtoObj", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -318,7 +318,7 @@ describe("RLN codec with version 1", () => {
describe("RLN Codec - epoch", () => {
it("toProtoObj", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -374,7 +374,7 @@ describe("RLN codec with version 0 and meta setter", () => {
};
it("toWire", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);
@ -422,7 +422,7 @@ describe("RLN codec with version 0 and meta setter", () => {
});
it("toProtoObj", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
const index = 0;
const payload = new Uint8Array([1, 2, 3, 4, 5]);

6
src/index.spec.ts
View File

@ -4,7 +4,7 @@ import * as rln from "./index.js";
describe("js-rln", () => {
it("should verify a proof", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const credential = rlnInstance.generateIdentityCredentials();
@ -59,7 +59,7 @@ describe("js-rln", () => {
}
});
it("should verify a proof with a seeded membership key generation", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const seed = "This is a test seed";
const credential = rlnInstance.generateSeededIdentityCredential(seed);
@ -115,7 +115,7 @@ describe("js-rln", () => {
});
it("should generate the same membership key if the same seed is provided", async function () {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const seed = "This is a test seed";
const memKeys1 = rlnInstance.generateSeededIdentityCredential(seed);
const memKeys2 = rlnInstance.generateSeededIdentityCredential(seed);

4
src/rln_contract.spec.ts
View File

@ -8,7 +8,7 @@ chai.use(spies);
describe("RLN Contract abstraction", () => {
it("should be able to fetch members from events and store to rln instance", async () => {
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
rlnInstance.insertMember = () => undefined;
const insertMemberSpy = chai.spy.on(rlnInstance, "insertMember");
@ -36,7 +36,7 @@ describe("RLN Contract abstraction", () => {
const mockSignature =
"0xdeb8a6b00a8e404deb1f52d3aa72ed7f60a2ff4484c737eedaef18a0aacb2dfb4d5d74ac39bb71fa358cf2eb390565a35b026cc6272f2010d4351e17670311c21c";
const rlnInstance = await rln.create();
const rlnInstance = await rln.createRLN();
const voidSigner = new ethers.VoidSigner(rln.SEPOLIA_CONTRACT.address);
const rlnContract = new rln.RLNContract(rlnInstance, {
registryAddress: rln.SEPOLIA_CONTRACT.address,