watcher-ts/packages
Nabarun Gogoi ceb0a3de23
Add CLI tool to compare watcher GQL responses (#494)
* Integrate gql response compare tool

* Add README for compare-gql tool

* Update readme

* Update CLI output logs

---------

Co-authored-by: neeraj <neeraj.rtly@gmail.com>
2023-11-28 09:51:26 +05:30
..
cache Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
cli Add CLI tool to compare watcher GQL responses (#494) 2023-11-28 09:51:26 +05:30
codegen Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
graph-node Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
ipld-eth-client Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
peer Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
rpc-eth-client Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
solidity-mapper Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
test Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
tracing-client Fix events processing error check in historical processing (#491) 2023-11-26 12:42:43 +05:30
util Publish events for GQL subscription in historical processing (#492) 2023-11-27 14:13:02 +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.