https://github.com/protolambda/eth2-crawl
Eth2 crawl
https://github.com/protolambda/eth2-crawl
Last synced: 5 months ago
JSON representation
Eth2 crawl
- Host: GitHub
- URL: https://github.com/protolambda/eth2-crawl
- Owner: protolambda
- License: mit
- Created: 2020-08-14T00:48:21.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2020-10-20T01:00:11.000Z (over 4 years ago)
- Last Synced: 2023-04-06T05:28:37.088Z (about 2 years ago)
- Language: Go
- Homepage:
- Size: 91.8 KB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Eth2-crawl
A server to collect Rumor data, and serve it for other applications to use.
## Usage
`go run . --serve-addr=0.0.0.0:5000 --producer-key=foobar --consumer-key=example`
## Routes
- `/user/ws`: websocket for consuming applications to get peerstore changes as flattened events
- `/peerstore/input/ws`: websocket for rumor peerstore tee: `peer track tee --dest=wsjson --path=ws://0.0.0.0:5000/peerstore/input/ws --key=foobar`
- `/peerstore/latest`: GET latest aggregate peerstore json
- `/peerstore/history`: GET latest aggregate peerstore history json (flattened events)
flattened events format: `[source_address, 'put'/'del', time_ms, peer_id, key, value]`
API keys are simple for now:
- One for producers, one for consumers. This may be expanded with api-users later, but is sufficient for now.
- Keys are put in the `X-Api-Key` header.
## License
MIT, see [`LICENSE`](./LICENSE) file.