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)
93 commits 9 branches 35 tags 20 MiB
Go 99.9%
Shell 0.1%
Find a file
Dave Collins b8dc1b66e5 Add new ScriptBuilder for building custom scripts. 
This commit adds a new ScriptBuilder interface that can be used to build
custom scripts.  It currently is fairly basic, but it allows you to push
raw opcodes, ints, and data while respecting canonical encoding.  These
primitives are sufficient to build any script.

This could be improved upon with quite a few things. One example would be
functions for certain opcodes that take properly typed parameters to make
it harder to create invalid scripts.

For now though, it is already quite useful since it handles all of the
opcode selection for canonical data pushes and integer encoding.

The initial discussion took place in #5.
2014-02-20 01:02:57 -06: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 Allow multi-sig scripts with zero signatures. 2014-02-19 16:34:50 -06:00
address_test.go Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
cov_report.sh Initial implementation. 2013-06-13 14:59:46 -05:00
doc.go Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
internal_test.go gofmt 2014-02-04 16:18:37 -05:00
LICENSE Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
log.go Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
opcode.go Correct handling for multi-sig zero signatures. 2014-02-19 15:03:32 -06:00
opcode_test.go gofmt 2014-02-04 16:18:37 -05:00
README.md Add support for TravisCI. 2013-12-10 18:01:11 -06:00
script.go Allow multi-sig scripts with zero signatures. 2014-02-19 16:34:50 -06:00
script_test.go Add tests for multisig with zero required sigs. 2014-02-19 16:52:11 -06:00
scriptbuilder.go Add new ScriptBuilder for building custom scripts. 2014-02-20 01:02:57 -06:00
stack.go Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
stack_test.go Add 2014 to copyright dates. 2014-01-08 23:47:47 -06:00
test_coverage.txt Add tests for multisig with zero required sigs. 2014-02-19 16:52:11 -06:00

README.md

btcscript

[Build Status] (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

Sample Use

	pkscript := txS.TxOut[origintxidx].PkScript
	engine, err := btcscript.NewScript(sigScript, pkscript, txInIdx,
		txValidator, timestamp.After(btcscript.Bip16Activation))
	err = engine.Execute()

Documentation

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

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.