37938375dc
This commit updates the main README.md and docs/README.md files to replace the references to the now dead btcgui project with the Windows-only Paymetheus project. While here, it also updates some information to make it more current and accurately describe the current status.
145 lines
4.3 KiB
Markdown
145 lines
4.3 KiB
Markdown
btcd
|
|
====
|
|
|
|
[]
|
|
(https://travis-ci.org/btcsuite/btcd)
|
|
|
|
btcd is an alternative full node bitcoin implementation written in Go (golang).
|
|
|
|
This project is currently under active development and is in a Beta state. It
|
|
is extremely stable and has been in production use since October 2013.
|
|
|
|
It properly downloads, validates, and serves the block chain using the exact
|
|
rules (including bugs) for block acceptance as Bitcoin Core. We have taken
|
|
great care to avoid btcd causing a fork to the block chain. It passes all of
|
|
the 'official' block acceptance tests
|
|
(https://github.com/TheBlueMatt/test-scripts) as well as all of the JSON test
|
|
data in the Bitcoin Core code.
|
|
|
|
It also relays newly mined blocks, maintains a transaction pool, and relays
|
|
individual transactions that have not yet made it into a block. It ensures all
|
|
transactions admitted to the pool follow the rules required by the block chain
|
|
and also includes the same checks which filter transactions based on
|
|
miner requirements ("standard" transactions) as Bitcoin Core.
|
|
|
|
One key difference between btcd and Bitcoin Core is that btcd does *NOT* include
|
|
wallet functionality and this was a very intentional design decision. See the
|
|
blog entry [here](https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
|
|
for more details. This means you can't actually make or receive payments
|
|
directly with btcd. That functionality is provided by the
|
|
[btcwallet](https://github.com/btcsuite/btcwallet) and
|
|
[Paymetheus](https://github.com/btcsuite/Paymetheus) (Windows-only) projects
|
|
which are both under active development.
|
|
|
|
## Requirements
|
|
|
|
[Go](http://golang.org) 1.5 or newer.
|
|
|
|
## Installation
|
|
|
|
#### Windows - MSI Available
|
|
|
|
https://github.com/btcsuite/btcd/releases
|
|
|
|
#### Linux/BSD/MacOSX/POSIX - Build from Source
|
|
|
|
- Install Go according to the installation instructions here:
|
|
http://golang.org/doc/install
|
|
|
|
- Ensure Go was installed properly and is a supported version:
|
|
|
|
```bash
|
|
$ go version
|
|
$ go env GOROOT GOPATH
|
|
```
|
|
|
|
NOTE: The `GOROOT` and `GOPATH` above must not be the same path. It is
|
|
recommended that `GOPATH` is set to a directory in your home directory such as
|
|
`~/goprojects` to avoid write permission issues.
|
|
|
|
- Run the following command to obtain btcd, all dependencies, and install it:
|
|
|
|
```bash
|
|
$ go get -u github.com/btcsuite/btcd/...
|
|
```
|
|
|
|
- btcd (and utilities) will now be installed in either ```$GOROOT/bin``` or
|
|
```$GOPATH/bin``` depending on your configuration. If you did not already
|
|
add the bin directory to your system path during Go installation, we
|
|
recommend you do so now.
|
|
|
|
## Updating
|
|
|
|
#### Windows
|
|
|
|
Install a newer MSI
|
|
|
|
#### Linux/BSD/MacOSX/POSIX - Build from Source
|
|
|
|
- Run the following command to update btcd, all dependencies, and install it:
|
|
|
|
```bash
|
|
$ go get -u -v github.com/btcsuite/btcd/...
|
|
```
|
|
|
|
## Getting Started
|
|
|
|
btcd has several configuration options avilable to tweak how it runs, but all
|
|
of the basic operations described in the intro section work with zero
|
|
configuration.
|
|
|
|
#### Windows (Installed from MSI)
|
|
|
|
Launch btcd from your Start menu.
|
|
|
|
#### Linux/BSD/POSIX/Source
|
|
|
|
```bash
|
|
$ ./btcd
|
|
````
|
|
|
|
## IRC
|
|
|
|
- irc.freenode.net
|
|
- channel #btcd
|
|
- [webchat](https://webchat.freenode.net/?channels=btcd)
|
|
|
|
## Mailing lists
|
|
|
|
- btcd: discussion of btcd and its packages.
|
|
- btcd-commits: readonly mail-out of source code changes.
|
|
|
|
To subscribe to a given list, send email to list+subscribe@opensource.conformal.com
|
|
|
|
## Issue Tracker
|
|
|
|
The [integrated github issue tracker](https://github.com/btcsuite/btcd/issues)
|
|
is used for this project.
|
|
|
|
## Documentation
|
|
|
|
The documentation is a work-in-progress. It is located in the [docs](https://github.com/btcsuite/btcd/tree/master/docs) folder.
|
|
|
|
## GPG Verification Key
|
|
|
|
All official release tags are signed by Conformal so users can ensure the code
|
|
has not been tampered with and is coming from the btcsuite developers. To
|
|
verify the signature perform the following:
|
|
|
|
- Download the public key from the Conformal website at
|
|
https://opensource.conformal.com/GIT-GPG-KEY-conformal.txt
|
|
|
|
- Import the public key into your GPG keyring:
|
|
```bash
|
|
gpg --import GIT-GPG-KEY-conformal.txt
|
|
```
|
|
|
|
- Verify the release tag with the following command where `TAG_NAME` is a
|
|
placeholder for the specific tag:
|
|
```bash
|
|
git tag -v TAG_NAME
|
|
```
|
|
|
|
## License
|
|
|
|
btcd is licensed under the [copyfree](http://copyfree.org) ISC License.
|