153dca5c1e
This updates the data driven transaction script tests to use the most recent format and test data as implemented by Core so the test data can more easily be updated and help prove cross-compatibility correctness. In particular, the new format combines the previously separate valid and invalid test data files into a single file and adds a field for the expected result. This is a nice improvement since it means tests can now ensure script failures are due to a specific expected reason as opposed to only generically detecting failure as the previous format required. The btcd script engine typically returns more fine grained errors than the test data expects, so the test adapter handles this by allowing expected errors in the test data to be mapped to multiple txscript errors. It should also be noted that the tests related to segwit have been stripped from the data since the segwit PR has not landed in master yet, however the test adapter does recognize the new ability for optional segwit data to be supplied, though it will need to properly construct the transaction using that data when the time comes. |
||
|---|---|---|
| .. | ||
| data | ||
| consensus.go | ||
| doc.go | ||
| engine.go | ||
| engine_test.go | ||
| error.go | ||
| error_test.go | ||
| example_test.go | ||
| log.go | ||
| log_test.go | ||
| opcode.go | ||
| opcode_test.go | ||
| README.md | ||
| reference_test.go | ||
| script.go | ||
| script_test.go | ||
| scriptbuilder.go | ||
| scriptbuilder_test.go | ||
| scriptnum.go | ||
| scriptnum_test.go | ||
| sigcache.go | ||
| sigcache_test.go | ||
| sign.go | ||
| sign_test.go | ||
| stack.go | ||
| stack_test.go | ||
| standard.go | ||
| standard_test.go | ||
txscript
[
]
(https://travis-ci.org/btcsuite/btcd) ![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)
[
]
(http://godoc.org/github.com/btcsuite/btcd/txscript)
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
-
[Standard Pay-to-pubkey-hash Script] (http://godoc.org/github.com/btcsuite/btcd/txscript#example-PayToAddrScript)
Demonstrates creating a script which pays to a bitcoin address. It also prints the created script hex and uses the DisasmString function to display the disassembled script. -
[Extracting Details from Standard Scripts] (http://godoc.org/github.com/btcsuite/btcd/txscript#example-ExtractPkScriptAddrs)
Demonstrates extracting information from a standard public key script. -
[Manually Signing a Transaction Output] (http://godoc.org/github.com/btcsuite/btcd/txscript#example-SignTxOutput)
Demonstrates manually creating and signing a redeem transaction.
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_NAMEis a placeholder for the specific tag:git tag -v TAG_NAME
License
Package txscript is licensed under the copyfree ISC License.