https://github.com/angleprotocol/merkl-dispute
https://github.com/angleprotocol/merkl-dispute
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/angleprotocol/merkl-dispute
- Owner: AngleProtocol
- License: gpl-3.0
- Created: 2023-07-17T09:40:58.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-06T09:30:31.000Z (about 2 years ago)
- Last Synced: 2024-06-06T11:03:31.430Z (about 2 years ago)
- Language: TypeScript
- Size: 1.03 MB
- Stars: 1
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Merkl Dispute bot
## How does it work?
The bot runs when a dispute period is ongoing and checks if the merkle root submitted on chain is correct.
If the data is incorrect or it is unable to fetch enough data to be able to make the checks, it will send a dispute.
## What is a dispute ?
A dispute is a halt of the merkl root update on the contract, which allows the DAO to come in and resolve the conflict.
This mechanism can prevent a malicious or accidental update of the new reward data which might be invalid.
## Pre-requisites
You must provide some necessary environment variables (see [.env.example](./.env.example)):
```env
PORT= 5002
ENV= 'prod'
CHAINID= 1
DISPUTE_BOT_PRIVATE_KEY= ""
PROVIDER_137= ""
PROVIDER_10= ""
PROVIDER_1= ""
PROVIDER_42161= ""
PROVIDER_1101= ""
```
## Run the bot
Install the dependencies and build the bot:
```bash
yarn install
yarn build
```
```bash
yarn bot diff --chain 1 --from 1695734659 --to 1695821059 --gist
```
### Every n seconds
Run the bot periodically (recommended interval is 1 hour):
```bash
yarn bot watch --chain --time
```
### As a one-time check
You can also run the bot once to try to dispute the latest block or check the bot against a previous block:
```bash
yarn bot run --chain
yarn bot run --chain --block
```
### Compare two points in time
You can compare two points in time and generate a diff table, using `--gist` requires `KEEPER_GITHUB_AUTH_TOKEN` env variable.
```bash
yarn bot diff --chain --from --to
yarn bot diff --chain --from --to --gist
```
### As a server
Run the bot as an Express server to call a dispute check from an HTTP request:
```bash
yarn bot serve
```
`chain` and `blockNumber` parameters are optional, if not provided, the chain will be set from the environement variable `CHAINID`, the blockNumber as the latest one.
```http
GET http://localhost:5002/
GET http://localhost:5002//
GET http://localhost:5002//
```
## Optional logging tools
The bot supports Discord logging and gist creation for the diff tables, enable those features by providing env variables `DISCORD_TOKEN`, `DISCORD_LOG_CHANNEL`, `DISCORD_ALERT_CHANNEL` and `KEEPER_GITHUB_AUTH_TOKEN` respectively.
