An alternative full node implementation of LBRY's blockchain written in Go (golang)
Find a file
Olaoluwa Osuntokun b564111aff txscript: fix off-by-one error due to new OP_CODESEPARATOR behavior in segwit
This commit fixes an off-by-one error which is only manifested by the
new behavior of OP_CODESEPARATOR within sig hashes triggered by the
segwit behavior. The current behavior within the Script VM
(txscript.Engine) is known to be fully correct to the extent that it has
been verified. However, once segwit activates a consensus divergence
would emerge due to *when* the program counter was incremented in the
previous code (pre-this-commit).

Currently (pre-segwit) when calculating the pre-image to a transaction
sighash for signature verification, *all* instances of OP_CODESEPARATOR
are removed from the subScript being signed before generating the final
sighash. SegWit has additional nerfed the behavior of OP_CODESEPARATOR
by no longer removing them (and starting after the last instance), but
instead simply starting the subScript to be directly *after* the last
instance of an OP_CODESEPARATOR within the pkScript.

Due to this new behavior, without this commit, an off-by-one error
(which only matters post-segwit), would cause txscript to generate an
incorrect subScript since the instance of OP_CODESEPARATOR would remain
as part of the subScript instead of being sliced off as the new behavior
dictates. The off-by-one error itself is manifested due to a slight
divergence in txscript.Engine’s logic compared to Bitcoin Core.  In
Bitcoin Core script verification is as follows: first the next op-code
is fetched, then program counter is incremented, and finally the op-code
itself is executed. Before this commit, btcd flipped the order
of the last two steps, executing the op-code *before* the program
counter was incremented.

This commit fixes the post-segwit consensus divergence by incrementing
the program-counter *before* the next op-code is executed. It is
important to note that this divergence is only significant post-segwit,
meaning that txscript.Engine is still consensus compliant independent of
this commit.
2017-08-13 23:17:40 -05:00
addrmgr BIP0144: properly fetch witness data from witness-enabled peers 2017-08-13 23:17:40 -05:00
blockchain BIP0144: properly fetch witness data from witness-enabled peers 2017-08-13 23:17:40 -05:00
btcec btcec: Slightly optimize NAF and add several tests. 2017-06-07 20:43:48 -05:00
btcjson New RPC command to display the uptime of the server 2017-07-03 00:07:27 +01:00
chaincfg chaincfg: Add IsBech32SegwitPrefix utility method. 2017-07-08 10:26:15 +02:00
cmd all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
connmgr all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
database multi: Simplify code per gosimple linter. 2017-07-01 02:25:10 -05:00
docs multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
integration multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mempool multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
mining all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
peer BIP0144+peer: specify the wire encoding type when reading/writing messages 2017-08-13 23:17:40 -05:00
release Update release script to correct btcctl location. 2015-02-28 03:39:20 -06:00
txscript txscript: fix off-by-one error due to new OP_CODESEPARATOR behavior in segwit 2017-08-13 23:17:40 -05:00
wire BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
.gitignore build: Convert project to use glide. (#689) 2016-05-06 10:47:53 -05:00
.travis.yml TravisCI: Use release version of glide. 2017-01-23 13:09:42 -06:00
blocklogger.go Add support for an optional address-based transaction index. 2015-02-05 14:48:19 -08:00
blockmanager.go BIP0144: properly fetch witness data from witness-enabled peers 2017-08-13 23:17:40 -05:00
btcd.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
CHANGES Fix typos in changelog. 2015-12-29 09:43:44 -07:00
config.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
config_test.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
doc.go config: Add user agent comments flag --uacomment 2017-05-17 13:22:26 +02:00
glide.lock all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
glide.yaml all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
goclean.sh TravisCI: Don't run tests with race. 2017-07-01 16:13:35 -05:00
LICENSE txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
params.go Change copyright date for code that was updated this year(2016). 2016-01-07 09:01:51 -07:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
rpcserver.go New RPC command to display the uptime of the server 2017-07-03 00:07:27 +01:00
rpcserverhelp.go New RPC command to display the uptime of the server 2017-07-03 00:07:27 +01:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcwebsocket.go multi: Switch to upstream golang.org/x/crypto. 2017-05-09 11:35:01 -05:00
sample-btcd.conf config: Add user agent comments flag --uacomment 2017-05-17 13:22:26 +02:00
server.go BIP0144: properly fetch witness data from witness-enabled peers 2017-08-13 23:17:40 -05:00
service_windows.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
signal.go btcd: Simplify shutdown signal handling logic. (#733) 2016-08-11 13:39:23 -05:00
signalsigterm.go btcd: Simplify shutdown signal handling logic. (#733) 2016-08-11 13:39:23 -05:00
upgrade.go multi: Simplify code per gosimple linter. 2016-11-03 13:00:35 -05:00
upnp.go Fix a ton of typos accumulated over time 2017-05-30 16:59:51 +02:00
version.go Prepare for release 0.12.0. 2015-11-20 19:33:17 -06:00

btcd

Build Status ISC License GoDoc

btcd is an alternative full node bitcoin implementation written in Go (golang).

This project is currently under active development and is in a Beta state. It is extremely stable and has been in production use since October 2013.

It properly downloads, validates, and serves the block chain using the exact rules (including consensus bugs) for block acceptance as Bitcoin Core. We have taken great care to avoid btcd causing a fork to the block chain. It includes a full block validation testing framework which contains all of the 'official' block acceptance tests (and some additional ones) that is run on every pull request to help ensure it properly follows consensus. Also, it passes all of the JSON test data in the Bitcoin Core code.

It also properly relays newly mined blocks, maintains a transaction pool, and relays individual transactions that have not yet made it into a block. It ensures all individual transactions admitted to the pool follow the rules required by the block chain and also includes more strict checks which filter transactions based on miner requirements ("standard" transactions).

One key difference between btcd and Bitcoin Core is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the blog entry here for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the btcwallet and Paymetheus (Windows-only) projects which are both under active development.

Requirements

Go 1.6 or newer.

Installation

Windows - MSI Available

https://github.com/btcsuite/btcd/releases

Linux/BSD/MacOSX/POSIX - Build from Source

  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Ensure Go was installed properly and is a supported version:

$ go version
$ go env GOROOT GOPATH

NOTE: The GOROOT and GOPATH above must not be the same path. It is recommended that GOPATH is set to a directory in your home directory such as ~/goprojects to avoid write permission issues. It is also recommended to add $GOPATH/bin to your PATH at this point.

  • Run the following commands to obtain btcd, all dependencies, and install it:
$ go get -u github.com/Masterminds/glide
$ git clone https://github.com/btcsuite/btcd $GOPATH/src/github.com/btcsuite/btcd
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ glide install
$ go install . ./cmd/...
  • btcd (and utilities) will now be installed in $GOPATH/bin. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.

Updating

Windows

Install a newer MSI

Linux/BSD/MacOSX/POSIX - Build from Source

  • Run the following commands to update btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ git pull && glide install
$ go install . ./cmd/...

Getting Started

btcd has several configuration options avilable to tweak how it runs, but all of the basic operations described in the intro section work with zero configuration.

Windows (Installed from MSI)

Launch btcd from your Start menu.

Linux/BSD/POSIX/Source

$ ./btcd

IRC

  • irc.freenode.net
  • channel #btcd
  • webchat

Mailing lists

  • btcd: discussion of btcd and its packages.
  • btcd-commits: readonly mail-out of source code changes.

To subscribe to a given list, send email to list+subscribe@opensource.conformal.com

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation is a work-in-progress. It is located in the docs folder.

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 the btcsuite developers. 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

btcd is licensed under the copyfree ISC License.