Technical Reference¶

QuickBlocks is a collection of software libraries, command-line tools, and applications. The command-line tools, while very useful in their own right, are primarily intended to serve as instructional material helping you understand how to use the libraries to accomplish various tasks. The applications are more full-featured and provide useful functions such as providing a fully-decentralized block chain scraper (blockScrape), automatic generation of source code that comprises the libraries, and the libraries themselves which, while largely auto-generated provide most of the function. Each of these apsects of QuickBlocks is described below. We intend to make the libraries and tools open source. The applications will be commercial products.

Command-Line Tools¶

The command-line tools present direct access to the Ethereum data structures while providing many options and export formats. They can be broken down into the following major groups:

Applications¶

QuickBlocks tools are intended primarily sample source code to help you understand how to program using the QuickBlocks libraries. QuickBlocks applications are more full-featured applications that accomplish specific tasks: scraping the chain, building cached databases for quick retrieval of the data, etc. The other thing that distinguishes applications from tools is that while the tools and the QuickBlocks libraries are open source, the applications are sold through our website.

blockScraper application¶

The blockScrape application scrapes the Ethereum blockchain creating three different databases that help the other tools and applications quickly access and deliver the Ethereum shared ledger to your applications. This process is fully described in our three white papers. This tool is not open source. It is available for purchase from our website.

grabABI application¶

The grabABI program pulls your smart contract’s ABI file from either Etherscan or (in the future) the ENS smart contract. Many things are possible with your smart contract’s ABI file including automatic generation of source code needed to build a fully functional smart contract monitor / debugger. grabABI also is able to encode and decode the functional and event signatures needed to fully parse the blockchain data returned through the RPC. This tool is not open source. It is available for purchase from our website.

makeClass application¶

The makeClass application takes a class definition file and generates a fully detailed, self describing, easily serializable C++ class that carries all the information necessary to store the entire Ethereum blockchain. Surprisingly, nearly 75% of all of the code that makes up the QuickBlocks libraries is generated automatically through the use of the makeClass application. In conjunction with the grabABI application an makeClass all of the code in both the token library and the wallet library was generated automatically with from simple configuration files. An important thing to note is that grabABI and makeClass can be used to create a full parsing / monitoring library for your smart contracts. With a simple command line pointing to your ABI file, a full feature smart contract monitor / transaction debugger may be created. Here is an example of a makeClass class definition file:
[settings]
class      = CBlock
fields     = gas gasLimit|gas gasUsed|hash hash|bloom logsBloom|uint32 blockNumber|hash parentHash|timestamp timestamp|CTransactionArray transactions
includes   = ethtypes.h|abilib.h|transaction.h
c_includes = etherlib.h
scope      = extern
serialize  = true


Smart contract monitors / transaction debuggers¶

While not yet fully ready, QuickBlocks provides a very powerful technology that we call smart contract monitors or transactional debuggers. After recording the full history of every internal and external transactions on your smart contracts (or collection of smart contracts and other addresses), a QuickBlocks monitor is able to replay the transactions step by step. At each block, the monitor may do a full “bank reconciliation” asking the node for account balances and double checking those balances against the transaction history of those accounts. At any block, if the account balances don’t match, then the most likely cause is a bug in our code–in fact, finding these kind of mismatches allows us to improve our code. We highly doubt we will find a bug in the Ethereum node (but, boy, wouldn’t that be amazing?). We do however think that there are bugs to be found in the various smart contracts. We believe QuickBlocks monitors can find and warn users about various types of smart contract bugs by doing a token reconciliation at the end of each block. The recursive DAO bug exhibited an incorrect relationship on the first block of the hack. Humans didn’t notice it for six hours. QuickBlocks could have identified it on the first block.

Libraries¶

utillib¶

The most basic functionality is contained in a library called utillib. This library consists of software code for carrying out common functions such as string and time manipulation; concurrency-protected data access; container classes such as lists, arrays and maps; and other utility functionality.

etherlib¶

The second library component is called etherlib. This library allows for reading, writing, and manipulation of application binary interface (ABI) files. This library also mirrors the blocks, transactions, receipts, traces, and accounts found in the blockchain data. It is in the etherlib that we interact directly with the blockchain via RPC. We do this in order to collect raw blockchain data, which is then enhanced so as to provide more useful data to higher-level components such as the tokenlib; the customized, per-smart-contract libraries; and the various applications. It is the job of etherlib to provide faster access to the data, and many speed optimizations, in addition to a collection of easy-to-use interfaces for traversing the blocks, transactions, and accounts, are contained in this library.

tokenlib / walletlib¶

The final two pre-compiled libraries are called tokenlib and walletlib, which implement support for the Ethereum ERC 20 token standard and popular multi-sig wallets.