dcrd/txscript/README.md
Dave Collins 611a7e2a99
txscript: Remove unused ExtractPkScriptAddrs.
This removes ExtractPkScriptAddrs and its associated tests, benchmarks,
and example since it is no longer used by anything in the repository
and is now available via stdscript.ExtractAddrs.

This is part of a series of commits to remove all code related to
standard scripts from txscript.
2021-11-18 12:55:23 -06:00

35 lines
1.3 KiB
Markdown

txscript
========
[![Build Status](https://github.com/decred/dcrd/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/dcrd/actions)
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![Doc](https://img.shields.io/badge/doc-reference-blue.svg)](https://pkg.go.dev/github.com/decred/dcrd/txscript/v4)
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 language for the scripts in the Decred
transactions. This language is not Turing complete although it is still fairly
powerful.
## Installation and Updating
This package is part of the `github.com/decred/dcrd/txscript/v3` module. Use
the standard go tooling for working with modules to incorporate it.
## Examples
* [Counting Opcodes in Scripts](https://pkg.go.dev/github.com/decred/dcrd/txscript/v4#example-ScriptTokenizer)
Demonstrates creating a script tokenizer instance and using it to count the
number of opcodes a script contains.
## License
Package txscript is licensed under the [copyfree](http://copyfree.org) ISC
License.