watcher-ts/packages
Nabarun Gogoi c9696c3d9f
Implement failover for RPC endpoints in watcher (#506)
* Handle RPC endpoint server errors and switch failover endpoints

* Add config maxNewBlockRetries for switching to failover endpoint

* Upgrade package versions

* Move unknown events removal after event processing for historical sync

* Rename doFailOverEndpoints to switchClients
2024-05-09 16:03:06 +05:30
..
cache Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
cli Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
codegen Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
graph-node Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
ipld-eth-client Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
peer Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
rpc-eth-client Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
solidity-mapper Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
test Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
tracing-client Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
util Implement failover for RPC endpoints in watcher (#506) 2024-05-09 16:03:06 +05:30
README.md deduplicate the Customize section 2023-01-16 07:40:40 -05:00

Watchers Directory

Here contains all the publicly available watchers for your experimenting purposes. For general information on setting up the stack and the CLI commands used to interact with watchers, see the docs directory.

Customizing Watchers

  • Indexing on an event:

    • Edit the custom hook function handleEvent (triggered on an event) in hooks.ts to perform corresponding indexing using the Indexer object.

    • While using the indexer storage methods for indexing, pass diff as true if default state is desired to be generated using the state variables being indexed.

  • Generating state:

    • Edit the custom hook function createInitialState (triggered if the watcher passes the start block, checkpoint: true) in hooks.ts to save an initial State using the Indexer object.

    • Edit the custom hook function createStateDiff (triggered on a block) in hooks.ts to save the state in a diff State using the Indexer object. The default state (if exists) is updated.

    • Edit the custom hook function createStateCheckpoint (triggered just before default and CLI checkpoint) in hooks.ts to save the state in a checkpoint State using the Indexer object.