@waku/rln 0.1.4-d27db21.0 → 0.1.5-5e19700.0

package/package.json

@@ -1 +1 @@
-{"name":"@waku/rln","version":"0.1.4-d27db21.0","description":"RLN (Rate Limiting Nullifier) implementation for Waku","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/rln#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","rln","rate-limiting","privacy","web3"],"scripts":{"build":"run-s build:**","build:copy":"mkdir -p dist/resources && cp -r src/resources/* dist/resources/","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint \"src/!(resources)/**/*.{ts,js}\" *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:browser":"karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"devDependencies":{"@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^5.0.1","@types/chai-spies":"^1.0.6","@types/deep-equal-in-any-order":"^1.0.4","@types/lodash":"^4.17.15","@types/sinon":"^17.0.3","@waku/build-utils":"^1.0.0","@waku/message-encryption":"0.0.32-d27db21.0","chai":"^5.1.2","chai-as-promised":"^8.0.1","chai-spies":"^1.1.0","chai-subset":"^1.6.0","deep-equal-in-any-order":"^2.0.6","fast-check":"^3.23.2","rollup-plugin-copy":"^3.5.0","sinon":"^19.0.2"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"],"dependencies":{"@chainsafe/bls-keystore":"3.0.0","@waku/core":"0.0.34-d27db21.0","@waku/utils":"0.0.22-d27db21.0","@waku/zerokit-rln-wasm":"^0.0.13","ethereum-cryptography":"^3.1.0","ethers":"^5.7.2","lodash":"^4.17.21","uuid":"^11.0.5"}}
+{"name":"@waku/rln","version":"0.1.5-5e19700.0","description":"RLN (Rate Limiting Nullifier) implementation for Waku","types":"./dist/index.d.ts","module":"./dist/index.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js"}},"type":"module","homepage":"https://github.com/waku-org/js-waku/tree/master/packages/rln#readme","repository":{"type":"git","url":"https://github.com/waku-org/js-waku.git"},"bugs":{"url":"https://github.com/waku-org/js-waku/issues"},"license":"MIT OR Apache-2.0","keywords":["waku","rln","rate-limiting","privacy","web3"],"scripts":{"build":"run-s build:**","build:copy":"mkdir -p dist/resources && cp -r src/resources/* dist/resources/","build:esm":"tsc","build:bundle":"rollup --config rollup.config.js","fix":"run-s fix:*","fix:lint":"eslint src *.js --fix","check":"run-s check:*","check:tsc":"tsc -p tsconfig.dev.json","check:lint":"eslint \"src/!(resources)/**/*.{ts,js}\" *.js","check:spelling":"cspell \"{README.md,src/**/*.ts}\"","test":"NODE_ENV=test run-s test:*","test:browser":"karma start karma.conf.cjs","watch:build":"tsc -p tsconfig.json -w","watch:test":"mocha --watch","prepublish":"npm run build","reset-hard":"git clean -dfx -e .idea && git reset --hard && npm i && npm run build"},"engines":{"node":">=20"},"devDependencies":{"@rollup/plugin-commonjs":"^25.0.7","@rollup/plugin-json":"^6.0.0","@rollup/plugin-node-resolve":"^15.2.3","@types/chai":"^5.0.1","@types/chai-spies":"^1.0.6","@types/deep-equal-in-any-order":"^1.0.4","@types/lodash":"^4.17.15","@types/sinon":"^17.0.3","@waku/build-utils":"^1.0.0","@waku/message-encryption":"0.0.33-5e19700.0","deep-equal-in-any-order":"^2.0.6","fast-check":"^3.23.2","rollup-plugin-copy":"^3.5.0"},"files":["dist","bundle","src/**/*.ts","!**/*.spec.*","!**/*.json","CHANGELOG.md","LICENSE","README.md"],"dependencies":{"@chainsafe/bls-keystore":"3.0.0","@waku/core":"0.0.35-5e19700.0","@waku/utils":"0.0.23-5e19700.0","@noble/hashes":"^1.2.0","@waku/zerokit-rln-wasm":"^0.0.13","ethereum-cryptography":"^3.1.0","ethers":"^5.7.2","lodash":"^4.17.21","uuid":"^11.0.5","chai":"^5.1.2","chai-as-promised":"^8.0.1","chai-spies":"^1.1.0","chai-subset":"^1.6.0","sinon":"^19.0.2"}}

package/src/codec.test-utils.ts

@@ -0,0 +1,80 @@
+import type { IProtoMessage } from "@waku/interfaces";
+import { expect } from "chai";
+
+import { createRLN } from "./create.js";
+import type { IdentityCredential } from "./identity.js";
+
+export interface TestRLNCodecSetup {
+  rlnInstance: any;
+  credential: IdentityCredential;
+  index: number;
+  payload: Uint8Array;
+}
+
+export const TEST_CONSTANTS = {
+  contentTopic: "/test/1/waku-message/utf8",
+  emptyPubsubTopic: "",
+  defaultIndex: 0,
+  defaultPayload: new Uint8Array([1, 2, 3, 4, 5])
+} as const;
+
+export const EMPTY_PROTO_MESSAGE = {
+  timestamp: undefined,
+  contentTopic: "",
+  ephemeral: undefined,
+  meta: undefined,
+  rateLimitProof: undefined,
+  version: undefined
+} as const;
+
+/**
+ * Creates a basic RLN setup for codec tests
+ */
+export async function createTestRLNCodecSetup(): Promise<TestRLNCodecSetup> {
+  const rlnInstance = await createRLN();
+  const credential = rlnInstance.zerokit.generateIdentityCredentials();
+  rlnInstance.zerokit.insertMember(credential.IDCommitment);
+
+  return {
+    rlnInstance,
+    credential,
+    index: TEST_CONSTANTS.defaultIndex,
+    payload: TEST_CONSTANTS.defaultPayload
+  };
+}
+
+/**
+ * Creates a meta setter function for testing
+ */
+export function createTestMetaSetter(): (
+  msg: IProtoMessage & { meta: undefined }
+) => Uint8Array {
+  return (msg: IProtoMessage & { meta: undefined }): Uint8Array => {
+    const buffer = new ArrayBuffer(4);
+    const view = new DataView(buffer);
+    view.setUint32(0, msg.payload.length, false);
+    return new Uint8Array(buffer);
+  };
+}
+
+/**
+ * Verifies common RLN message properties
+ */
+export function verifyRLNMessage(
+  msg: any,
+  payload: Uint8Array,
+  contentTopic: string,
+  version: number,
+  rlnInstance: any
+): void {
+  expect(msg.rateLimitProof).to.not.be.undefined;
+  expect(msg.verify([rlnInstance.zerokit.getMerkleRoot()])).to.be.true;
+  expect(msg.verifyNoRoot()).to.be.true;
+  expect(msg.epoch).to.not.be.undefined;
+  expect(msg.epoch).to.be.gt(0);
+
+  expect(msg.contentTopic).to.eq(contentTopic);
+  expect(msg.msg.version).to.eq(version);
+  expect(msg.payload).to.deep.eq(payload);
+  expect(msg.timestamp).to.not.be.undefined;
+}