Decred daemon in Go (golang).
Clone or download
Pull request Compare This branch is 1479 commits ahead, 532 commits behind btcsuite:master.
davecgh blockchain: Cleanup and optimize stake node logic.
This reworks the stake node handling logic a bit to clean it up,
slightly optimize it, and to make it easier to decouple the chain
processing and connection code from the download logic in the future.

To accomplish this, the fetchStakeNode dependence on the
getReorganizeNodes function is removed in favor of directly iterating
the block nodes in the function as needed.  Not only is this more
efficient, it also allows the function to return stake nodes for
branches regardless of their validation status.  Currently, this is
irrelevant due to the connection and download logic being tightly
coupled.  However, it will be necessary in the future when those are
separated.

Also, the flushing and pruning logic is modified to no longer rely on
the download logic being tightly coupled to the the connection logic.
In particular, a new function named flushBlockIndex is added as a
wrapper to the index flush function which populates stake information in
a node before flushing it to the database as needed, and all flushing
invocations use the wrapper instead.

Finally, the stakeUndoData field is removed since it is only used to
avoid some database loads on reorgs that are large enough to exceed the
pruning depth, which never happens in practice anyway, so there is no
point in using up extra memory for it.
Latest commit 20631a1 Oct 19, 2018
Permalink
Failed to load latest commit information.
.github docs: Add github pull request template. Oct 1, 2018
addrmgr build: Tidy module sums (go mod tidy). Aug 17, 2018
blockchain blockchain: Cleanup and optimize stake node logic. Oct 19, 2018
certgen multi: Make changes suggested by Go 1.11 gofmt -s. Aug 23, 2018
chaincfg chaincfg: Unexport internal errors. Oct 10, 2018
cmd limits: Make limits package internal. Sep 6, 2018
connmgr build: Tidy module sums (go mod tidy). Aug 17, 2018
database build: Tidy module sums (go mod tidy). Aug 17, 2018
dcrec multi: Address some golint complaints. Oct 11, 2018
dcrjson multi: Return total chain work in RPC results. Oct 16, 2018
dcrutil multi: Use regression test network in unit tests. Oct 10, 2018
docs multi: Return total chain work in RPC results. Oct 16, 2018
gcs build: Tidy module sums (go mod tidy). Aug 17, 2018
hdkeychain multi: Resurrect regression network. Oct 9, 2018
internal limits: Make limits package internal. Sep 6, 2018
mempool multi: Correct a few typos found by misspell. Oct 11, 2018
mining dcrjson: Add listtickets command. Oct 11, 2018
peer dcrjson: Add listtickets command. Oct 11, 2018
release Add example service files. Mar 23, 2017
rpcclient multi: Cleanup the unsupported dcrwallet commands. Oct 11, 2018
rpctest multi: Address some golint complaints. Oct 11, 2018
sampleconfig docs: Correct blockmaxsize and blockprioritysize. Jul 7, 2018
txscript multi: Use regression test network in unit tests. Oct 10, 2018
wire multi: Resurrect regression network. Oct 9, 2018
.dockerignore docker: Add dockerfiles for running dcrd nodes. Jul 7, 2018
.gitignore main: add address encoding magic constants test Sep 26, 2018
.travis.yml multi: Make use of new internal version package. Sep 4, 2018
CHANGES multi: Properly capitalize Decred. Mar 1, 2018
Dockerfile docker: Update to go 1.11. Sep 20, 2018
Dockerfile.alpine docker: Update to go 1.11. Sep 20, 2018
LICENSE multi: Add initial committed filter (CF) support Mar 30, 2018
README.md docs: Add README badge and link for goreportcard. Oct 11, 2018
blocklogger.go multi: Replace btclog with slog. May 23, 2018
blockmanager.go multi: Resurrect regression network. Oct 9, 2018
cert_test.go main: move cert tests to a separated file Oct 18, 2018
config.go multi: Cleanup recent alt DNS names additions. Oct 11, 2018
config_test.go multi: Cleanup recent alt DNS names additions. Oct 11, 2018
cpuminer.go multi: Move update blk time to blk templ generator. Sep 14, 2018
dcrd.go limits: Make limits package internal. Sep 6, 2018
doc.go multi: Cleanup recent alt DNS names additions. Oct 11, 2018
go.mod multi: Use regression test network in unit tests. Oct 10, 2018
go.sum build: Tidy module sums (go mod tidy). Aug 17, 2018
ipc.go travis: add ineffassign linter Dec 1, 2017
log.go multi: Replace btclog with slog. May 23, 2018
mining.go multi: Latest consensus active from simnet genesis. Oct 10, 2018
mining_test.go mining_test: add edge conditions from btcd. Aug 31, 2017
miningerror.go blockchain: Rework to use new db interface. Aug 18, 2016
networkparams_test.go multi: Resurrect regression network. Oct 9, 2018
params.go multi: Resurrect regression network. Oct 9, 2018
rpcserver.go multi: Return total chain work in RPC results. Oct 16, 2018
rpcserver_test.go main: move cert tests to a separated file Oct 18, 2018
rpcserverhelp.go multi: Return total chain work in RPC results. Oct 16, 2018
rpcserverhelp_test.go blockchain: Rework to use new db interface. Aug 18, 2016
rpcwebsocket.go rpc: Use upstream gorilla/websocket. May 24, 2018
run_tests.sh build: Support MacOS sed for obtaining module list. Oct 8, 2018
server.go multi: add cpuminerConfig. Sep 13, 2018
service_windows.go multi: Make use of new internal version package. Sep 4, 2018
signal.go dcrd: Simplify shutdown signal handling logic sync. Nov 18, 2016
signalsigterm.go Add pipes for parent process IPC. (#311) Aug 31, 2016
upnp.go multi: Error descriptions are in lower case. Sep 8, 2017

README.md

dcrd

Build Status ISC License GoDoc Go Report Card

Decred Overview

Decred is a blockchain-based cryptocurrency with a strong focus on community input, open governance, and sustainable funding for development. It utilizes a hybrid proof-of-work and proof-of-stake mining system to ensure that a small group cannot dominate the flow of transactions or make changes to Decred without the input of the community. A unit of the currency is called a decred (DCR).

https://decred.org

Latest Downloads

https://decred.org/downloads

What is dcrd?

dcrd is a full node implementation of Decred written in Go (golang).

It acts as a fully-validating chain daemon for the Decred cryptocurrency. dcrd maintains the entire past transactional ledger of Decred and allows relaying of transactions to other Decred nodes around the world.

This software is currently under active development. It is extremely stable and has been in production use since February 2016.

The sofware was originally forked from btcd, which is a bitcoin full node implementation that is still under active development. To gain the benefit of btcd's ongoing upgrades, including improved peer and connection handling, database optimization, and other blockchain related technology improvements, dcrd is continuously synced with the btcd codebase.

What is a full node?

The term 'full node' is short for 'fully-validating node' and refers to software that fully validates all transactions and blocks, as opposed to trusting a 3rd party. In addition to validating transactions and blocks, nearly all full nodes also participate in relaying transactions and blocks to other full nodes around the world, thus forming the peer-to-peer network that is the backbone of the Decred cryptocurrency.

The full node distinction is important, since full nodes are not the only type of software participating in the Decred peer network. For instance, there are 'lightweight nodes' which rely on full nodes to serve the transactions, blocks, and cryptographic proofs they require to function, as well as relay their transactions to the rest of the global network.

Why run dcrd?

As described in the previous section, the Decred cryptocurrency relies on having a peer-to-peer network of nodes that fully validate all transactions and blocks and then relay them to other full nodes.

Running a full node with dcrd contributes to the overall security of the network, increases the available paths for transactions and blocks to relay, and helps ensure there are an adequate number of nodes available to serve lightweight clients, such as Simplified Payment Verification (SPV) wallets.

Without enough full nodes, the network could be unable to expediently serve users of lightweight clients which could force them to have to rely on centralized services that significantly reduce privacy and are vulernable to censorship.

In terms of individual benefits, since dcrd fully validates every block and transaction, it provides the highest security and privacy possible when used in conjunction with a wallet that also supports directly connecting to it in full validation mode, such as dcrwallet (CLI) and Decrediton (GUI).

Minimum Recommended Specifications (dcrd only)

  • 10 GB disk space (as of September 2018, increases over time)
  • 1GB memory (RAM)
  • ~150MB/day download, ~1.5GB/day upload
    • Plus one-time initial download of the entire block chain
  • Windows 7/8.x/10 (server preferred), macOS, Linux
  • High uptime

Getting Started

So, you've decided to help the network by running a full node. Great! Running dcrd is simple. All you need to do is install dcrd on a machine that is connected to the internet and meets the minimum recommended specifications, and launch it.

Also, make sure your firewall is configured to allow inbound connections to port 9108.

Installing and updating

Binaries (Windows/Linux/macOS)

Binary releases are provided for common operating systems and architectures:

https://decred.org/downloads

Build from source (all platforms)

Building or updating from source requires the following build dependencies:

  • Go 1.10 or 1.11

    Installation instructions can be found here: https://golang.org/doc/install. It is recommended to add $GOPATH/bin to your PATH at this point.

  • Vgo (Go 1.10 only)

    The GO111MODULE experiment is used to manage project dependencies and provide reproducible builds. The module experiment is provided by the Go 1.11 toolchain, but the Go 1.10 toolchain does not provide any module support. To perform module-aware builds with Go 1.10, vgo (a drop-in replacement for the go command) must be used instead.

  • Git

    Installation instructions can be found at https://git-scm.com or https://gitforwindows.org.

To build and install from a checked-out repo, run go install . ./cmd/... in the repo's root directory. Some notes:

  • Set the GO111MODULE=on environment variable if using Go 1.11 and building from within GOPATH.

  • Replace go with vgo when using Go 1.10.

  • The dcrd executable will be installed to $GOPATH/bin. GOPATH defaults to $HOME/go (or %USERPROFILE%\go on Windows) if unset.

Example of obtaining and building from source on Windows 10 with Go 1.11:

PS> git clone https://github.com/decred/dcrd $env:USERPROFILE\src\dcrd
PS> cd $env:USERPROFILE\src\dcrd
PS> go install . .\cmd\...
PS> & "$(go env GOPATH)\bin\dcrd" -V

Example of obtaining and building from source on Linux with Go 1.10:

$ git clone https://github.com/decred/dcrd ~/src/dcrd
$ cd ~/src/dcrd
$ vgo install . ./cmd/...
$ $(vgo env GOPATH)/bin/dcrd -V

Docker

Running dcrd

You can run a decred node from inside a docker container. To build the image yourself, use the following command:

docker build -t decred/dcrd .

Or you can create an alpine based image (requires Docker 17.05 or higher):

docker build -t decred/dcrd:alpine -f Dockerfile.alpine .

You can then run the image using:

docker run decred/dcrd

You may wish to use an external volume to customise your config and persist the data in an external volume:

docker run --rm -v /home/user/dcrdata:/root/.dcrd/data decred/dcrd

For a minimal image, you can use the decred/dcrd:alpine tag. This is typically a more secure option while also being a much smaller image.

You can run dcrctl from inside the image. For example, run an image (mounting your data from externally) with:

docker run --rm -ti --name=dcrd-1 -v /home/user/.dcrd:/root/.dcrd \
  decred/dcrd:alpine

And then run dcrctl commands against it. For example:

docker exec -ti dcrd-1 dcrctl getbestblock

Running Tests

All tests and linters may be run in a docker (or podman) container using the script run_tests.sh by specifying either docker or podman as the first parameter. This script defaults to using the current latest supported version of Go, but it also respects the GOVERSION environment variable set to the major version of Go to allow testing on a previous version of Go. Generally, Decred only supports the current and previous major versions of Go.

./run_tests.sh docker

To run the tests locally without docker on the latest supported version of Go:

./run_tests.sh

To run the tests locally without docker on Go 1.10:

GOVERSION=1.10 ./run_tests.sh

Contact

If you have any further questions you can find us at:

https://decred.org/community

Issue Tracker

The integrated github issue tracker is used for this project.

Documentation

The documentation for dcrd is a work-in-progress. It is located in the docs folder.

License

dcrd is licensed under the copyfree ISC License.