mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 18:00:11 +01:00
Code Issues Projects Releases Wiki Activity
An alternative full node bitcoin implementation written in Go (golang)
219 Commits 4 Branches 66 Tags 58 MiB
Go 99.8%
Shell 0.1%
1420eccf73
Go to file
John C. Vernaleo 1420eccf73 Use rpc errors defined in btcjson.
2013-10-22 12:28:00 -04:00
release Add sample relnotes format release script expects. 2013-10-15 18:16:18 -05:00
util Generate usage from handler data in btcctl. 2013-10-22 10:56:56 -05:00
.gitignore Convert .gitignore line endings to unix. 2013-08-07 15:00:20 -05:00
addrmanager_test.go add tests for RFC*, Local, Valid, and Routable. 2013-10-02 17:34:25 -04:00
addrmanager.go Fix reference counting when expiring peers. 2013-10-14 22:27:21 +01:00
blockmanager.go Add an idle timer for peers. 2013-10-17 17:06:47 +01:00
btcd.go Show the version on server startup. 2013-10-15 15:54:00 -05:00
CHANGES Unix line endings on CHANGES file. 2013-10-15 17:53:16 -05:00
config.go Bump maxpeers to 125 like bitcoind. 2013-10-14 22:27:39 +01:00
deps.txt Add 0.3.1 deps to deps.txt. 2013-10-15 12:03:09 -05:00
discovery.go Change failure to talk to DNS seeders to debug. 2013-10-10 20:30:55 -05:00
doc.go Add config file information to command doc. 2013-10-16 10:16:11 -05:00
LICENSE Initial import. 2013-08-06 19:17:05 -05:00
limits_plan9.go add setLimits stub for plan 9 2013-10-16 15:19:21 -05:00
limits_unix.go add setLimits stub for plan 9 2013-10-16 15:19:21 -05:00
limits_windows.go Up some limits on !windows. 2013-10-07 16:44:46 -05:00
log.go Improve logging. 2013-10-10 17:22:19 -05:00
mempool.go Rework the mempool locking code. 2013-10-21 18:22:59 -05:00
mruinvmap.go Add block inventory relay. 2013-09-11 20:14:13 -05:00
params.go Change default RPC port to 8334 (18334 testnet). 2013-10-16 15:01:43 -05:00
peer.go fix reversed variables in a warning message. 2013-10-17 16:58:57 -04:00
README.md Announce our mailing lists 2013-10-15 12:16:17 -04:00
rpcserver.go Use rpc errors defined in btcjson. 2013-10-22 12:28:00 -04:00
sample-btcd.conf Change default RPC port to 8334 (18334 testnet). 2013-10-16 15:01:43 -05:00
server.go Add an idle timer for peers. 2013-10-17 17:06:47 +01:00
signal.go Make the signal handling concurrent safe. 2013-10-03 09:29:18 -05:00
upgrade.go Rework the data path and db type handling. 2013-09-15 14:25:32 -05:00
version.go Bump version to 0.3.1. 2013-10-15 12:02:14 -05:00

README.md

btcd

btcd is an alternative full node bitcoin implementation written in Go (golang).

This project is currently under active development and is in an Alpha state.

It currently properly downloads, validates, and serves the block chain using the exact rules (including bugs) for block acceptance as the reference implementation (bitcoind). 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).

It also properly relays newly mined blocks, maintains a transaction pool, and relays individual transactions that have not yet made it into a block. It ensures all individual transactions admitted to the pool follow the rules required into the block chain and also includes the vast majority of the more strict checks which filter transactions based on miner requirements ("standard" transactions).

One key difference between btcd and bitcoind is that btcd does NOT include wallet functionality and this was a very intentional design decision. See the blog entry here for more details. This means you can't actually make or receive payments directly with btcd. That functionality will be provided by the forthcoming btcwallet and btcgui.

Installation

Windows - MSI Available

https://github.com/conformal/btcd/releases

Linux/BSD/POSIX - Build from Source

  • Install Go according to the installation instructions here: http://golang.org/doc/install

  • Run the following command to obtain btcd, all dependencies, and install it: $ go get github.com/conformal/btcd

  • btcd will now be installed in either $GOROOT/bin or $GOPATH/bin depending on your configuration. If you did not already add to your system path during the installation, we recommend you do so now.

Updating

Windows

Install a newer MSI

Linux/BSD/POSIX - Build from Source

  • Run the following command to update btcd, all dependencies, and install it: $ go get -u -v github.com/conformal/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

$ ./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

TODO

The following is a brief overview of the next things we have planned to work on for btcd. Note this does not include the separate btcwallet and btcgui which are currently under heavy development:

  • Documentation
  • Code cleanup
  • Add remaining missing RPC calls
  • Add option to allow btcd run as a daemon/service
  • Complete several TODO items in the code
  • Offer 32-bit MSI as well as the 64-bit one
  • Offer cross-compiled binaries for popular OSes (Fedora, Ubuntu, FreeBSD, OpenBSD)

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 Conformal. 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:

    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:

    git tag -v TAG_NAME

License

btcd is licensed under the liberal ISC License.