github.com/btcsuite/btcd@v0.24.0/txscript/README.md (about)

     1  txscript
     2  ========
     3  
     4  [![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
     5  [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
     6  [![GoDoc](https://pkg.go.dev/github.com/btcsuite/btcd/txscript?status.png)](https://pkg.go.dev/github.com/btcsuite/btcd/txscript)
     7  
     8  Package txscript implements the bitcoin transaction script language.  There is
     9  a comprehensive test suite.
    10  
    11  This package has intentionally been designed so it can be used as a standalone
    12  package for any projects needing to use or validate bitcoin transaction scripts.
    13  
    14  ## Bitcoin Scripts
    15  
    16  Bitcoin provides a stack-based, FORTH-like language for the scripts in
    17  the bitcoin transactions.  This language is not turing complete
    18  although it is still fairly powerful.  A description of the language
    19  can be found at https://en.bitcoin.it/wiki/Script
    20  
    21  ## Installation and Updating
    22  
    23  ```bash
    24  $ go get -u github.com/btcsuite/btcd/txscript
    25  ```
    26  
    27  ## Examples
    28  
    29  * [Standard Pay-to-pubkey-hash Script](https://pkg.go.dev/github.com/btcsuite/btcd/txscript#example-PayToAddrScript)  
    30    Demonstrates creating a script which pays to a bitcoin address.  It also
    31    prints the created script hex and uses the DisasmString function to display
    32    the disassembled script.
    33  
    34  * [Extracting Details from Standard Scripts](https://pkg.go.dev/github.com/btcsuite/btcd/txscript#example-ExtractPkScriptAddrs)  
    35    Demonstrates extracting information from a standard public key script.
    36  
    37  * [Manually Signing a Transaction Output](https://pkg.go.dev/github.com/btcsuite/btcd/txscript#example-SignTxOutput)  
    38    Demonstrates manually creating and signing a redeem transaction.
    39  
    40  * [Counting Opcodes in Scripts](http://godoc.org/github.com/decred/dcrd/txscript#example-ScriptTokenizer)  
    41    Demonstrates creating a script tokenizer instance and using it to count the
    42    number of opcodes a script contains.
    43  
    44  ## GPG Verification Key
    45  
    46  All official release tags are signed by Conformal so users can ensure the code
    47  has not been tampered with and is coming from the btcsuite developers.  To
    48  verify the signature perform the following:
    49  
    50  - Download the public key from the Conformal website at
    51    https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
    52  
    53  - Import the public key into your GPG keyring:
    54    ```bash
    55    gpg --import GIT-GPG-KEY-conformal.txt
    56    ```
    57  
    58  - Verify the release tag with the following command where `TAG_NAME` is a
    59    placeholder for the specific tag:
    60    ```bash
    61    git tag -v TAG_NAME
    62    ```
    63  
    64  ## License
    65  
    66  Package txscript is licensed under the [copyfree](http://copyfree.org) ISC
    67  License.