An alternative full node implementation of LBRY's blockchain written in Go (golang)
Find a file
Dave Collins 35936c1f01 Don't discuss internals in exported func comments.
This commit cleans up and moves a couple of comments in the recent pull
request which implements a rebroadcast handler (#114) in order to avoid
discussing internal state in the exported function comment.

How a function actually accomplishes the stated functionality is not
something that a caller is concerned with.  The details about the internal
state are better handled with comments inside the function body.
2014-03-27 14:09:34 -05:00
limits Make limits into a pkg. 2014-01-07 16:06:12 -06:00
release Add version to btcctl. 2013-11-19 20:07:31 -06:00
util add importwallet to btcctl 2014-03-24 15:52:40 -04:00
.gitignore Convert .gitignore line endings to unix. 2013-08-07 15:00:20 -05:00
.travis.yml Have TravisCI build against both latest release and tip 2013-12-08 22:11:54 -05:00
addrmanager.go Copy netaddresses in AddressCache instead of referencing them. 2014-02-12 15:33:52 +00:00
addrmanager_test.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
blockmanager.go Implement a rebroadcast handler. 2014-03-27 14:09:33 -05:00
btcd.go Add --logdir option to specify logging directory. 2014-02-12 15:56:05 -06:00
CHANGES Prepare for release 0.7.0. 2014-02-20 15:51:40 -06:00
config.go Add options to control block creation settings. 2014-03-22 11:47:03 -05:00
deps.txt Prepare for release 0.7.0. 2014-02-20 15:51:40 -06:00
discovery.go Unexport and comment btcDial and btcLookup func. 2014-01-10 01:31:20 -06:00
doc.go Rate limit free-to-relay transactions. 2014-02-19 22:39:02 +00:00
LICENSE Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
log.go Add new logging subsystem for mining related ops. 2014-03-22 11:47:02 -05:00
mempool.go Implement a rebroadcast handler. 2014-03-27 14:09:33 -05:00
mining.go Add infrastructure for creating a block template. 2014-03-22 11:47:38 -05:00
mruinvmap.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
mruinvmap_test.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
params.go Add new DNS seed seed.bitcoinstats.com 2014-01-04 23:20:06 -05:00
peer.go Bugfix for issue #101. 2014-03-24 12:28:54 -05:00
README.md Update install command to also install utilities. 2014-03-15 22:32:45 -05:00
rpcserver.go Implement a rebroadcast handler. 2014-03-27 14:09:33 -05:00
rpcwebsocket.go Prevent blocking on RPC server messages after shutdown. 2014-03-21 18:07:36 -05:00
sample-btcd.conf Update sample conf regarding debuglevel subsystems. 2014-02-28 09:54:34 -06:00
server.go Don't discuss internals in exported func comments. 2014-03-27 14:09:34 -05:00
service_windows.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
signal.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
upgrade.go Add 2014 to copyright dates. 2014-01-01 10:16:15 -06:00
upnp.go Add basic support for UPnP. 2013-12-10 22:39:54 +00:00
version.go Prepare for release 0.7.0. 2014-02-20 15:51:40 -06:00

btcd

[Build Status] (https://travis-ci.org/conformal/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 is provided by the btcwallet and btcgui projects which are both under active development.

Requirements

Go 1.2 or newer.

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 (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/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

IRC server

  • irc.conformal.com:6697
  • ssl required
  • channel #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 is used for this project.

Documentation

The documentation is a work-in-progress. It uses the github wiki facility.

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 copyfree ISC License.