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

     1  btcd
     2  ====
     3  
     4  [![Build Status](https://travis-ci.org/dashpay/godash.png?branch=master)]
     5  (https://travis-ci.org/dashpay/godash)
     6  
     7  btcd is an alternative full node bitcoin implementation written in Go (golang).
     8  
     9  This project is currently under active development and is in a Beta state.  It
    10  is extremely stable and has been in production use since October 2013.
    11  
    12  It properly downloads, validates, and serves the block chain using the exact
    13  rules (including bugs) for block acceptance as Bitcoin Core.  We have taken
    14  great care to avoid btcd causing a fork to the block chain.  It passes all of
    15  the 'official' block acceptance tests
    16  (https://github.com/TheBlueMatt/test-scripts) as well as all of the JSON test
    17  data in the Bitcoin Core code.
    18  
    19  It also relays newly mined blocks, maintains a transaction pool, and relays
    20  individual transactions that have not yet made it into a block.  It ensures all
    21  transactions admitted to the pool follow the rules required by the block chain
    22  and also includes the same checks which filter transactions based on
    23  miner requirements ("standard" transactions) as Bitcoin Core.
    24  
    25  One key difference between btcd and Bitcoin Core is that btcd does *NOT* include
    26  wallet functionality and this was a very intentional design decision.  See the
    27  blog entry [here](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
    28  for more details.  This means you can't actually make or receive payments
    29  directly with btcd.  That functionality is provided by the
    30  [btcwallet](https://github.com/btcsuite/btcwallet) and
    31  [Paymetheus](https://github.com/btcsuite/Paymetheus) (Windows-only) projects
    32  which are both under active development.
    33  
    34  ## Requirements
    35  
    36  [Go](http://golang.org) 1.5 or newer.
    37  
    38  ## Installation
    39  
    40  #### Windows - MSI Available
    41  
    42  https://github.com/dashpay/godash/releases
    43  
    44  #### Linux/BSD/MacOSX/POSIX - Build from Source
    45  
    46  - Install Go according to the installation instructions here:
    47    http://golang.org/doc/install
    48  
    49  - Ensure Go was installed properly and is a supported version:
    50  
    51  ```bash
    52  $ go version
    53  $ go env GOROOT GOPATH
    54  ```
    55  
    56  NOTE: The `GOROOT` and `GOPATH` above must not be the same path.  It is
    57  recommended that `GOPATH` is set to a directory in your home directory such as
    58  `~/goprojects` to avoid write permission issues.  It is also recommended to add
    59  `$GOPATH/bin` to your `PATH` at this point.
    60  
    61  **NOTE:** If you are using Go 1.5, you must manually enable the vendor
    62  experiment by setting the `GO15VENDOREXPERIMENT` environment variable to `1`.
    63  This step is not required for Go 1.6.
    64  
    65  - Run the following commands to obtain btcd, all dependencies, and install it:
    66  
    67  ```bash
    68  $ go get -u github.com/Masterminds/glide
    69  $ git clone https://github.com/dashpay/godash $GOPATH/src/github.com/dashpay/godash
    70  $ cd $GOPATH/src/github.com/dashpay/godash
    71  $ glide install
    72  $ go install . ./cmd/...
    73  ```
    74  
    75  - btcd (and utilities) will now be installed in ```$GOPATH/bin```.  If you did
    76    not already add the bin directory to your system path during Go installation,
    77    we recommend you do so now.
    78  
    79  ## Updating
    80  
    81  #### Windows
    82  
    83  Install a newer MSI
    84  
    85  #### Linux/BSD/MacOSX/POSIX - Build from Source
    86  
    87  - Run the following commands to update btcd, all dependencies, and install it:
    88  
    89  ```bash
    90  $ cd $GOPATH/src/github.com/dashpay/godash
    91  $ git pull && glide install
    92  $ go install . ./cmd/...
    93  ```
    94  
    95  ## Getting Started
    96  
    97  btcd has several configuration options avilable to tweak how it runs, but all
    98  of the basic operations described in the intro section work with zero
    99  configuration.
   100  
   101  #### Windows (Installed from MSI)
   102  
   103  Launch btcd from your Start menu.
   104  
   105  #### Linux/BSD/POSIX/Source
   106  
   107  ```bash
   108  $ ./btcd
   109  ````
   110  
   111  ## IRC
   112  
   113  - irc.freenode.net
   114  - channel #btcd
   115  - [webchat](https://webchat.freenode.net/?channels=btcd)
   116  
   117  ## Mailing lists
   118  
   119  - btcd: discussion of btcd and its packages.
   120  - btcd-commits: readonly mail-out of source code changes.
   121  
   122  To subscribe to a given list, send email to list+subscribe@opensource.conformal.com
   123  
   124  ## Issue Tracker
   125  
   126  The [integrated github issue tracker](https://github.com/dashpay/godash/issues)
   127  is used for this project.
   128  
   129  ## Documentation
   130  
   131  The documentation is a work-in-progress.  It is located in the [docs](https://github.com/dashpay/godash/tree/master/docs) folder.
   132  
   133  ## GPG Verification Key
   134  
   135  All official release tags are signed by Conformal so users can ensure the code
   136  has not been tampered with and is coming from the btcsuite developers.  To
   137  verify the signature perform the following:
   138  
   139  - Download the public key from the Conformal website at
   140    https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
   141  
   142  - Import the public key into your GPG keyring:
   143    ```bash
   144    gpg --import GIT-GPG-KEY-conformal.txt
   145    ```
   146  
   147  - Verify the release tag with the following command where `TAG_NAME` is a
   148    placeholder for the specific tag:
   149    ```bash
   150    git tag -v TAG_NAME
   151    ```
   152  
   153  ## License
   154  
   155  btcd is licensed under the [copyfree](http://copyfree.org) ISC License.