From a68f7c02a5f539bddf28e6a038ee6086ea89e116 Mon Sep 17 00:00:00 2001 From: Charles Billette Date: Tue, 8 Oct 2024 09:04:32 -0400 Subject: [PATCH] Update README.md with Vara Firehose details Revised the README.md to include quick start information for Firehose on the Vara blockchain, along with relevant links to the official Firehose documentation. Additionally, added specific poller commands for Vara, Mantra, and Injective blockchains. --- README.md | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index fe41fe7..f3a96f1 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,34 @@ - StreamingFast Fireshose Banner + StreamingFast Firehose Banner -# Firehose for Injective -[![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) +# Firehose for Cosmos chain +[![reference](https://img.shields.io/badge/godoc-reference-5272B4.svg?style=flat-square)](https://pkg.go.dev/github.com/streamingfast/firehose-vara) + +Quick start with Firehose for Vara 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) + +# Block definition `cosmos/proto/sf/cosmos/type/v2/block.proto` + +# Running the Firehose poller for Injective +```bash +fireinjective fetch {FIRST_STREAMABLE_BLOCK} --endpoints {VARA_RPC_ENDPOINT} --state-dir {STATE_DIR} +``` + +# Running the Firehose poller for Mantra +```bash +firemantra fetch {FIRST_STREAMABLE_BLOCK} --endpoints {VARA_RPC_ENDPOINT} --state-dir {STATE_DIR} +``` + +# Running the Firehose poller for injective +```bash +fireinjective fetch {FIRST_STREAMABLE_BLOCK} --endpoints {VARA_RPC_ENDPOINT} --state-dir {STATE_DIR} +``` -### License -[Apache 2.0](LICENSE) \ No newline at end of file