lbcd/txscript
Dave Collins ce08988514 txscript: Optimize script disasm.
This converts the DisasmString function to make use of the new
zero-allocation script tokenizer instead of the far less efficient
parseScript thereby significantly optimizing the function.

In order to facilitate this, the opcode disassembly functionality is
split into a separate function called disasmOpcode that accepts the
opcode struct and data independently as opposed to requiring a parsed
opcode.  The new function also accepts a pointer to a string builder so
the disassembly can be more efficiently be built.

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

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

benchmark                   old ns/op     new ns/op     delta
BenchmarkDisasmString-8     102902        40124         -61.01%

benchmark                   old allocs     new allocs     delta
BenchmarkDisasmString-8     46             51             +10.87%

benchmark                   old bytes     new bytes     delta
BenchmarkDisasmString-8     389324        130552        -66.47%
2022-05-23 21:46:20 -07:00
..
data txscript: Add benchmark for CalcSignatureHash 2022-05-23 21:46:20 -07:00
bench_test.go txscript: Add benchmark for DisasmString. 2022-05-23 21:46:20 -07: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 fix error message 2020-03-05 16:51:41 -05:00
engine_test.go BIP0141+txscript: implement witness program validation 2017-08-13 23:17:40 -05:00
error.go txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07:00
error_test.go txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07:00
example_test.go txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07:00
hashcache.go BIP0143+txscript: add segwit sighash, signing, and HashCache integration 2017-08-13 23:17:40 -05:00
hashcache_test.go txscript/hashcache_test: call rand.Seed once in init 2021-02-02 13:31:47 -08:00
log.go all: Remove seelog logger. 2017-06-19 16:46:50 -04:00
opcode.go txscript: Optimize script disasm. 2022-05-23 21:46:20 -07:00
opcode_test.go build: clean linter warnings 2020-05-13 08:58:39 -04:00
pkscript.go txscript: refactor ComputePkScript 2019-06-03 13:55:28 -07:00
pkscript_test.go build: replace travis-ci with github actions. 2020-05-13 08:52:05 -04:00
README.md txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07:00
reference_test.go txscript: Cleanup strict signature enforcement. 2018-08-23 11:56:28 -05:00
script.go txscript: Optimize script disasm. 2022-05-23 21:46:20 -07:00
script_test.go txscript: add benchmark for IsUnspendable 2021-02-02 09:20:31 -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 txscript: export calcSignatureHash 2018-01-25 23:14:55 -06: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 rpcclient: implement getaddressinfo command 2020-09-21 09:47:58 -04:00
standard_test.go rpcclient: implement getaddressinfo command 2020-09-21 09:47:58 -04:00
tokenizer.go txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07:00
tokenizer_test.go txscript: Introduce zero-alloc script tokenizer. 2022-05-23 21:46:20 -07: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.