mirrors/btcd
1
0
Fork 0
mirror of https://github.com/btcsuite/btcd.git synced 2024-11-19 01:40:07 +01:00
Code Issues Projects Releases Wiki Activity
52b6eb46f1
btcd/docs
History
Guillaume A 52b6eb46f1 Update Docker documentation towards building your own image 
As DockerHub image non existant, update the documentation for Compose to build your own image instead.
2022-11-21 11:33:53 -05:00
..
.gitignore Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
code_contribution_guidelines.md docs: update shields 2021-03-05 07:45:19 -05:00
conf.py Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
configuration.md docs: update shields 2021-03-05 07:45:19 -05:00
configuring_tor.md doc: fix Tor hidden service setup link 2022-09-13 09:04:55 -04:00
contact.md Switch irc to libera.chat 2021-08-31 07:50:29 -04:00
controlling.md Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
developer_resources.md multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
index.md docs: update shields 2021-03-05 07:45:19 -05:00
installation.md build: bump min Go version to 1.16.8 add Go 1.17.1 2021-09-15 18:19:34 -07:00
json_rpc_api.md multi: update btcutil imports to point to new sub-module 2022-01-10 18:44:58 -08:00
make.bat Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
Makefile Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
mining.md Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
README.md Added symlink to index.md for github readme preview. 2020-09-01 03:35:40 -04:00
requirements.txt Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
table_of_content.md Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
update.md Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00
using_docker.md Update Docker documentation towards building your own image 2022-11-21 11:33:53 -05:00
wallet.md Major rework on documentation to make it compatible to readthedocs.org 2020-09-01 00:48:08 -04:00

README.md

btcd

Build Status ISC License GoDoc

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.

Documentation

Documentation is a work-in-progress. It is available at btcd.readthedocs.io.

Contents

License

btcd is licensed under the copyfree ISC License.