@waku/rln 0.1.3 → 0.1.4-d27db21.0

package/src/codec.ts

@@ -6,40 +6,42 @@ import type {
   IProtoMessage,
   IRateLimitProof
 } from "@waku/interfaces";
-import debug from "debug";
+import { Logger } from "@waku/utils";
 
 import type { IdentityCredential } from "./identity.js";
 import { RlnMessage, toRLNSignal } from "./message.js";
 import { RLNInstance } from "./rln.js";
 
-const log = debug("waku:rln:encoder");
+const log = new Logger("waku:rln:encoder");
 
 export class RLNEncoder implements IEncoder {
   private readonly idSecretHash: Uint8Array;
 
-  constructor(
-    private encoder: IEncoder,
-    private rlnInstance: RLNInstance,
-    private index: number,
+  public constructor(
+    private readonly encoder: IEncoder,
+    private readonly rlnInstance: RLNInstance,
+    private readonly index: number,
     identityCredential: IdentityCredential
   ) {
-    if (index < 0) throw "invalid membership index";
+    if (index < 0) throw new Error("Invalid membership index");
     this.idSecretHash = identityCredential.IDSecretHash;
   }
 
-  async toWire(message: IMessage): Promise<Uint8Array | undefined> {
+  public async toWire(message: IMessage): Promise<Uint8Array | undefined> {
     message.rateLimitProof = await this.generateProof(message);
-    log("Proof generated", message.rateLimitProof);
+    log.info("Proof generated", message.rateLimitProof);
     return this.encoder.toWire(message);
   }
 
-  async toProtoObj(message: IMessage): Promise<IProtoMessage | undefined> {
+  public async toProtoObj(
+    message: IMessage
+  ): Promise<IProtoMessage | undefined> {
     const protoMessage = await this.encoder.toProtoObj(message);
     if (!protoMessage) return;
 
     protoMessage.contentTopic = this.contentTopic;
     protoMessage.rateLimitProof = await this.generateProof(message);
-    log("Proof generated", protoMessage.rateLimitProof);
+    log.info("Proof generated", protoMessage.rateLimitProof);
     return protoMessage;
   }
 
@@ -54,15 +56,15 @@ export class RLNEncoder implements IEncoder {
     return proof;
   }
 
-  get pubsubTopic(): string {
+  public get pubsubTopic(): string {
     return this.encoder.pubsubTopic;
   }
 
-  get contentTopic(): string {
+  public get contentTopic(): string {
     return this.encoder.contentTopic;
   }
 
-  get ephemeral(): boolean {
+  public get ephemeral(): boolean {
     return this.encoder.ephemeral;
   }
 }
@@ -86,26 +88,28 @@ export const createRLNEncoder = (options: RLNEncoderOptions): RLNEncoder => {
 export class RLNDecoder<T extends IDecodedMessage>
   implements IDecoder<RlnMessage<T>>
 {
-  constructor(
-    private rlnInstance: RLNInstance,
-    private decoder: IDecoder<T>
+  public constructor(
+    private readonly rlnInstance: RLNInstance,
+    private readonly decoder: IDecoder<T>
   ) {}
 
-  get pubsubTopic(): string {
+  public get pubsubTopic(): string {
     return this.decoder.pubsubTopic;
   }
 
-  get contentTopic(): string {
+  public get contentTopic(): string {
     return this.decoder.contentTopic;
   }
 
-  fromWireToProtoObj(bytes: Uint8Array): Promise<IProtoMessage | undefined> {
+  public fromWireToProtoObj(
+    bytes: Uint8Array
+  ): Promise<IProtoMessage | undefined> {
     const protoMessage = this.decoder.fromWireToProtoObj(bytes);
-    log("Message decoded", protoMessage);
+    log.info("Message decoded", protoMessage);
     return Promise.resolve(protoMessage);
   }
 
-  async fromProtoObj(
+  public async fromProtoObj(
     pubsubTopic: string,
     proto: IProtoMessage
   ): Promise<RlnMessage<T> | undefined> {

package/src/contract/abi.ts

@@ -0,0 +1,392 @@
+export const RLN_ABI = [
+  {
+    type: "constructor",
+    inputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "error",
+    name: "DuplicateIdCommitment",
+    inputs: []
+  },
+  {
+    type: "error",
+    name: "InvalidIdCommitment",
+    inputs: [
+      {
+        name: "idCommitment",
+        type: "uint256"
+      }
+    ]
+  },
+  {
+    type: "error",
+    name: "InvalidPaginationQuery",
+    inputs: [
+      {
+        name: "startIndex",
+        type: "uint256"
+      },
+      {
+        name: "endIndex",
+        type: "uint256"
+      }
+    ]
+  },
+  {
+    type: "function",
+    name: "MAX_MEMBERSHIP_SET_SIZE",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint32"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "MERKLE_TREE_DEPTH",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint8"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "Q",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "activeDurationForNewMemberships",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint32"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "currentTotalRateLimit",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "deployedBlockNumber",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint32"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "depositsToWithdraw",
+    inputs: [
+      {
+        name: "holder",
+        type: "address"
+      },
+      {
+        name: "token",
+        type: "address"
+      }
+    ],
+    outputs: [
+      {
+        name: "balance",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "eraseMemberships",
+    inputs: [
+      {
+        name: "idCommitments",
+        type: "uint256[]"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "eraseMemberships",
+    inputs: [
+      {
+        name: "idCommitments",
+        type: "uint256[]"
+      },
+      {
+        name: "eraseFromMembershipSet",
+        type: "bool"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "extendMemberships",
+    inputs: [
+      {
+        name: "idCommitments",
+        type: "uint256[]"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "getMembershipInfo",
+    inputs: [
+      {
+        name: "idCommitment",
+        type: "uint256"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "uint32"
+      },
+      {
+        name: "",
+        type: "uint32"
+      },
+      {
+        name: "",
+        type: "uint256"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getMerkleProof",
+    inputs: [
+      {
+        name: "index",
+        type: "uint40"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "uint256[20]"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "getRateCommitmentsInRangeBoundsInclusive",
+    inputs: [
+      {
+        name: "startIndex",
+        type: "uint32"
+      },
+      {
+        name: "endIndex",
+        type: "uint32"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "uint256[]"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "gracePeriodDurationForNewMemberships",
+    inputs: [],
+    outputs: [
+      {
+        name: "",
+        type: "uint32"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "initialize",
+    inputs: [
+      {
+        name: "_priceCalculator",
+        type: "address"
+      },
+      {
+        name: "_maxTotalRateLimit",
+        type: "uint32"
+      },
+      {
+        name: "_minMembershipRateLimit",
+        type: "uint32"
+      },
+      {
+        name: "_maxMembershipRateLimit",
+        type: "uint32"
+      },
+      {
+        name: "_activeDuration",
+        type: "uint32"
+      },
+      {
+        name: "_gracePeriod",
+        type: "uint32"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "isExpired",
+    inputs: [
+      {
+        name: "_idCommitment",
+        type: "uint256"
+      }
+    ],
+    outputs: [
+      {
+        name: "",
+        type: "bool"
+      }
+    ],
+    stateMutability: "view"
+  },
+  {
+    type: "function",
+    name: "register",
+    inputs: [
+      {
+        name: "idCommitment",
+        type: "uint256"
+      },
+      {
+        name: "rateLimit",
+        type: "uint32"
+      },
+      {
+        name: "idCommitmentsToErase",
+        type: "uint256[]"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "function",
+    name: "registerWithPermit",
+    inputs: [
+      {
+        name: "owner",
+        type: "address"
+      },
+      {
+        name: "deadline",
+        type: "uint256"
+      },
+      {
+        name: "v",
+        type: "uint8"
+      },
+      {
+        name: "r",
+        type: "bytes32"
+      },
+      {
+        name: "s",
+        type: "bytes32"
+      },
+      {
+        name: "idCommitment",
+        type: "uint256"
+      },
+      {
+        name: "rateLimit",
+        type: "uint32"
+      },
+      {
+        name: "idCommitmentsToErase",
+        type: "uint256[]"
+      }
+    ],
+    outputs: [],
+    stateMutability: "nonpayable"
+  },
+  {
+    type: "event",
+    name: "MembershipRegistered",
+    inputs: [
+      {
+        name: "idCommitment",
+        type: "uint256",
+        indexed: false
+      },
+      {
+        name: "rateLimit",
+        type: "uint32",
+        indexed: false
+      },
+      {
+        name: "index",
+        type: "uint256",
+        indexed: false
+      }
+    ],
+    anonymous: false
+  },
+  {
+    type: "event",
+    name: "MembershipRemoved",
+    inputs: [
+      {
+        name: "idCommitment",
+        type: "uint256",
+        indexed: false
+      },
+      {
+        name: "index",
+        type: "uint256",
+        indexed: false
+      }
+    ],
+    anonymous: false
+  }
+];

package/src/contract/constants.ts

@@ -0,0 +1,28 @@
+import { RLN_ABI } from "./abi.js";
+
+export const SEPOLIA_CONTRACT = {
+  chainId: 11155111,
+  address: "0xCB33Aa5B38d79E3D9Fa8B10afF38AA201399a7e3",
+  abi: RLN_ABI
+};
+
+/**
+ * Rate limit tiers (messages per epoch)
+ * Each membership can specify a rate limit within these bounds.
+ * @see https://github.com/waku-org/specs/blob/master/standards/core/rln-contract.md#implementation-suggestions
+ */
+export const RATE_LIMIT_TIERS = {
+  LOW: 20, // Suggested minimum rate - 20 messages per epoch
+  MEDIUM: 200,
+  HIGH: 600 // Suggested maximum rate - 600 messages per epoch
+} as const;
+
+// Global rate limit parameters
+export const RATE_LIMIT_PARAMS = {
+  MIN_RATE: RATE_LIMIT_TIERS.LOW,
+  MAX_RATE: RATE_LIMIT_TIERS.HIGH,
+  MAX_TOTAL_RATE: 160_000, // Maximum total rate limit across all memberships
+  EPOCH_LENGTH: 600 // Epoch length in seconds (10 minutes)
+} as const;
+
+export const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;

package/src/contract/index.ts

@@ -0,0 +1,2 @@
+export { RLNContract } from "./rln_contract.js";
+export * from "./constants.js";