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
78e43bc088
watcher-ts/packages
History
prathamesh0 78e43bc088
Export metrics for watcher config and upstream and external chain heads (#497) 
* Add a cli to export chain head block numbers

* Use ETH RPC endpoint and allow env overrides

* Use ethers provider

* Export upstream chain head block number in watcher metrics

* Remove unnecessary exports

* Upgrade package versions

* Fix defaults usage

* Export watcher config in metrics

* Add metric for watcher sync mode

* Remove cache flag from watcher config metrics

* Update watcher config field names
2023-12-19 15:23:25 +05:30
..
cache Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
cli Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
codegen Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
graph-node Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
ipld-eth-client Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
peer Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
rpc-eth-client Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
solidity-mapper Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
test Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
tracing-client Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +05:30
util Export metrics for watcher config and upstream and external chain heads (#497) 2023-12-19 15:23:25 +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.