@waku/rln 0.1.3-f6d5deb → 0.1.4-d27db21.0

package/bundle/packages/rln/dist/contract/abi.js

@@ -0,0 +1,394 @@
+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
+    }
+];
+
+export { RLN_ABI };

package/bundle/packages/rln/dist/contract/constants.js

@@ -0,0 +1,27 @@
+import { RLN_ABI } from './abi.js';
+
+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
+ */
+const RATE_LIMIT_TIERS = {
+    LOW: 20, // Suggested minimum rate - 20 messages per epoch
+    MEDIUM: 200,
+    HIGH: 600 // Suggested maximum rate - 600 messages per epoch
+};
+// Global rate limit parameters
+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)
+};
+const DEFAULT_RATE_LIMIT = RATE_LIMIT_PARAMS.MAX_RATE;
+
+export { DEFAULT_RATE_LIMIT, RATE_LIMIT_PARAMS, RATE_LIMIT_TIERS, SEPOLIA_CONTRACT };