8dd7412a84
This commit renames the Script type to Engine to better reflect its purpose. It also renames the NewScript function to NewEngine to match. This is being done because name Script for the engine is confusing since it implies it is an actual script rather than the execution environment for the script. It also paves the way for eventually supplying a ParsedScript type which will be less likely to be confused with the execution environment. While moving the code, some additional variable names and comments have been updated to better match the style used throughout the rest of the code base. In addition, an attempt has been made to use consistent naming of the engine as 'vm' instead of using different variables names as it was previously. Finally, the relevant engine code has been moved into a new file named engine.go and related tests moved to engine_test.go. |
||
|---|---|---|
| .. | ||
| data | ||
| address.go | ||
| address_test.go | ||
| doc.go | ||
| engine.go | ||
| engine_test.go | ||
| example_test.go | ||
| internal_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 | ||
| stack.go | ||
| stack_test.go | ||
txscript
[
]
(https://travis-ci.org/btcsuite/btcd)
Package txscript implements the bitcoin transaction script language. There is a comprehensive test suite. Package txscript is licensed under the liberal ISC license.
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 langauge 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
Documentation
[
]
(http://godoc.org/github.com/btcsuite/btcd/txscript)
Full go doc style documentation for the project can be viewed online without
installing this package by using the GoDoc site
here.
You can also view the documentation locally once the package is installed with
the godoc tool by running godoc -http=":6060" and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/txscript
Installation
$ go get 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 Conformal. 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 liberal ISC License.