lbcd/blockchain
Dave Collins 279308288c blockchain: Provide new IsCoinBaseTx function.
This commit adds a new function to the blockchain package named
IsCoinBaseTx which performs the same function as IsCoinBase except it
takes raw wire transactions as opposed to the higher level util
transactions.

While here, it also adds a file for benchmarks along with a couple of
benchmarks for the IsCoinBase and IsCoinBaseTx functions.

Finally, the function was very slightly optimized:

BenchmarkIsCoinBaseOld  100000000  10.7 ns/op  0 B/op  0 allocs/op
BenchmarkIsCoinBaseNew  200000000  6.05 ns/op  0 B/op  0 allocs/op
2015-03-10 13:55:24 -05:00
..
testdata Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
accept.go Implement BIP0066 changeover logic for v3 blocks. 2015-02-26 09:54:29 -06:00
bench_test.go blockchain: Provide new IsCoinBaseTx function. 2015-03-10 13:55:24 -05:00
blocklocator.go blockchain: Just fetch the height 2015-02-12 16:10:08 -05:00
chain.go Simplify chain configuration. 2015-02-18 20:33:33 -05:00
chain_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
checkpoints.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
common_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
difficulty.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
difficulty_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
doc.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
error.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
error_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
example_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
internal_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
log.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
mediantime.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
mediantime_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
merkle.go Update btcwire path import paths to new location. 2015-02-05 15:16:39 -06:00
merkle_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
notifications.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
process.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00
README.md Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
reorganization_test.go Update btcwire path import paths to new location. 2015-02-05 15:16:39 -06:00
scriptval.go blockchain: Determine script flags sooner. 2015-02-25 16:56:34 -06:00
scriptval_test.go blockchain: Determine script flags sooner. 2015-02-25 16:56:34 -06:00
timesorter.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
timesorter_test.go Import btcchain repo into blockchain directory. 2015-01-30 15:49:59 -06:00
txlookup.go Make profiling easier to follow with static dispatch. 2015-02-06 22:14:13 -06:00
validate.go blockchain: Provide new IsCoinBaseTx function. 2015-03-10 13:55:24 -05:00
validate_test.go Update btcnet path import paths to new location. 2015-02-05 23:24:53 -06:00

blockchain

[Build Status] (https://travis-ci.org/btcsuite/btcd) ![ISC License] (http://img.shields.io/badge/license-ISC-blue.svg)

Package blockchain implements bitcoin block handling and chain selection rules. The test coverage is currently only around 60%, but will be increasing over time. See test_coverage.txt for the gocov coverage report. Alternatively, if you are running a POSIX OS, you can run the cov_report.sh script for a real-time report. Package blockchain is licensed under the liberal ISC license.

There is an associated blog post about the release of this package here.

This package has intentionally been designed so it can be used as a standalone package for any projects needing to handle processing of blocks into the bitcoin block chain.

Documentation

[GoDoc] (http://godoc.org/github.com/btcsuite/btcd/blockchain)

Full go doc style documentation for the project can be viewed online without installing this package by using the GoDoc site here: http://godoc.org/github.com/btcsuite/btcd/blockchain

You can also view the documentation locally once the package is installed with the godoc tool by running godoc -http=":6060" and pointing your browser to http://localhost:6060/pkg/github.com/btcsuite/btcd/blockchain

Installation

$ go get github.com/btcsuite/btcd/blockchain

Bitcoin Chain Processing Overview

Before a block is allowed into the block chain, it must go through an intensive series of validation rules. The following list serves as a general outline of those rules to provide some intuition into what is going on under the hood, but is by no means exhaustive:

  • Reject duplicate blocks
  • Perform a series of sanity checks on the block and its transactions such as verifying proof of work, timestamps, number and character of transactions, transaction amounts, script complexity, and merkle root calculations
  • Compare the block against predetermined checkpoints for expected timestamps and difficulty based on elapsed time since the checkpoint
  • Save the most recent orphan blocks for a limited time in case their parent blocks become available
  • Stop processing if the block is an orphan as the rest of the processing depends on the block's position within the block chain
  • Perform a series of more thorough checks that depend on the block's position within the block chain such as verifying block difficulties adhere to difficulty retarget rules, timestamps are after the median of the last several blocks, all transactions are finalized, checkpoint blocks match, and block versions are in line with the previous blocks
  • Determine how the block fits into the chain and perform different actions accordingly in order to ensure any side chains which have higher difficulty than the main chain become the new main chain
  • When a block is being connected to the main chain (either through reorganization of a side chain to the main chain or just extending the main chain), perform further checks on the block's transactions such as verifying transaction duplicates, script complexity for the combination of connected scripts, coinbase maturity, double spends, and connected transaction values
  • Run the transaction scripts to verify the spender is allowed to spend the coins
  • Insert the block into the block database

Examples

GPG Verification Key

All official release tags are signed by Conformal so users can ensure the code has not been tampered with and is coming from Conformal. To verify the signature perform the following:

  • Download the public key from the Conformal website at https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt

  • Import the public key into your GPG keyring:

    gpg --import GIT-GPG-KEY-conformal.txt
    
  • Verify the release tag with the following command where TAG_NAME is a placeholder for the specific tag:

    git tag -v TAG_NAME
    

License

Package blockchain is licensed under the copyfree ISC License.