cerc-io/watcher-ts
10
1
Fork 0
mirror of https://github.com/cerc-io/watcher-ts synced 2025-07-27 02:32:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

moar cli & complete address-watcher README

Browse Source
This commit is contained in:
zramsay 2023-01-10 08:31:58 -05:00
parent 85452a870f
commit dd9f85f268
No known key found for this signature in database
GPG Key ID: FECD2DBFAE9DBE63
2 changed files with 93 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

176
docs/cli.md
View File

@ -1,137 +1,127 @@
## Watcher CLI commands (yarn) ## Watcher CLI commands
* Run the server: Non-exhaustive list of (yarn) CLI commands available for watchers. Assumes you have an environment setup either [by hand](./README.md) or using [Stack Orchestrator](https://github.com/cerc-io/stack-orchestrator), and have built `yarn && yarn build` a specific watcher.
```bash If the watcher is an `active` watcher, run the job-runner:
yarn server
```
GQL console: http://localhost:3008/graphql ```bash
yarn job-runner
```
* If the watcher is an `active` watcher: ```
# For development.
yarn server:dev
* Run the job-runner: # For specifying config file.
yarn server -f environments/local.toml
```
```bash If the watcher is `lazy` omit the above step, then run the server:
yarn job-runner
```
* Run the server: ```bash
yarn server
```
```bash This will enable the GraphQL playground at: `http://localhost:<port>/graphql`
yarn server
```
GQL console: http://localhost:3008/graphql where `<port>` is set in the `environments/local.toml` of each watcher.
* To watch a contract: To watch a contract:
```bash ```bash
yarn watch:contract --address <contract-address> --kind <contract-kind> --checkpoint <true | false> --starting-block [block-number] yarn watch:contract --address <contract-address> --kind <contract-kind> --checkpoint <true | false> --starting-block <block-number>
``` ```
* `address`: Address or identifier of the contract to be watched. * `address`: Address or identifier of the contract to be watched.
* `kind`: Kind of the contract. * `kind`: Kind of the contract.
* `checkpoint`: Turn checkpointing on (`true` | `false`). * `checkpoint`: Turn checkpointing on (`true` | `false`).
* `starting-block`: Starting block for the contract (default: `1`). * `starting-block`: Starting block for the contract (default: `1`).
Examples: Example:
Watch a contract with its address and checkpointing on: Watch a contract with its address and checkpointing on:
```bash ```bash
yarn watch:contract --address 0x1F78641644feB8b64642e833cE4AFE93DD6e7833 --kind ERC20 --checkpoint true yarn watch:contract --address 0x1F78641644feB8b64642e833cE4AFE93DD6e7833 --kind ERC20 --checkpoint true
``` ```
Watch a contract with its identifier and checkpointing on: To fill a block range:
```bash ```bash
yarn watch:contract --address MyProtocol --kind protocol --checkpoint true yarn fill --start-block <from-block> --end-block <to-block>
``` ```
* To fill a block range: * `start-block`: Block number to start filling from.
* `end-block`: Block number till which to fill.
```bash To create a checkpoint for a contract:
yarn fill --start-block <from-block> --end-block <to-block>
```
* `start-block`: Block number to start filling from. ```bash
* `end-block`: Block number till which to fill. yarn checkpoint create --address <contract-address> --block-hash <block-hash>
```
* To create a checkpoint for a contract: * `address`: Address or identifier of the contract for which to create a checkpoint.
* `block-hash`: Hash of a block (in the pruned region) at which to create the checkpoint (default: latest canonical block hash).
```bash To verify a checkpoint:
yarn checkpoint create --address <contract-address> --block-hash [block-hash]
```
* `address`: Address or identifier of the contract for which to create a checkpoint. ```bash
* `block-hash`: Hash of a block (in the pruned region) at which to create the checkpoint (default: latest canonical block hash). yarn checkpoint verify --cid <checkpoint-cid>
```
* To verify a checkpoint: * `cid`: CID of the checkpoint for which to verify.
```bash To reset the watcher to a previous block number:
yarn checkpoint verify --cid <checkpoint-cid>
```
`cid`: CID of the checkpoint for which to verify. ```bash
yarn reset watcher --block-number <previous-block-number>
```
* To reset the watcher to a previous block number: * `block-number`: Block number to which to reset the watcher.
* Reset watcher: To reset the job-queue:
```bash ```bash
yarn reset watcher --block-number <previous-block-number> yarn reset job-queue
``` ```
* Reset job-queue: To reset the state:
```bash ```bash
yarn reset job-queue yarn reset state --block-number <previous-block-number>
``` ```
* Reset state: ## Import/Export State
```bash To export and import the watcher state:
yarn reset state --block-number <previous-block-number>
```
* `block-number`: Block number to which to reset the watcher. In the source watcher, export watcher state:
* To export and import the watcher state: ```bash
yarn export-state --export-file [export-file-path] --block-number [snapshot-block-height]
```
* In source watcher, export watcher state: * `export-file`: Path of file to which to export the watcher data.
* `block-number`: Block height at which to take snapshot for export.
```bash In the target watcher, run the job-runner:
yarn export-state --export-file [export-file-path] --block-number [snapshot-block-height]
```
* `export-file`: Path of file to which to export the watcher data. ```bash
* `block-number`: Block height at which to take snapshot for export. yarn job-runner
```
* In target watcher, run job-runner: Import watcher state:
```bash ```bash
yarn job-runner yarn import-state --import-file <import-file-path>
``` ```
* Import watcher state: * `import-file`: Path of file from which to import the watcher data.
```bash To inspect a CID:
yarn import-state --import-file <import-file-path>
```
* `import-file`: Path of file from which to import the watcher data. ```bash
yarn inspect-cid --cid <cid>
```
* Run server: * `cid`: CID to be inspected.
```bash
yarn server
```
* To inspect a CID:
```bash
yarn inspect-cid --cid <cid>
```
* `cid`: CID to be inspected.

35
packages/address-watcher/README.md
View File

@ -4,45 +4,30 @@
First try the [stack orchestrator](https://github.com/cerc-io/stack-orchestrator) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand. First try the [stack orchestrator](https://github.com/cerc-io/stack-orchestrator) to quickly get started. Advanced users can see [here](/docs/README.md) for instructions on setting up a local environment by hand.
## Run
Run the following scripts in different terminals.
Build files: Build files:
``` ```bash
yarn build yarn && yarn build
``` ```
GQL server: ## Run
``` Run the following commands in different terminals:
GraphQL server:
```bash
yarn server yarn server
# For development.
yarn server:dev
# For specifying config file.
yarn server -f environments/local.toml
``` ```
Job runner for processing the tracing requests queue: Job runner for processing the tracing requests queue:
``` ```bash
yarn job-runner yarn job-runner
# For development.
yarn job-runner:dev
# For specifying config file.
yarn job-runner -f environments/local.toml
``` ```
To fill a block range: To fill a block range:
``` ```bash
yarn fill --start-block 1 --end-block 1000 yarn fill --start-block 1 --end-block 1000
# For specifying config file.
yarn fill -f environments/local.toml --start-block 1 --end-block 1000
``` ```