README ¶
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 consensus bugs) for block acceptance as Bitcoin Core. We have taken great care to avoid btcd causing a fork to the block chain. It includes a full block validation testing framework which contains all of the 'official' block acceptance tests (and some additional ones) that is run on every pull request to help ensure it properly follows consensus. Also, it passes all of the JSON test data in the Bitcoin Core code.
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 by the block chain and also includes more strict checks which filter transactions based on miner requirements ("standard" transactions).
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 for more details. This means you can't actually make or receive payments directly with btcd. That functionality is provided by the btcwallet and Paymetheus (Windows-only) projects which are both under active development.
Requirements
Go 1.17 or newer.
Installation
https://github.com/VidarSoltuions/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:
$ 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. It is also recommended to add
$GOPATH/bin
to your PATH
at this point.
- Run the following commands to obtain btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ go install -v . ./cmd/...
- btcd (and utilities) will now be installed in
$GOPATH/bin
. If you did not already add the bin directory to your system path during Go installation, we recommend you do so now.
Updating
Linux/BSD/MacOSX/POSIX - Build from Source
- Run the following commands to update btcd, all dependencies, and install it:
$ cd $GOPATH/src/github.com/btcsuite/btcd
$ git pull
$ go install -v . ./cmd/...
Getting Started
btcd has several configuration options available to tweak how it runs, but all of the basic operations described in the intro section work with zero configuration.
Linux/BSD/POSIX/Source
$ ./btcd
IRC
- irc.libera.chat
- channel #btcd
- webchat
Issue Tracker
The integrated github issue tracker is used for this project.
Documentation
The documentation is a work-in-progress. It is located in the docs folder.
Release Verification
Please see our documentation on the current build/verification process for all our releases for information on how to verify the integrity of published releases using our reproducible build system.
License
btcd is licensed under the copyfree ISC License.
Documentation ¶
Overview ¶
btcd is a full-node bitcoin implementation written in Go.
The default options are sane for most users. This means btcd will work 'out of the box' for most users. However, there are also a wide variety of flags that can be used to control it.
The following section provides a usage overview which enumerates the flags. An interesting point to note is that the long form of all of these options (except -C) can be specified in a configuration file that is automatically parsed when btcd starts up. By default, the configuration file is located at ~/.btcd/btcd.conf on POSIX-style operating systems and %LOCALAPPDATA%\btcd\btcd.conf on Windows. The -C (--configfile) flag, as shown below, can be used to override this location.
Usage:
btcd [OPTIONS]
Application Options:
--addcheckpoint= Add a custom checkpoint. Format: '<height>:<hash>' -a, --addpeer= Add a peer to connect with at startup --addrindex Maintain a full address-based transaction index which makes the searchrawtransactions RPC available --banduration= How long to ban misbehaving peers. Valid time units are {s, m, h}. Minimum 1 second (default: 24h0m0s) --banthreshold= Maximum allowed ban score before disconnecting and banning misbehaving peers. (default: 100) --blockmaxsize= Maximum block size in bytes to be used when creating a block (default: 750000) --blockminsize= Minimum block size in bytes to be used when creating a block --blockmaxweight= Maximum block weight to be used when creating a block (default: 3000000) --blockminweight= Minimum block weight to be used when creating a block --blockprioritysize= Size in bytes for high-priority/low-fee transactions when creating a block (default: 50000) --blocksonly Do not accept transactions from remote peers. -C, --configfile= Path to configuration file --connect= Connect only to the specified peers at startup --cpuprofile= Write CPU profile to the specified file -b, --datadir= Directory to store data --dbtype= Database backend to use for the Block Chain (default: ffldb) -d, --debuglevel= Logging level for all subsystems {trace, debug, info, warn, error, critical} -- You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set the log level for individual subsystems -- Use show to list available subsystems (default: info) --dropaddrindex Deletes the address-based transaction index from the database on start up and then exits. --dropcfindex Deletes the index used for committed filtering (CF) support from the database on start up and then exits. --droptxindex Deletes the hash-based transaction index from the database on start up and then exits. --externalip= Add an ip to the list of local addresses we claim to listen on to peers --generate Generate (mine) bitcoins using the CPU --limitfreerelay= Limit relay of transactions with no transaction fee to the given amount in thousands of bytes per minute (default: 15) --listen= Add an interface/port to listen for connections (default all interfaces port: 8333, testnet: 18333, signet: 38333) --logdir= Directory to log output --maxorphantx= Max number of orphan transactions to keep in memory (default: 100) --maxpeers= Max number of inbound and outbound peers (default: 125) --miningaddr= Add the specified payment address to the list of addresses to use for generated blocks -- At least one address is required if the generate option is set --minrelaytxfee= The minimum transaction fee in BTC/kB to be considered a non-zero fee. (default: 1e-05) --nobanning Disable banning of misbehaving peers --nocfilters Disable committed filtering (CF) support --nocheckpoints Disable built-in checkpoints. Don't do this unless you know what you're doing. --nodnsseed Disable DNS seeding for peers --nolisten Disable listening for incoming connections -- NOTE: Listening is automatically disabled if the --connect or --proxy options are used without also specifying listen interfaces via --listen --noonion Disable connecting to tor hidden services --nopeerbloomfilters Disable bloom filtering support --norelaypriority Do not require free or low-fee transactions to have high priority for relaying --norpc Disable built-in RPC server -- NOTE: The RPC server is disabled by default if no rpcuser/rpcpass or rpclimituser/rpclimitpass is specified --notls Disable TLS for the RPC server -- NOTE: This is only allowed if the RPC server is bound to localhost --onion= Connect to tor hidden services via SOCKS5 proxy (eg. 127.0.0.1:9050) --onionpass= Password for onion proxy server --onionuser= Username for onion proxy server --profile= Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536 --proxy= Connect via SOCKS5 proxy (eg. 127.0.0.1:9050) --proxypass= Password for proxy server --proxyuser= Username for proxy server --regtest Use the regression test network --rejectnonstd Reject non-standard transactions regardless of the default settings for the active network. --relaynonstd Relay non-standard transactions regardless of the default settings for the active network. --rpccert= File containing the certificate file --rpckey= File containing the certificate key --rpclimitpass= Password for limited RPC connections --rpclimituser= Username for limited RPC connections --rpclisten= Add an interface/port to listen for RPC connections (default port: 8334, testnet: 18334) --rpcmaxclients= Max number of RPC clients for standard connections (default: 10) --rpcmaxconcurrentreqs= Max number of concurrent RPC requests that may be processed concurrently (default: 20) --rpcmaxwebsockets= Max number of RPC websocket connections (default: 25) --rpcquirks Mirror some JSON-RPC quirks of Bitcoin Core -- NOTE: Discouraged unless interoperability issues need to be worked around -P, --rpcpass= Password for RPC connections -u, --rpcuser= Username for RPC connections --sigcachemaxsize= The maximum number of entries in the signature verification cache (default: 100000) --simnet Use the simulation test network --testnet Use the test network --torisolation Enable Tor stream isolation by randomizing user credentials for each connection. --trickleinterval= Minimum time between attempts to send new inventory to a connected peer (default: 10s) --txindex Maintain a full hash-based transaction index which makes all transactions available via the getrawtransaction RPC --uacomment= Comment to add to the user agent -- See BIP 14 for more information. --upnp Use UPnP to map our listening port outside of NAT -V, --version Display version information and exit --whitelist= Add an IP network or IP that will not be banned. (eg. 192.168.1.0/24 or ::1)
Help Options:
-h, --help Show this help message
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package addrmgr implements concurrency safe Bitcoin address manager.
|
Package addrmgr implements concurrency safe Bitcoin address manager. |
Package blockchain implements bitcoin block handling and chain selection rules.
|
Package blockchain implements bitcoin block handling and chain selection rules. |
fullblocktests
Package fullblocktests provides a set of block consensus validation tests.
|
Package fullblocktests provides a set of block consensus validation tests. |
indexers
Package indexers implements optional block chain indexes.
|
Package indexers implements optional block chain indexes. |
btcec
module
|
|
Package btcjson provides primitives for working with the bitcoin JSON-RPC API.
|
Package btcjson provides primitives for working with the bitcoin JSON-RPC API. |
btcutil
module
|
|
Package chaincfg defines chain configuration parameters.
|
Package chaincfg defines chain configuration parameters. |
chainhash
Module
|
|
cmd
|
|
Package connmgr implements a generic Bitcoin network connection manager.
|
Package connmgr implements a generic Bitcoin network connection manager. |
Package database provides a block and metadata storage database.
|
Package database provides a block and metadata storage database. |
ffldb
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage.
|
Package ffldb implements a driver for the database package that uses leveldb for the backing metadata and flat files for block storage. |
rpctest
Package rpctest provides a btcd-specific RPC testing harness crafting and executing integration tests by driving a `btcd` instance via the `RPC` interface.
|
Package rpctest provides a btcd-specific RPC testing harness crafting and executing integration tests by driving a `btcd` instance via the `RPC` interface. |
Package mempool provides a policy-enforced pool of unmined bitcoin transactions.
|
Package mempool provides a policy-enforced pool of unmined bitcoin transactions. |
Package netsync implements a concurrency safe block syncing protocol.
|
Package netsync implements a concurrency safe block syncing protocol. |
Package peer provides a common base for creating and managing Bitcoin network peers.
|
Package peer provides a common base for creating and managing Bitcoin network peers. |
Package rpcclient implements a websocket-enabled Bitcoin JSON-RPC client.
|
Package rpcclient implements a websocket-enabled Bitcoin JSON-RPC client. |
Package txscript implements the bitcoin transaction script language.
|
Package txscript implements the bitcoin transaction script language. |
vBtcec
module
|
|
vBtcutil
module
|
|
Package wire implements the bitcoin wire protocol.
|
Package wire implements the bitcoin wire protocol. |