update readmes

This commit is contained in:
zramsay 2022-12-21 08:07:42 -05:00
parent 38daa31029
commit a1deb17e4b
No known key found for this signature in database
GPG Key ID: FECD2DBFAE9DBE63
3 changed files with 44 additions and 42 deletions

View File

@ -1,58 +1,57 @@
# watcher-ts
![Cute Panopticon](./docs/watchers-graphic.png)
Watchers make managing data in Dapp development as frictionless as possible. They do this by querying, transforming, and caching Ethereum state data cheaper and faster compared to existing solutions. This data also comes with evidence for generating cryptographic proofs to provide verification that the data is authentic. Public watchers are found in the [packages](./packages) directory.
Go [here](https://github.com/cerc-io/stack-orchestrator/tree/main/stacks/erc20) for a quick start demo of setting up the stack and deploying/using the erc20 watcher via the Laconic Stack Orchestrator.
## Prerequisites
### User Mode
- `laconic-so` [Install](https://github.com/cerc-io/stack-orchestrator#setup)
The Laconic Stack Orchestrator provides all the tools to quickly get started with watchers.
### Developer Mode
- `yarn` [Install](https://yarnpkg.com/getting-started/install)
- `postgres` [Install](https://www.postgresql.org/download/)
You'll need the above if you plan on digging into this repo and/or writing your own watchers.
## Services
The default configuration files used by watchers assume the following services are setup and running on localhost:
* [cerc-io/go-ethereum](https://github.com/cerc-io/go-ethereum/tree/v1.10.25-statediff-v4) on port 8545
* [cerc-io/ipld-eth-server](https://github.com/cerc-io/ipld-eth-server) with native GQL API enabled, on port 8082
* [cerc-io/ipld-eth-db](https://github.com/cerc-io/ipld-eth-db) to populate the postgres database for `ipld-eth-server`
These services are dockerized by the Laconic Stack Orchestrator (`laconic-so`). [Use it](https://github.com/cerc-io/stack-orchestrator) unless you plan on digging into those codebases.
## Setup
This project uses [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/).
From the root of this repository, run:
Install packages (Node.JS v16.13.1):
`yarn && yarn build`
```bash
yarn
```
to download dependencies and build all the watchers.
Build packages:
Each watcher has a README with instruction on building and using it. See the [packages](./packages) directory for all available watchers.
```bash
yarn build
```
[//]: # (TODO: ## Generating Watchers)
## Tests
* [graph-node](./packages/graph-node/README.md)
## Services
[//]: # (TODO: ## Contibuting: https://github.com/LaconicNetwork/Laconic-Documentation/issues/93)
The default config files used by the watchers assume the following services are setup and running on localhost:
## Further Reading
* `vulcanize/go-ethereum` on port 8545
* `vulcanize/ipld-eth-server` with native GQL API enabled, on port 8082
[//]: # (TODO: link to docs.laconic.com when ready)
### Note
* In `vulcanize/ipld-eth-server`, add the following statement to `[ethereum]` section in `environments/config.toml`:
`chainConfig = "./chain.json" # ETH_CHAIN_CONFIG`
## Watchers
* [eden-watcher](./packages/eden-watcher/README.md)
* [erc20-watcher](./packages/erc20-watcher/README.md)
* [erc721-watcher](./packages/erc721-watcher/README.md)
* [graph-test-watcher](./packages/graph-test-watcher/README.md)
* [mobymask-watcher](./packages/mobymask-watcher/README.md)
## Development
* To update versions in all packages run the following:
```bash
yarn version:set <VERSION>
yarn version:set-codegen <VERSION>
```
Example
```bash
yarn version:set 0.2.20
yarn version:set-codegen 0.2.20
```
- [Watchers Blog Post](https://www.laconic.com/blog/laconic-watchers)

3
docs/README.md Normal file
View File

@ -0,0 +1,3 @@
# Watcher Documentation
## Coming Soon

BIN
docs/watchers-graphic.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 MiB