fix: update readme

This commit is contained in:
Arseniy Klempner 2025-11-05 09:39:25 +01:00
parent aa1e19739a
commit 64aef7b2a2
No known key found for this signature in database
GPG Key ID: 51653F18863BD24B
4 changed files with 11 additions and 11 deletions

View File

@ -104,6 +104,7 @@
"reactjs", "reactjs",
"recid", "recid",
"rlnrelay", "rlnrelay",
"rlnv",
"roadmap", "roadmap",
"sandboxed", "sandboxed",
"scanf", "scanf",

View File

@ -6,10 +6,7 @@ module.exports = {
ignorePatterns: ["src/resources/**/*"], ignorePatterns: ["src/resources/**/*"],
overrides: [ overrides: [
{ {
files: ["*.config.ts", "*.config.js"], files: ["*.config.ts", "*.config.js"]
rules: {
"import/no-extraneous-dependencies": ["error", { "devDependencies": true }]
}
} }
] ]
}; };

View File

@ -12,6 +12,14 @@ This package provides RLN functionality for the Waku protocol, enabling rate-lim
npm install @waku/rln 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 ## Usage
```typescript ```typescript
@ -20,11 +28,6 @@ import { RLN } from '@waku/rln';
// Usage examples coming soon // Usage examples coming soon
``` ```
## Constants
- Implementation contract: 0xde2260ca49300357d5af4153cda0d18f7b3ea9b3
- Proxy contract: 0xb9cd878c90e49f797b4431fbf4fb333108cb90e6
## License ## License
MIT OR Apache-2.0 MIT OR Apache-2.0

View File

@ -3,7 +3,6 @@
set -e set -e
# Script to generate contract ABIs from waku-rlnv2-contract # Script to generate contract ABIs from waku-rlnv2-contract
# Usage: ./generate_contract_abi.sh
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
CONTRACT_DIR="$SCRIPT_DIR/waku-rlnv2-contract" CONTRACT_DIR="$SCRIPT_DIR/waku-rlnv2-contract"