LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity

Update overview documentation to more recent stats.

Browse source
This commit is contained in:
Dave Collins 2014-07-08 08:54:07 -05:00
parent a12b62c24c
commit 329c0bf094
1 changed files with 13 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
doc.go
View file

@ -5,28 +5,27 @@
/* /*
Package btcdb provides a database interface for the Bitcoin block chain. Package btcdb provides a database interface for the Bitcoin block chain.
As of May 2013, there are over 235,000 blocks in the Bitcoin block chain and As of July 2014, there are over 309,000 blocks in the Bitcoin block chain and
and over 17 million transactions (which turns out to be over 11GB of data). and over 42 million transactions (which turns out to be over 21GB of data).
btcdb provides a database layer to store and retrieve this data in a fairly btcdb provides a database layer to store and retrieve this data in a fairly
simple and efficient manner. The use of this should not require specific simple and efficient manner. The use of this should not require specific
knowledge of the database backend. knowledge of the database backend.
Basic Design Basic Design
The basic design of btcdb is to provide two classes of items in a The basic design of btcdb is to provide two classes of items in a database;
database; blocks and transactions (tx) where the block number blocks and transactions (tx) where the block number increases monotonically.
increases monotonically. Each transaction belongs to a single block Each transaction belongs to a single block although a block can have a variable
although a block can have a variable number of transactions. Along number of transactions. Along with these two items, several convenience
with these two items, several convenience functions for dealing with functions for dealing with the database are provided as well as functions to
the database are provided as well as functions to query specific items query specific items that may be present in a block or tx.
that may be present in a block or tx.
Usage Usage
At the highest level, the use of this packages just requires that you At the highest level, the use of this packages just requires that you import it,
import it, setup a database, insert some data into it, and optionally, setup a database, insert some data into it, and optionally, query the data back.
query the data back. The first block inserted into the database will be The first block inserted into the database will be treated as the genesis block.
treated as the genesis block. Every subsequent block insert requires the Every subsequent block insert requires the referenced parent block to already
referenced parent block to already exist. exist.
*/ */
package btcdb package btcdb