dcrd/txscript/README.md
Dave Collins 40d778dd2d docs: Make various README.md files consistent.
Upstream commit 3942a116e4

This merge also includes a few Decred specific modifications and
corrects some old btcjson references that should have been updated to
dcrjson.
2016-05-20 16:00:12 -05:00

48 lines
1.6 KiB
Markdown

txscript
========
[![Build Status](https://travis-ci.org/decred/dcrd.png?branch=master)]
(https://travis-ci.org/decred/dcrd) [![ISC License]
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/decred/dcrd/txscript?status.png)]
(http://godoc.org/github.com/decred/dcrd/txscript)
Package txscript implements the decred transaction script language. There is
a comprehensive test suite.
This package has intentionally been designed so it can be used as a standalone
package for any projects needing to use or validate decred transaction scripts.
## Decred Scripts
Decred provides a stack-based, FORTH-like langauge for the scripts in
the decred transactions. This language is not turing complete
although it is still fairly powerful.
## Installation and Updating
```bash
$ go get -u github.com/decred/dcrd/txscript
```
## Examples
* [Standard Pay-to-pubkey-hash Script]
(http://godoc.org/github.com/decred/dcrd/txscript#example-PayToAddrScript)
Demonstrates creating a script which pays to a decred 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/decred/dcrd/txscript#example-ExtractPkScriptAddrs)
Demonstrates extracting information from a standard public key script.
* [Manually Signing a Transaction Output]
(http://godoc.org/github.com/decred/dcrd/txscript#example-SignTxOutput)
Demonstrates manually creating and signing a redeem transaction.
## License
Package txscript is licensed under the [copyfree](http://copyfree.org) ISC
License.