55 lines
1.8 KiB
Go
55 lines
1.8 KiB
Go
// Copyright (c) 2013 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 used although currently only db_sqlite is
|
|
provided.
|
|
|
|
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 (although many of these are in
|
|
the db_sqlite subpackage).
|
|
|
|
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. In a more concrete example:
|
|
|
|
// Import packages.
|
|
import (
|
|
"github.com/conformal/btcdb"
|
|
_ "github.com/conformal/btcdb/sqlite3"
|
|
)
|
|
|
|
// Create a database and schedule it to be closed on exit.
|
|
dbName := "example.db"
|
|
db, err := btcdb.CreateDB("sqlite", dbName)
|
|
if err != nil {
|
|
// Log and handle the error
|
|
}
|
|
defer db.Close()
|
|
|
|
// Insert a block.
|
|
newHeight, err := db.InsertBlock(block)
|
|
if err != nil {
|
|
// Log and handle the error
|
|
}
|
|
|
|
// Sync the database.
|
|
db.Sync()
|
|
*/
|
|
package btcdb
|