You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
79 lines
2.7 KiB
79 lines
2.7 KiB
9 years ago
|
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](http://godoc.org/github.com/btcsuite/btcd/txscript).
|
||
|
|
|
||
|
|
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
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ 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 the btcsuite developers. 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:
|
||
|
|
```bash
|
||
|
|
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:
|
||
|
|
```bash
|
||
|
|
git tag -v TAG_NAME
|
||
|
|
```
|
||
|
|
|
||
|
|
## License
|
||
|
|
|
||
|
|
Package txscript is licensed under the liberal ISC License.
|