From 35cecc9b7185f21b24c3e22197aa8addce2ae41f Mon Sep 17 00:00:00 2001 From: Eduard Voiculescu Date: Tue, 16 Jul 2024 10:15:17 -0400 Subject: [PATCH] update readme with clear and consice on how to run the stack --- README.md | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8c52eb4..ab480d1 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,40 @@ # Firehose for Starknet + [![reference](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://pkg.go.dev/github.com/streamingfast/firehose-solana) [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) +Quickstart with Firehose for Starknet can be found in the official Firehose docs. Here some quick links to it: + +- [Firehose Overview](https://firehose.streamingfast.io/introduction/firehose-overview) +- [Concepts & Architectures](https://firehose.streamingfast.io/concepts-and-architeceture) + - [Components](https://firehose.streamingfast.io/concepts-and-architeceture/components) + - [Data Flow](https://firehose.streamingfast.io/concepts-and-architeceture/data-flow) + - [Data Storage](https://firehose.streamingfast.io/concepts-and-architeceture/data-storage) + - [Design Principles](https://firehose.streamingfast.io/concepts-and-architeceture/design-principles) + +# Running the Firehose poller + +The below command with start streaming Firehose Starknet blocks, check `proto/sf/starknet/type/v1/block.proto` for more information. + +```bash +firestark fetch $FIRST_STREAMABLE_BLOCK --state-dir $STATE_DIR --block-fetch-batch-size=1 --interval-between-fetch=0s --latest-block-retry-interval=10s --starknet-endpoints $STARKNET_RPC_ENDPOINT --eth-endpoints $ETH_ENDPOINT +# FIRST_STREAMABLE_BLOCK: this would often be set to 0 +# STATE_DIR: Location to store the Firehose Starknet blocks +# STARKNET_RPC_ENDPOINT: RPC Endpoint for Starknet to make calls to fetch blocks with receitps, state udpdate, block number and latest block number +# ETH_ENDPOINT: L1 ETH RPC Endpoint to fetch the L1 accept block +``` + +## Contributing + +Report any protocol-specific issues in their +[respective repositories](https://github.com/streamingfast/streamingfast#protocols) + +**Please first refer to the general +[StreamingFast contribution guide](https://github.com/streamingfast/streamingfast/blob/master/CONTRIBUTING.md)**, +if you wish to contribute to this code base. ### License -[Apache 2.0](LICENSE) \ No newline at end of file + +[Apache 2.0](LICENSE)