mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 18:00:11 +01:00
Code Issues Projects Releases Wiki Activity
An alternative full node bitcoin implementation written in Go (golang)
26 Commits 4 Branches 66 Tags 58 MiB
Go 99.8%
Shell 0.1%
244ce4b96e
Go to file
Owain G. Ainsworth 244ce4b96e add IsPayToScriptHash api 
To tell ifa bytestream matches teh p2sh pattern.
2013-06-27 14:20:08 +01:00
.gitignore Initial commit. 2013-06-12 16:22:01 -05:00
address_test.go fix ScriptToAddress when called with 0 length script. 2013-06-26 22:11:54 +01:00
address.go fix ScriptToAddress when called with 0 length script. 2013-06-26 22:11:54 +01:00
cov_report.sh Initial implementation. 2013-06-13 14:59:46 -05:00
doc.go Initial implementation. 2013-06-13 14:59:46 -05:00
internal_test.go fix ScriptToAddress when called with 0 length script. 2013-06-26 22:11:54 +01:00
LICENSE Initial implementation. 2013-06-13 14:59:46 -05:00
log.go Initial implementation. 2013-06-13 14:59:46 -05:00
opcode_test.go gofmt 2013-06-27 14:20:08 +01:00
opcode.go Fix reversed test bug with the max operations handling 2013-06-20 00:30:34 +01:00
README.md Initial implementation. 2013-06-13 14:59:46 -05:00
script_test.go add IsPayToScriptHash api 2013-06-27 14:20:08 +01:00
script.go add IsPayToScriptHash api 2013-06-27 14:20:08 +01:00
stack_test.go gofmt 2013-06-21 01:33:56 +01:00
stack.go int.Sign() in go will never return negative for zero. 2013-06-19 00:51:48 +01:00
test_coverage.txt add IsPayToScriptHash api 2013-06-27 14:20:08 +01:00

README.md

btcscript

Package btcscript implements the bitcoin transaction scripts. There is a test suite which is aiming to reach 100% code coverage. See test_coverage.txt for the current coverage (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, pver,
		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.