mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 09:50:08 +01:00

History

Dave Collins 2e433b0eb3 txscript: Move opcode execution logic to engine This commit moves the opcode execution logic from the opcode type to the engine type because execution of an opcode modifies the engine state (primarily the main and alternate data stacks) as opposed to the state of the opcode. Making the engine the receiver more clearly indicates this fact.		2015-04-27 14:35:41 -05:00
..
data	txscript: sync Bitcoin Core tests.	2015-04-09 12:24:12 -04:00
address_test.go	Update btcnet path import paths to new location.	2015-02-05 23:24:53 -06:00
address.go	Update btcnet path import paths to new location.	2015-02-05 23:24:53 -06:00
doc.go	Import btcscript repo into txscript directory.	2015-01-30 10:30:16 -06:00
engine_test.go	txscript: Rename Script to Engine.	2015-04-20 15:31:23 -05:00
engine.go	txscript: Move opcode execution logic to engine	2015-04-27 14:35:41 -05:00
error.go	txscript: Move error definitions to error.go.	2015-04-21 13:33:08 -05:00
example_test.go	txscript: Rename Script to Engine.	2015-04-20 15:31:23 -05:00
internal_test.go	txscript: Convert opcode map to an array.	2015-04-21 13:56:05 -05:00
log_test.go	Import btcscript repo into txscript directory.	2015-01-30 10:30:16 -06:00
log.go	Import btcscript repo into txscript directory.	2015-01-30 10:30:16 -06:00
opcode_test.go	txscript: Define opcodes in hex and sync BC opcodes.	2015-04-21 13:51:02 -05:00
opcode.go	txscript: Move opcode execution logic to engine	2015-04-27 14:35:41 -05:00
README.md	txscript: Add example for manully signing a txout.	2015-02-09 13:07:56 -06:00
reference_test.go	txscript: Add exported opcode name to value map.	2015-04-21 14:02:30 -05:00
script_test.go	txscript: Separate signing code.	2015-04-20 17:00:23 -05:00
script.go	txscript: Convert opcode map to an array.	2015-04-21 13:56:05 -05:00
scriptbuilder_test.go	Import btcscript repo into txscript directory.	2015-01-30 10:30:16 -06:00
scriptbuilder.go	Import btcscript repo into txscript directory.	2015-01-30 10:30:16 -06:00
sign_test.go	txscript: Separate signing code.	2015-04-20 17:00:23 -05:00
sign.go	txscript: Separate signing code.	2015-04-20 17:00:23 -05:00
stack_test.go	txscript: Unexport Stack type.	2015-04-25 17:10:53 -05:00
stack.go	txscript: Unexport Stack type.	2015-04-25 17:10:53 -05:00

README.md

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_NAME is a placeholder for the specific tag:
```
git tag -v TAG_NAME
```

License

Package txscript is licensed under the liberal ISC License.