Skip to content

Commit 7e5680f

Browse files
committed
fix: update readme
1 parent 9ba3046 commit 7e5680f

File tree

4 files changed

+11
-11
lines changed

4 files changed

+11
-11
lines changed

.cspell.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -104,6 +104,7 @@
104104
"reactjs",
105105
"recid",
106106
"rlnrelay",
107+
"rlnv",
107108
"roadmap",
108109
"sandboxed",
109110
"scanf",

packages/rln/.eslintrc.cjs

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,7 @@ module.exports = {
66
ignorePatterns: ["src/resources/**/*"],
77
overrides: [
88
{
9-
files: ["*.config.ts", "*.config.js"],
10-
rules: {
11-
"import/no-extraneous-dependencies": ["error", { "devDependencies": true }]
12-
}
9+
files: ["*.config.ts", "*.config.js"]
1310
}
1411
]
1512
};

packages/rln/README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,14 @@ This package provides RLN functionality for the Waku protocol, enabling rate-lim
1212
npm install @waku/rln
1313
```
1414

15+
## Smart Contract Type Generation
16+
17+
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:
18+
19+
```
20+
./generate_contract_abi.sh
21+
```
22+
1523
## Usage
1624

1725
```typescript
@@ -20,11 +28,6 @@ import { RLN } from '@waku/rln';
2028
// Usage examples coming soon
2129
```
2230

23-
## Constants
24-
25-
- Implementation contract: 0xde2260ca49300357d5af4153cda0d18f7b3ea9b3
26-
- Proxy contract: 0xb9cd878c90e49f797b4431fbf4fb333108cb90e6
27-
2831
## License
2932

30-
MIT OR Apache-2.0
33+
MIT OR Apache-2.0

packages/rln/generate_contract_abi.sh

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@
33
set -e
44

55
# Script to generate contract ABIs from waku-rlnv2-contract
6-
# Usage: ./generate_contract_abi.sh
76

87
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
98
CONTRACT_DIR="$SCRIPT_DIR/waku-rlnv2-contract"

0 commit comments

Comments
 (0)