Update overview documentation to more recent stats.
This commit is contained in:
parent
a12b62c24c
commit
329c0bf094
1 changed files with 13 additions and 14 deletions
27
doc.go
27
doc.go
|
@ -5,28 +5,27 @@
|
|||
/*
|
||||
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
|
||||
and over 17 million transactions (which turns out to be over 11GB of data).
|
||||
As of July 2014, there are over 309,000 blocks in the Bitcoin block chain and
|
||||
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
|
||||
simple and efficient manner. The use of this should not require specific
|
||||
knowledge of the database backend.
|
||||
|
||||
Basic Design
|
||||
|
||||
The basic design of btcdb is to provide two classes of items in a
|
||||
database; blocks and transactions (tx) where the block number
|
||||
increases monotonically. Each transaction belongs to a single block
|
||||
although a block can have a variable number of transactions. Along
|
||||
with these two items, several convenience functions for dealing with
|
||||
the database are provided as well as functions to query specific items
|
||||
that may be present in a block or tx.
|
||||
The basic design of btcdb is to provide two classes of items in a database;
|
||||
blocks and transactions (tx) where the block number increases monotonically.
|
||||
Each transaction belongs to a single block although a block can have a variable
|
||||
number of transactions. Along with these two items, several convenience
|
||||
functions for dealing with the database are provided as well as functions to
|
||||
query specific items that may be present in a block or tx.
|
||||
|
||||
Usage
|
||||
|
||||
At the highest level, the use of this packages just requires that you
|
||||
import it, setup a database, insert some data into it, and optionally,
|
||||
query the data back. The first block inserted into the database will be
|
||||
treated as the genesis block. Every subsequent block insert requires the
|
||||
referenced parent block to already exist.
|
||||
At the highest level, the use of this packages just requires that you import it,
|
||||
setup a database, insert some data into it, and optionally, query the data back.
|
||||
The first block inserted into the database will be treated as the genesis block.
|
||||
Every subsequent block insert requires the referenced parent block to already
|
||||
exist.
|
||||
*/
|
||||
package btcdb
|
||||
|
|
Loading…
Reference in a new issue