2.9 KiB
Watcher CLI commands
Non-exhaustive list of (yarn) CLI commands available for watchers. Assumes you have an environment setup either by hand or using Stack Orchestrator, and have built yarn && yarn build a specific watcher.
If the watcher is an active watcher, run the job-runner:
yarn job-runner
# For development.
yarn server:dev
# For specifying config file.
yarn server -f environments/local.toml
If the watcher is lazy omit the above step, then run the server:
yarn server
This will enable the GraphQL playground at: http://localhost:<port>/graphql
where <port> is set in the environments/local.toml of each watcher.
To watch a contract:
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.kind: Kind of the contract.checkpoint: Turn checkpointing on (true|false).starting-block: Starting block for the contract (default:1).
Example:
Watch a contract with its address and checkpointing on:
yarn watch:contract --address 0x1F78641644feB8b64642e833cE4AFE93DD6e7833 --kind ERC20 --checkpoint true
To fill a block range:
yarn fill --start-block <from-block> --end-block <to-block>
start-block: Block number to start filling from.end-block: Block number till which to fill.
To create a checkpoint for a contract:
yarn checkpoint create --address <contract-address> --block-hash <block-hash>
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).
To verify a checkpoint:
yarn checkpoint verify --cid <checkpoint-cid>
cid: CID of the checkpoint for which to verify.
To reset the watcher to a previous block number:
yarn reset watcher --block-number <previous-block-number>
block-number: Block number to which to reset the watcher.
To reset the job-queue:
yarn reset job-queue
To reset the state:
yarn reset state --block-number <previous-block-number>
Import/Export State
To export and import the watcher state:
In the source watcher, export watcher state:
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.block-number: Block height at which to take snapshot for export.
In the target watcher, run the job-runner:
yarn job-runner
Import watcher state:
yarn import-state --import-file <import-file-path>
import-file: Path of file from which to import the watcher data.
To inspect a CID:
yarn inspect-cid --cid <cid>
cid: CID to be inspected.