cerc-io/watcher-ts
16
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2025-01-06 19:38:05 +00:00
Code Issues Packages Projects Releases Wiki Activity
7884941e75
watcher-ts/packages
History
Nabarun Gogoi 7884941e75
Update codegen to add subgraph source to watcher readme (#514) 
* Update codegen to add subgraph source to watcher readme

* Update exported metrics for watcher config

* Add steps to update package json and config to codegen instructions

---------

Co-authored-by: Prathamesh Musale <prathamesh.musale0@gmail.com>
2024-06-11 14:42:54 +05:30
..
cache Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
cli Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
codegen Update codegen to add subgraph source to watcher readme (#514) 2024-06-11 14:42:54 +05:30
graph-node Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
ipld-eth-client Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
peer Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
rpc-eth-client Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
solidity-mapper Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
test Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
tracing-client Add a config option for block processing offset (#520) 2024-06-10 15:09:33 +05:30
util Update codegen to add subgraph source to watcher readme (#514) 2024-06-11 14:42:54 +05:30
README.md deduplicate the Customize section 2023-01-16 07:40:40 -05:00

README.md

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.