An alternative full node implementation of LBRY's blockchain written in Go (golang)
Go to file
Conner Fromknecht 44c6be3d4e txscript: Optimize IsPayToWitnessScriptHash
This converts the IsPayToWitnessScriptHash function to analyze the raw
script instead of using the far less efficient parseScript, thereby
significantly optimizing the function.

In order to accomplish this, it introduces two new functions. The first
one is named extractWitnessScriptHash and works with the raw script byte
to simultaneously deteremine if the script is a p2wsh script, and in the
case that is is, extract and return the hash. The second new function is
named isWitnessScriptHashScript and is defined in terms of the former.

The extract function approach was chosed because it is common for
callers to want to only extract relevant details from a script if the
script is of the specific type. Extracting those details requires
performing the exact same checks to ensure the script is of the correct
type, so it is more efficient to combine the two into one and define the
type determination in terms of the result, so long as the extraction
does not require allocations.

Finally, this also deprecates the isWitnessScriptHash function that
requires opcodes in favor of the new functions and modifies the comment
on IsPayToWitnessScriptHash to call out the script version semantics.

The following is a before and after comparison of executing
IsPayToWitnessScriptHash on a large script:

benchmark                          old ns/op     new ns/op     delta
BenchmarkIsWitnessScriptHash-8     62774         0.63          -100.00%

benchmark                          old allocs     new allocs     delta
BenchmarkIsWitnessScriptHash-8     1              0              -100.00%

benchmark                          old bytes     new bytes     delta
BenchmarkIsWitnessScriptHash-8     311299        0             -100.00%
2022-05-23 21:46:21 -07: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 Update connmanager_test.go 2021-11-10 07:59:03 -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: Add retry with backoffs to HTTP POST requests 2021-11-16 09:08:07 -05:00
txscript txscript: Optimize IsPayToWitnessScriptHash 2022-05-23 21:46:21 -07: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.