LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
An alternative full node implementation of LBRY's blockchain written in Go (golang)
169 commits 9 branches 35 tags 20 MiB
Go 99.9%
Shell 0.1%
Find a file
Dave Collins af5cbe4b4f Update script builder for BIP0062 and enforce limits. 
BIP0062 defines specific rules and canonical encodings for data pushes.

The existing script builder code already conformed to all but one of the
canonical data push rules that was added after it was originally
implemented (adding a single byte of 0x81 must be converted to
OP_1NEGATE).  This commit implements that case and expands the existing
tests to explicitly cover all cases mentioned in BIP0062.

In addition, as a part of this change, the AddData function has been
modified so that any attempt to push more than the maximum script element
size bytes (520) in one push or any pushes the would cause the script to
exceed the maximum script bytes allowed by the script engine (10000) will
result in the final call to the Script function to only return the script
up to the point of the first error along with the error. This change
should have little effect on existing callers since they are almost
positively not creating scripts which violate these rules as they could
never be executed, however it does mean they need to check the new error
return.

Since the regression tests intentionally need to be able to exceed that
limit, a new function named AddFullData has been added which does not
enforce the limits, but still provides canonical encoding of the pushed
data.

Note that this commit does not affect consensus rules nor modify the
script engine.

Also, the tests have been marked so they can run in parallel.
2015-01-28 23:30:35 -06:00
data Sync TX tests with Bitcoin Core. 2014-12-19 15:20:48 -05: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 btcnet import paths to new location. 2015-01-16 17:29:53 -06:00
address_test.go Update btcscript import paths to new location. 2015-01-16 19:41:02 -06: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 Update btcscript import paths to new location. 2015-01-16 19:41:02 -06:00
internal_test.go Update script builder for BIP0062 and enforce limits. 2015-01-28 23:30:35 -06:00
LICENSE Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
log.go Update btclog import paths to new location. 2015-01-16 11:18:14 -06:00
log_test.go Update btcscript import paths to new location. 2015-01-16 19:41:02 -06:00
opcode.go Update btcec import paths to new location. 2015-01-16 18:05:06 -06:00
opcode_test.go Update btcscript import paths to new location. 2015-01-16 19:41:02 -06:00
README.md Update btcscript import paths to new location. 2015-01-16 19:41:02 -06:00
script.go Update script builder for BIP0062 and enforce limits. 2015-01-28 23:30:35 -06:00
script_test.go Update script builder for BIP0062 and enforce limits. 2015-01-28 23:30:35 -06:00
scriptbuilder.go Update script builder for BIP0062 and enforce limits. 2015-01-28 23:30:35 -06:00
scriptbuilder_test.go Update script builder for BIP0062 and enforce limits. 2015-01-28 23:30:35 -06:00
stack.go Convert all StackErrX to ErrStackX. 2014-10-12 17:24:00 -05:00
stack_test.go Update btcscript import paths to new location. 2015-01-16 19:41:02 -06:00
test_coverage.txt Sync TX tests with Bitcoin Core. 2014-12-19 15:20:48 -05:00

README.md

btcscript

[Build Status] (https://travis-ci.org/btcsuite/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

[GoDoc] (http://godoc.org/github.com/btcsuite/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/btcsuite/btcscript

Installation

$ go get github.com/btcsuite/btcscript

Examples

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.