mirror of
https://github.com/logos-messaging/js-waku.git
synced 2026-01-02 13:53:12 +00:00
fix: update readme
This commit is contained in:
parent
aa1e19739a
commit
64aef7b2a2
@ -104,6 +104,7 @@
|
||||
"reactjs",
|
||||
"recid",
|
||||
"rlnrelay",
|
||||
"rlnv",
|
||||
"roadmap",
|
||||
"sandboxed",
|
||||
"scanf",
|
||||
|
||||
@ -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"]
|
||||
}
|
||||
]
|
||||
};
|
||||
|
||||
@ -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
|
||||
MIT OR Apache-2.0
|
||||
|
||||
@ -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"
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user