An alternative full node implementation of LBRY's blockchain written in Go (golang)

Go to file

Jonathan Gillham a61c0f06cf Removed unnecessary signTxOutputCustomReader.		2014-10-13 13:47:44 +01:00
data	sync bitcoind script tests	2014-08-01 13:40:56 -04:00
.gitignore	Initial commit.	2013-06-12 16:22:01 -05:00
.travis.yml	Add support for TravisCI.	2013-12-10 18:01:11 -06:00
address.go	Update API for btcnet and btcutil changes.	2014-05-27 17:42:01 -05:00
address_test.go	goimports -w .	2014-07-02 19:37:49 -05:00
cov_report.sh	Initial implementation.	2013-06-13 14:59:46 -05:00
doc.go	Convert all StackErrX to ErrStackX.	2014-10-12 17:24:00 -05:00
example_test.go	Add ExtractPkScriptAddrs examples.	2014-07-08 14:59:57 -05:00
internal_test.go	Convert all StackErrX to ErrStackX.	2014-10-12 17:24:00 -05:00
LICENSE	Add 2014 to copyright dates.	2014-01-08 23:47:47 -06:00
log.go	goimports -w .	2014-07-02 19:37:49 -05:00
log_test.go	Complete SetLogWriter testing	2014-08-03 23:30:37 +03:00
opcode.go	use btcec structs instead of ecdsa structs	2014-10-12 23:47:09 -05:00
opcode_test.go	Convert all StackErrX to ErrStackX.	2014-10-12 17:24:00 -05:00
README.md	Add ExtractPkScriptAddrs examples.	2014-07-08 14:59:57 -05:00
script.go	Removed unnecessary signTxOutputCustomReader.	2014-10-13 13:47:44 +01:00
script_test.go	use btcec structs instead of ecdsa structs	2014-10-12 23:47:09 -05:00
scriptbuilder.go	AddData([]byte{}) is valid and should push empty to the stack.	2014-03-14 22:46:15 +00:00
scriptbuilder_test.go	goimports -w .	2014-07-02 19:37:49 -05:00
stack.go	Convert all StackErrX to ErrStackX.	2014-10-12 17:24:00 -05:00
stack_test.go	Convert all StackErrX to ErrStackX.	2014-10-12 17:24:00 -05:00
test_coverage.txt	Remove the use of go-spew.	2014-08-29 16:06:17 -04:00

README.md

btcscript

[] (https://travis-ci.org/conformal/btcscript)

Package btcscript implements the bitcoin transaction scripts. There is a comprehensive test suite. test_coverage.txt contains the current coverage statistics (generated using gocov). On a UNIX-like OS, the script cov_report.sh can be used to generate the report. Package btcscript is licensed under the liberal ISC license.

This package is one of the core packages from btcd, an alternative full-node implementation of bitcoin which is under active development by Conformal. Although it was primarily written for btcd, 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/conformal/btcscript)

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/conformal/btcscript

Installation

$ go get github.com/conformal/btcscript

Examples

[Standard Pay-to-pubkey-hash Script] (http://godoc.org/github.com/conformal/btcscript#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/conformal/btcscript#example-ExtractPkScriptAddrs)
Demonstrates extracting information from a standard public key script.

TODO

Increase test coverage to 100%

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 btcscript is licensed under the liberal ISC License.