flow-archive

README

Flow Data Provisioning Service

The Flow Archive aims at providing a scalable and efficient way to access the history of the Flow execution state, both for current live sporks and for past sporks.

The state of past sporks is indexed by reading an execution node's protocol state and state trie write-ahead log. Optionally, a root checkpoint is required to bootstrap state before a spork's start. In more specific terms, indexing of past sporks requires a Badger key-value database containing the Flow protocol state of the spork and a LedgerWAL with all the trie updates that happened on the spork.

Indexing the live spork works similarly, but it reads the protocol state by acting as a consensus follower, and it reads the execution-related data from records written to a Google Cloud Storage bucket by an execution node.

The Flow DPS maintains multiple specialized indexes for different purposes. Contrary to the execution node's state trie, the index for ledger registers allows random access to the execution state at any block height which enables state retrieval at any point in history, overcoming the pruning limit seen on the execution node.

Documentation

Binaries

Below are links to the individual documentation for the binaries within this repository.

• flow-archive-client
• flow-archive-indexer
• flow-archive-live
• flow-archive-server

APIs

Archive API

The Archive API gives access to historical data at any given height.

• Archive API

There are also additional API layers that can be run on top of the DPS API:

Access API

Flow DPS implements the Flow Access API Specification, except for the following endpoints:

• SendTransaction
• GetLatestProtocolStateSnapshot
• GetExecutionResultForBlockID

It exposes Flow-specific resources such as flow.Block, flow.Event, flow.Transaction and many others.

For more information on the various endpoints of this API, please consult the official Flow documentation.

Developer Documentation

• Introduction
• Architecture
• Database Schema
• Snapshots

Dependencies

Only Linux amd64 builds are supported, because of the dependency to the flow-go/crypto package. Please note that it is also required to make sure that your GOPATH is exported in your environment in order to generate the DPS API.

If you want to make changes to the GRPC API, the following dependencies are required as well.

• buf

Once they are installed, you can run go generate ./... from the root of this repository to update the generated protobuf files.

In order to build the live binary, the following extra steps and dependencies are required:

• CMake

Please note that the flow-go repository should be cloned in the same folder as the DPS with its default name, so that the Go module replace statement works as intended: replace github.com/onflow/flow-go/crypto => ./flow-go/crypto.

• git clone git@github.com:onflow/flow-go.git
• cd flow-go/crypto
• git checkout c0afa789365eb7a22713ed76b8de1e3efaf3a70a
• go generate

You can then verify that the installation of the flow-go crypto package has been successful by running the tests of the project.

Build

You can build every binary by running go build -tags=relic -o . ./... from the root of the repository.