Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Matlefebvre1234 authored Aug 14, 2024
1 parent 336493b commit c9d14e2
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@

- [ClickHouse](clickhouse.com/), databases should follow a `{chain}_tokens_{version}` naming scheme. Database tables can be setup using the [`schema.sql`](./schema.sql) definitions created by the [`create_schema.sh`](./create_schema.sh) script.
- A [Substream sink](https://substreams.streamingfast.io/reference-and-specs/glossary#sink) for loading data into ClickHouse. We recommend [Substreams Sink ClickHouse](https://github.com/pinax-network/substreams-sink-clickhouse/) or [Substreams Sink SQL](https://github.com/pinax-network/substreams-sink-sql). You should use the generated [`protobuf` files](tsp-output/@typespec/protobuf) to build your substream. This Token API makes use of the [`erc20-substreams`](https://github.com/pinax-network/erc20-substreams) substream.
- [A Substreams API Token provider](https://pinax.network) to stream blockchains Data.

### API stack architecture

Expand Down Expand Up @@ -73,6 +74,11 @@ cat /tmp/schema.sql | clickhouse client -h <host> --port 9000 -d <database> -u <

5. Run the [sink](https://github.com/pinax-network/substreams-sink-sql)


```console
export SUBSTREAMS_TOKEN= "YOUR_SUBSTREAMS_TOKEN"
```

```console
substreams-sink-sql run clickhouse://<username>:<password>@<host>:9000/eth_tokens_v1 \
https://github.com/pinax-network/erc20-substreams/releases/download/v0.0.2/erc20-substreams-v0.0.2.spkg `#Substreams package` \
Expand Down

0 comments on commit c9d14e2

Please sign in to comment.