mirror of
https://github.com/kaspanet/kaspad.git
synced 2025-03-30 15:08:33 +00:00
9ed908f44a
This commit moves the example to a test file so it integrates nicely with Go's example tooling. This allows the example output to be tested as a part of running the normal Go tests to help ensure it doesn't get out of date with the code. It is also nice to have the example in one place rather than repeating it in doc.go and README.md. Links and information about the example have been included in README.md in place of the example.
33 lines
1.3 KiB
Go
33 lines
1.3 KiB
Go
// Copyright (c) 2013-2014 Conformal Systems LLC.
|
|
// Use of this source code is governed by an ISC
|
|
// license that can be found in the LICENSE file.
|
|
|
|
/*
|
|
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).
|
|
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.
|
|
|
|
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.
|
|
*/
|
|
package btcdb
|