streamingfast/firehose-acme

Firehose Starter for new blockchain integrations

What's ACME?

Usage

See documentation on the Firehose docs website.

Release

Use https://github.com/streamingfast/sfreleaser to perform a new release. You can install from source https://github.com/streamingfast/sfreleaser/releases downloading the binary.

However if for now suggest to install from source (the tool sfreleaser is still getting fixes/features):

go install github.com/streamingfast/sfreleaser@latest

It will ask you questions as well as driving all the required commands, performing the necessary operation automatically. The release is pushed in draft mode by default, so you can test check the whole flow before publishing (See configuration file .sfreleaser for some extra details).

You will need to have for releases:

• Docker installed and running
• GitHub CLI tool installed and authenticated with GitHub

The sfreleaser binary checks that those tools exist before doing any work.

Contributing

Issues and PR in this repo related strictly to the Firehose on Dummy Blockchain.

Report any protocol-specific issues in their respective repositories

Please first refer to the general StreamingFast contribution guide, if you wish to contribute to this code base.

This codebase uses unit tests extensively, please write and run tests.

License

Apache 2.0

firehose-acme's Issues

Broken link to ethereum proto

file: https://github.com/streamingfast/firehose-acme/blob/master/INTEGRATION.md

As a reference, here is Ethereum's Protobuf Structure: https://github.com/streamingfast/proto-ethereum/blob/develop/sf/ethereum/codec/v1/codec.proto

Question: why does `firehose` need access to one-block and merged-block storage?

If this data-flow diagram from this page is accurate, the firehose component should only need access to relayer(s), who would in turn fetch data from upstream stroage (and live readers):

However, it looks like the firehose component is requesting storage URLs:

firehose-acme/cmd/fireacme/cli/firehose.go

Lines 108 to 109 in 6966e1a

	OneBlocksStoreURL: MustReplaceDataDir(sfDataDir, viper.GetString("common-one-blocks-store-url")),
	MergedBlocksStoreURL: MustReplaceDataDir(sfDataDir, viper.GetString("common-merged-blocks-store-url")),

Just in case it's requested but not used in the actual code, I tried pointing them to an empty folder, but then the progress stops functioning. So it seems like firehose indeed needs access to those. Is the diagram outdated or am I misunderstanding something here? Much thanks in advance!