An alternative full node implementation of LBRY's blockchain written in Go (golang)
Go to file
Dave Collins 34ebf0f32f
txscript: Optimize IsMultisigSigScript.
This converts the IsMultisigSigScript function to analyze the raw script
and make use of the new tokenizer instead of the far less efficient
parseScript thereby significantly optimizing the function.

In order to accomplish this, it first rejects scripts that can't
possibly fit the bill due to the final byte of what would be the redeem
script not being the appropriate opcode or the overall script not having
enough bytes.  Then, it uses a new function that is introduced named
finalOpcodeData that uses the tokenizer to return any data associated
with the final opcode in the signature script (which will be nil for
non-push opcodes or if the script fails to parse) and analyzes it as if
it were a redeem script when it is non nil.

It is also worth noting that this new implementation intentionally has
the same semantic difference from the existing implementation as the
updated IsMultisigScript function in regards to allowing zero pubkeys
whereas previously it incorrectly required at least one pubkey.

Finally, the comment is modified to explicitly call out the script
version semantics.

The following is a before and after comparison of analyzing a large
script that is not a multisig script and both a 1-of-2 multisig public
key script (which should be false) and a signature script comprised of a
pay-to-script-hash 1-of-2 multisig redeem script (which should be true):

benchmark                               old ns/op     new ns/op     delta
BenchmarkIsMultisigSigScriptLarge-8     69328         2.93          -100.00%
BenchmarkIsMultisigSigScript-8          2375          146           -93.85%

benchmark                               old allocs     new allocs     delta
BenchmarkIsMultisigSigScriptLarge-8     5              0              -100.00%
BenchmarkIsMultisigSigScript-8          3              0              -100.00%

benchmark                               old bytes     new bytes     delta
BenchmarkIsMultisigSigScriptLarge-8     330035        0             -100.00%
BenchmarkIsMultisigSigScript-8          9472          0             -100.00%
2021-11-16 18:46:03 -08:00
.github/workflows Included permissions for GitHub action 2021-10-26 10:00:04 -04:00
addrmgr addrmgr: make KnownAddress methods thread-safe 2021-10-26 09:55:49 -04:00
blockchain docs: update shields 2021-03-05 07:45:19 -05:00
btcec btcec: added testcase for point at infinity 2021-09-13 15:59:28 -04:00
btcjson btcjson: Update WalletCreateFundedPsbtOpts.FeeRate from *int64 to *float64 2021-06-25 15:23:44 -03:00
chaincfg chaincfg: fix deployment bit numbers 2021-05-11 15:55:06 -04:00
cmd btcd: bump version to v0.22.0-beta 2021-06-01 09:36:33 -04:00
connmgr docs: update shields 2021-03-05 07:45:19 -05:00
database docs: update shields 2021-03-05 07:45:19 -05:00
docs build: bump min Go version to 1.16.8 add Go 1.17.1 2021-09-15 18:19:34 -07:00
integration rpctest: add witness commitment when calling CreateBlock 2021-04-26 13:53:53 +02:00
limits Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
mempool fix typos 2021-10-26 09:56:57 -04:00
mining mining: extract witness commitment add into method 2021-04-26 13:53:22 +02:00
netsync docs: update shields 2021-03-05 07:45:19 -05:00
peer peer+server: add new config option to optionally disable stall detection 2021-10-01 14:55:50 -07:00
release ci: add go 1.15 to tests 2020-09-17 01:38:18 -04:00
rpcclient rpcclient: Export symbols needed for custom commands (#1457) 2021-09-02 08:39:55 +02:00
txscript txscript: Optimize IsMultisigSigScript. 2021-11-16 18:46:03 -08:00
wire docs: update shields 2021-03-05 07:45:19 -05:00
.gitignore GitHub Actions: Enable Go Race detector and code coverage 2020-09-08 10:19:55 -04:00
btcd.go removed unnecessary GOMAXPROCS function calls 2020-09-14 09:57:30 -04:00
CHANGES Update release date for v0.22.0-beta in CHANGES file 2021-06-01 13:16:51 -04:00
config.go peer+server: add new config option to optionally disable stall detection 2021-10-01 14:55:50 -07:00
config_test.go Reconcile differences between btcd/dcrd. 2016-10-21 16:37:30 -05:00
doc.go config+params: add signet config option 2021-04-22 13:10:45 +02:00
Dockerfile Upgraded the docker version to 1.16 2021-09-17 11:17:29 -04:00
go.mod build: bump min Go version to 1.16.8 add Go 1.17.1 2021-09-15 18:19:34 -07:00
go.sum build: bump min Go version to 1.16.8 add Go 1.17.1 2021-09-15 18:19:34 -07:00
goclean.sh GitHub Actions: Enable Go Race detector and code coverage 2020-09-08 10:19:55 -04:00
LICENSE txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
log.go log: update to latest log rotator API 2018-05-23 16:46:15 -07:00
params.go config+params: add signet config option 2021-04-22 13:10:45 +02:00
README.md build: bump min Go version to 1.16.8 add Go 1.17.1 2021-09-15 18:19:34 -07:00
rpcadapters.go rpc: Add getnodeaddresses JSON-RPC support 2020-09-14 09:36:05 -04:00
rpcserver.go rpcserver: add taproot deployment to getblockchaininfo 2021-04-22 13:10:45 +02:00
rpcserverhelp.go rpcserverhelp: Remove extra period for gettxout--synopsis 2021-07-27 10:27:50 -04:00
rpcserverhelp_test.go Relicense to the btcsuite developers. 2015-05-01 12:00:56 -05:00
rpcwebsocket.go Add Batch JSON-RPC support (rpc client & server) 2021-02-09 09:47:46 -05:00
sample-btcd.conf sample-btcd.conf: fix typo 2020-09-17 09:03:52 -04:00
server.go peer+server: add new config option to optionally disable stall detection 2021-10-01 14:55:50 -07:00
service_windows.go config+service_windows: add flag to disable win service 2020-07-22 12:57:09 +02: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 btcd: fix conversion of int to string failing in Go 1.15 2020-08-31 16:01:10 -04:00
version.go btcd: bump version to v0.22.0-beta 2021-06-01 09:36:33 -04:00

btcd

Build Status Coverage 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.16 or newer.

Installation

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:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ GO111MODULE=on go install -v . ./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

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
$ GO111MODULE=on go install -v . ./cmd/...

Getting Started

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

Linux/BSD/POSIX/Source

$ ./btcd

IRC

  • irc.libera.chat
  • channel #btcd
  • webchat

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.

Release Verification

Please see our documentation on the current build/verification process for all our releases for information on how to verify the integrity of published releases using our reproducible build system.

License

btcd is licensed under the copyfree ISC License.