lbcd/txscript
Dave Collins 6b802379ec
txscript: Shallow tx copy for signature hash calc.
This modifies calcSignatureHash to use a shallow copy of the transaction
versus a deep copy since the actual scripts themselves are not modified
and therefore don't need to be copied.

This is being done because profiling the most overall allocated space
shows that the deep copy performed in calcSignatureHash accounts for
nearly 20% of all allocations on a synced running instance.  Also,
copying all of the additional data makes it more time consuming as well.

With this change, that figure drops from ~20% to ~5% of all allocations.

The following benchmark shows the relative speedups and allocation
reduction as a result of the optimization on my system.  In particular,
the changes result in approximately a 15% speedup and a whopping 99.89%
reduction in allocations when using a large transaction with thousands
of inputs which was the worst case scenario.

benchmark                        old allocs    new allocs    delta
--------------------------------------------------------------------
BenchmarkCalcSignatureHash       11151         12            -99.89%

benchmark                        old ns/op     new ns/op     delta
--------------------------------------------------------------------
BenchmarkCalcSignatureHash       3599845       3056359       -15.10%
2017-08-24 12:48:11 -05:00
..
data txscript: update reference tests to include new segwit related cases 2017-08-13 23:17:40 -05:00
consensus.go txscript: Implement CheckSequenceVerify (BIP0112) 2016-10-19 12:06:44 -04:00
doc.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
engine.go txscript: convert all new segwit error types to ErrorCode's 2017-08-13 23:17:40 -05:00
engine_test.go BIP0141+txscript: implement witness program validation 2017-08-13 23:17:40 -05:00
error.go txscript: convert all new segwit error types to ErrorCode's 2017-08-13 23:17:40 -05:00
error_test.go txscript: convert all new segwit error types to ErrorCode's 2017-08-13 23:17:40 -05:00
example_test.go BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
hashcache.go BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
hashcache_test.go BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
opcode.go txscript: add verification of the post-segwit pub key type constraint 2017-08-13 23:17:40 -05:00
opcode_test.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
README.md multi: Update markdown files for GFM changes. 2017-05-25 12:06:16 -05:00
reference_test.go txscript: update reference tests to include new segwit related cases 2017-08-13 23:17:40 -05:00
script.go txscript: Shallow tx copy for signature hash calc. 2017-08-24 12:48:11 -05:00
script_test.go BIP0141+txscript: implement signature operation cost calculations 2017-08-13 23:17:40 -05:00
scriptbuilder.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
scriptbuilder_test.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
scriptnum.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
scriptnum_test.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
sigcache.go txscript: Drop the mutex before doing crypto 2017-01-31 13:47:41 -05:00
sigcache_test.go chainhash: Abstract hash logic to new package. (#729) 2016-08-08 14:04:33 -05:00
sign.go BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
sign_test.go BIP0141+txscript: implement witness program validation 2017-08-13 23:17:40 -05:00
stack.go multi: Simplify code per gosimple linter. 2017-03-22 15:34:13 -05:00
stack_test.go txscript: Significantly improve errors. 2017-01-12 13:12:39 -06:00
standard.go txscript: convert all new segwit error types to ErrorCode's 2017-08-13 23:17:40 -05:00
standard_test.go BIP0141+txscript: awareness of new standard script templates, add helper funcs 2017-08-13 23:17:40 -05:00

txscript

Build Status ISC License GoDoc

Package txscript implements the bitcoin transaction script language. There is a comprehensive test suite.

This package has intentionally been designed so it can be used as a standalone package for any projects needing to use or validate bitcoin transaction scripts.

Bitcoin Scripts

Bitcoin provides a stack-based, FORTH-like language for the scripts in the bitcoin transactions. This language is not turing complete although it is still fairly powerful. A description of the language can be found at https://en.bitcoin.it/wiki/Script

Installation and Updating

$ go get -u github.com/btcsuite/btcd/txscript

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 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

Package txscript is licensed under the copyfree ISC License.