mirror of
https://github.com/cerc-io/watcher-ts
synced 2024-10-03 06:32:36 +00:00
21 lines
1.2 KiB
Markdown
21 lines
1.2 KiB
Markdown
|
# 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](/docs) directory.
|
||
|
|
|
||
|
|
## Customizing Watchers
|
||
|
|
|
||
|
|
* Indexing on an event:
|
||
|
|
|
||
|
|
* Edit the custom hook function `handleEvent` (triggered on an event) in [hooks.ts](./src/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](./src/hooks.ts) to save an initial `State` using the `Indexer` object.
|
||
|
|
|
||
|
|
* Edit the custom hook function `createStateDiff` (triggered on a block) in [hooks.ts](./src/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](./src/hooks.ts) to save the state in a `checkpoint` `State` using the `Indexer` object.
|
||
|
|
|