github.com/dashpay/godash@v0.0.0-20160726055534-e038a21e0e3d/txscript/README.md (about)

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