al-codaio / quickblocks

The main repository for the quickBlocks system

QuickBlocks

QuickBlocks is a collection of software libraries, applications, tools, and examples that allow you to retrieve Ethereum blockchain data (a) more quickly, (b) with higher information content, (c) in an fully decentralized way, (d) in a fully automated way, and (e) in a highly maintenance free way. (For information on building the project, link here.)

More Quickly

QuickBlocks interacts with the Ethereum blockchain via the RPC interface to accumulate blocks, transactions, receipts, and event logs. Prior to storing the data, we optimize it for later retrieval. The primary goal of QuickBlocks is to return the data as quickly as possible while maintaining a fully decentralized stance. These optimizations include:

1. attaching receipts and logs directly to transactions,
2. identifying in-error transactions using the node's trace functionality,
3. pre-processing incoming internal transactions,
4. storing the data optimized for quick, later retrieval.

Depending on the use case, QuickBlocks is able to achieve more than 150 times speedup relative to the node's RPC interface.

Higher Information Content

An Ethereum node knows nothing about Solidity source code. It can only return hexadecimal bytes. In order to make the data useful, each user must re-translate the data back into the language of the smart contract. For example, this complicated RPC data is simply a yes vote on a proposal. While QuickBlocks is able to return raw hexadecimal data identical to the RPC, by default it returns what we call articulated data.

QuickBlocks is able to articulate the data by using the smart contract's ABI file. If available, an ABI file contains all the information necessary to translate the RPC data back into the language of the smart contract. This functionality is implemented in the abilib libary and the grabABI app. Instead of dealing with hashes and merkel roots and sha3, you deal with votes and transfers and withdrawals.

Fully Decentralized

Unlike other block chain scrapers such as http://etherscan.io, QuickBlocks is, by default, fully decentralized. QuickBlocks interacts with only your local Ethereum node. (Although, it can, if you wish, interact with any node such as Infura). This aspect of our system distinguishes QuickBlocks from other options. If you understand and believe in the benefits of decentralization, you will understand why this is important. If you don't, you'll undervalue this aspect of our work.

Fully Automatic (Yet Customizable)

The source code for all of the functionality mentioned above is generated automatically (i.e. programmatically) using the grabABI and makeClass apps. This makes standing up a monitor for any smart contract (or system of smart contracts) trivial. With a one line command to chifra, a fully functional C++ static library is created. At the same time, because the generated code is fairly simple C++ code, it is fully customizable.

Low Maintenance

Every smart contract, once deployed, is immutable. That means that the automatically generated C++ code is also immutable (if you want it to). You could literally automatically generate a data delivery layer for your smart contract that requires no further interaction. It can simply run forever, standing off-chain, but beside your smart contract, and deliver all your contact's data at high speed.

Structure of the Project

1. src - source code for the QuickBlocks libraries, core applications, tools, and sample monitors.
2. bin - location of primary executables generated by QuickBlocks
3. docs - documentation