watcher-ts/packages
Nabarun Gogoi 11930c0107
Expose peer instance in server CLI and add nitro config options (#390)
* Expose peer instance in server CLI and add nitro config options

* Update package versions

---------

Co-authored-by: prathamesh0 <prathamesh.musale0@gmail.com>
2023-07-13 15:30:31 +05:30
..
cache Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
cli Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
codegen Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
graph-node Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
ipld-eth-client Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
peer Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
solidity-mapper Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
test Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
tracing-client Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +05:30
util Expose peer instance in server CLI and add nitro config options (#390) 2023-07-13 15:30:31 +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.