Skip to content
Elizabeth edited this page Jan 6, 2021 · 5 revisions

What is Vulcanize DB?

Vulcanize DB is a set of tools that make it easier for developers to write application-specific indexes and caches for distributed apps built on the Ethereum blockchain. Data structures and data encodings that enable Ethereum to be a trustless, distributed virtual machine complicate accessibility and usability of that data for dApp developers. It provides an efficient way to get historical data from the chain by allowing users to extract, transform, persist, and ultimately expose it via a graphQL API.

Update this intro

How can I run vulcanizedb?

  • Local machine
  • Local machine in docker
  • Remote machine
  • Remote machine in docker

update docker compose story vdb-1453

Install steps, requirements, dependencies

existing install steps

What type of hardware do I need to run vulcanizedb?

  • Insert recommended machine resources required

What type of Ethereum Node do I need to run vulcanizedb?

What do each of the subcommands do?

  • Add descriptions of each of the commands like backfillEvents, backfillStorage, extractDiffs, compose, execute, headerSync, and resetHeaderCheckCount?

existing doc about syncing

What is a transformer?

  • Describe the two types of transformers and how they work with vulcanizedb. Explain how headerSync gets all block headers and execute gets all the relevant logs for events and transforms them as well as diffs?

existing doc about custom transformers

How do I create an event transformer?

  • Backfilling data on the new transformer

existing event transformer docs

vdb-1367

How do I create a storage transformer?

existing storage transformer docs

Good backround details in this story vdb-1366

How can I get the data via Postgraphile?

existing Postgraphile docs

Update existing postgraphile docs vdb-1651

  • Explain how to write queries/component tests vdb-1670

Nice to have

Examples of queries vdb-1541

Example app using Postgraphile vdb-1652

How can I contribute to the project?