diff --git a/.cspell.json b/.cspell.json index c53d7fe1e4..9bcb16b2b7 100644 --- a/.cspell.json +++ b/.cspell.json @@ -104,6 +104,7 @@ "reactjs", "recid", "rlnrelay", + "rlnv", "roadmap", "sandboxed", "scanf", diff --git a/packages/rln/.eslintrc.cjs b/packages/rln/.eslintrc.cjs index eb0b4b9fae..b274db12d2 100644 --- a/packages/rln/.eslintrc.cjs +++ b/packages/rln/.eslintrc.cjs @@ -6,10 +6,7 @@ module.exports = { ignorePatterns: ["src/resources/**/*"], overrides: [ { - files: ["*.config.ts", "*.config.js"], - rules: { - "import/no-extraneous-dependencies": ["error", { "devDependencies": true }] - } + files: ["*.config.ts", "*.config.js"] } ] }; diff --git a/packages/rln/README.md b/packages/rln/README.md index 3de34d55a1..526bc05e9c 100644 --- a/packages/rln/README.md +++ b/packages/rln/README.md @@ -12,6 +12,14 @@ This package provides RLN functionality for the Waku protocol, enabling rate-lim npm install @waku/rln ``` +## Smart Contract Type Generation + +We use `wagmi` to generate TypeScript bindings for interacting with the RLN smart contracts. When changes are pushed to the `waku-rlnv2-contract` repository, run the following script to fetch and build the latest contracts and generate the TypeScript bindings: + +``` +./generate_contract_abi.sh +``` + ## Usage ```typescript @@ -20,11 +28,6 @@ import { RLN } from '@waku/rln'; // Usage examples coming soon ``` -## Constants - -- Implementation contract: 0xde2260ca49300357d5af4153cda0d18f7b3ea9b3 -- Proxy contract: 0xb9cd878c90e49f797b4431fbf4fb333108cb90e6 - ## License -MIT OR Apache-2.0 \ No newline at end of file +MIT OR Apache-2.0 diff --git a/packages/rln/generate_contract_abi.sh b/packages/rln/generate_contract_abi.sh index 385b56f2b0..3a41c7c4fa 100755 --- a/packages/rln/generate_contract_abi.sh +++ b/packages/rln/generate_contract_abi.sh @@ -3,7 +3,6 @@ set -e # Script to generate contract ABIs from waku-rlnv2-contract -# Usage: ./generate_contract_abi.sh SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" CONTRACT_DIR="$SCRIPT_DIR/waku-rlnv2-contract"