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
44abf0a53c
btcd/README.md

122 lines
4.3 KiB
Markdown
Raw Normal View History

Update TODO list in README.md.
2013-09-09 18:00:46 +02:00
btcd
====
build: replace travis-ci with github actions. test go 1.14 use golangci-lint
2020-05-13 14:44:07 +02:00
[![Build Status](https://github.com/btcsuite/btcd/workflows/Build%20and%20Test/badge.svg)](https://github.com/btcsuite/btcd/actions)
GitHub Actions: Enable Go Race detector and code coverage This modifies the goclean.sh script to run tests with the race detector enabled. It also enables code coverage, and uploads the results to coveralls.io. Running tests with -race and -cover flags was disabled in 6487ba1 and 6788df7 respectively, due to some limits on time/goroutines being hit on Travis CI. Since we have migrated to GitHub Actions, it is desirable to bring them back.
2020-08-24 20:58:47 +02:00
[![Coverage Status](https://coveralls.io/repos/github/btcsuite/btcd/badge.svg?branch=master)](https://coveralls.io/github/btcsuite/btcd?branch=master)
build: replace travis-ci with github actions. test go 1.14 use golangci-lint
2020-05-13 14:44:07 +02:00
[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
docs: update shields
2021-03-04 23:12:45 +01:00
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](https://pkg.go.dev/github.com/btcsuite/btcd)
Add TravisCI build status badge to README.md.
2013-12-09 03:44:06 +01:00
Update TODO list in README.md.
2013-09-09 18:00:46 +02:00
btcd is an alternative full node bitcoin implementation written in Go (golang).
Update pre-release and README.me to beta. This is part of the changes for #130.
2014-05-23 18:18:08 +02:00
This project is currently under active development and is in a Beta state. It
docs: Update READMEs with current details. This commit updates the main README.md and docs/README.md files to replace the references to the now dead btcgui project with the Windows-only Paymetheus project. While here, it also updates some information to make it more current and accurately describe the current status.
2016-03-11 21:36:32 +01:00
is extremely stable and has been in production use since October 2013.
Update pre-release and README.me to beta. This is part of the changes for #130.
2014-05-23 18:18:08 +02:00
It properly downloads, validates, and serves the block chain using the exact
blockchain: Add block validation infrastructure. This adds a full-blown testing infrastructure in order to test consensus validation rules. It is built around the idea of dynamically generating full blocks that target specific rules linked together to form a block chain. In order to properly test the rules, each test instance starts with a valid block that is then modified in the specific way needed to test a specific rule. Blocks which exercise following rules have been added for this initial version. These tests were largely ported from the original Java-based 'official' block acceptance tests as well as some additional tests available in the Core python port. It is expected that further tests can be added over time as consensus rules change. * Enough valid blocks to have a stable base of mature coinbases to spend for futher tests * Basic forking and chain reorganization * Double spends on forks * Too much proof-of-work coinbase (extending main chain, in block that forces a reorg, and in a valid fork) * Max and too many signature operations via various combinations of OP_CHECKSIG, OP_MULTISIG, OP_CHECKSIGVERIFY, and OP_MULTISIGVERIFY * Too many and max signature operations with offending sigop after invalid data push * Max and too many signature operations via pay-to-script-hash redeem scripts * Attempt to spend tx created on a different fork * Attempt to spend immature coinbase (on main chain and fork) * Max size block and block that exceeds the max size * Children of rejected blocks are either orphans or rejected * Coinbase script too small and too large * Max length coinbase script * Attempt to spend tx in blocks that failed to connect * Valid non-coinbase tx in place of coinbase * Block with no transactions * Invalid proof-of-work * Block with a timestamp too far in the future * Invalid merkle root * Invalid proof-of-work limit (bits header field) * Negative proof-of-work limit (bits header field) * Two coinbase transactions * Duplicate transactions * Spend from transaction that does not exist * Timestamp exactly at and one second after the median time * Blocks with same hash via merkle root tricks * Spend from transaction index that is out of range * Transaction that spends more that its inputs provide * Transaction with same hash as an existing tx that has not been fully spent (BIP0030) * Non-final coinbase and non-coinbase txns * Max size block with canonical encoding which exceeds max size with non-canonical encoding * Spend from transaction earlier in same block * Spend from transaction later in same block * Double spend transaction from earlier in same block * Coinbase that pays more than subsidy + fees * Coinbase that includes subsidy + fees * Invalid opcode in dead execution path * Reorganization of txns with OP_RETURN outputs * Spend of an OP_RETURN output * Transaction with multiple OP_RETURN outputs * Large max-sized block reorganization test (disabled by default since it takes a long time and a lot of memory to run) Finally, the README.md files in the main and docs directories have been updated to reflect the use of the new testing framework.
2016-09-14 01:11:12 +02:00
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.
Update pre-release and README.me to beta. This is part of the changes for #130.
2014-05-23 18:18:08 +02:00
blockchain: Add block validation infrastructure. This adds a full-blown testing infrastructure in order to test consensus validation rules. It is built around the idea of dynamically generating full blocks that target specific rules linked together to form a block chain. In order to properly test the rules, each test instance starts with a valid block that is then modified in the specific way needed to test a specific rule. Blocks which exercise following rules have been added for this initial version. These tests were largely ported from the original Java-based 'official' block acceptance tests as well as some additional tests available in the Core python port. It is expected that further tests can be added over time as consensus rules change. * Enough valid blocks to have a stable base of mature coinbases to spend for futher tests * Basic forking and chain reorganization * Double spends on forks * Too much proof-of-work coinbase (extending main chain, in block that forces a reorg, and in a valid fork) * Max and too many signature operations via various combinations of OP_CHECKSIG, OP_MULTISIG, OP_CHECKSIGVERIFY, and OP_MULTISIGVERIFY * Too many and max signature operations with offending sigop after invalid data push * Max and too many signature operations via pay-to-script-hash redeem scripts * Attempt to spend tx created on a different fork * Attempt to spend immature coinbase (on main chain and fork) * Max size block and block that exceeds the max size * Children of rejected blocks are either orphans or rejected * Coinbase script too small and too large * Max length coinbase script * Attempt to spend tx in blocks that failed to connect * Valid non-coinbase tx in place of coinbase * Block with no transactions * Invalid proof-of-work * Block with a timestamp too far in the future * Invalid merkle root * Invalid proof-of-work limit (bits header field) * Negative proof-of-work limit (bits header field) * Two coinbase transactions * Duplicate transactions * Spend from transaction that does not exist * Timestamp exactly at and one second after the median time * Blocks with same hash via merkle root tricks * Spend from transaction index that is out of range * Transaction that spends more that its inputs provide * Transaction with same hash as an existing tx that has not been fully spent (BIP0030) * Non-final coinbase and non-coinbase txns * Max size block with canonical encoding which exceeds max size with non-canonical encoding * Spend from transaction earlier in same block * Spend from transaction later in same block * Double spend transaction from earlier in same block * Coinbase that pays more than subsidy + fees * Coinbase that includes subsidy + fees * Invalid opcode in dead execution path * Reorganization of txns with OP_RETURN outputs * Spend of an OP_RETURN output * Transaction with multiple OP_RETURN outputs * Large max-sized block reorganization test (disabled by default since it takes a long time and a lot of memory to run) Finally, the README.md files in the main and docs directories have been updated to reflect the use of the new testing framework.
2016-09-14 01:11:12 +02:00
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).
Update pre-release and README.me to beta. This is part of the changes for #130.
2014-05-23 18:18:08 +02:00
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
Major rework on documentation to make it compatible to readthedocs.org
2019-09-09 17:24:56 +02:00
blog entry [here](https://web.archive.org/web/20171125143919/https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
Correct blog link in README.md.
2013-10-05 09:51:12 +02:00
for more details. This means you can't actually make or receive payments
Update README.md with recent information.
2014-02-04 18:03:35 +01:00
directly with btcd. That functionality is provided by the
Update btcwallet import paths to new location.
2015-01-17 07:27:28 +01:00
[btcwallet](https://github.com/btcsuite/btcwallet) and
docs: Update READMEs with current details. This commit updates the main README.md and docs/README.md files to replace the references to the now dead btcgui project with the Windows-only Paymetheus project. While here, it also updates some information to make it more current and accurately describe the current status.
2016-03-11 21:36:32 +01:00
[Paymetheus](https://github.com/btcsuite/Paymetheus) (Windows-only) projects
which are both under active development.
Update README.
2013-10-05 05:59:05 +02:00
Add a requirements section to the README
2014-02-13 18:39:17 +01:00
## Requirements
main: Update README.md's minimum go version The readme suggests a minimum version of 1.16 but the go.mod requires go 1.17.
2023-05-05 18:26:54 +02:00
[Go](http://golang.org) 1.17 or newer.
Add a requirements section to the README
2014-02-13 18:39:17 +01:00
Update README.
2013-10-05 05:59:05 +02:00
## Installation
Update btcd import paths to new location.
2015-01-17 07:48:13 +01:00
https://github.com/btcsuite/btcd/releases
Update README.
2013-10-05 05:59:05 +02:00
AddMac OSX to install instructions in README.md
2015-01-24 02:45:50 +01:00
#### Linux/BSD/MacOSX/POSIX - Build from Source
Update README.
2013-10-05 05:59:05 +02:00
- Install Go according to the installation instructions here:
http://golang.org/doc/install
Update README.md install section. This commit adds an additional step to the README.md install section to run the go version command and check the version so people that are installing it for the first time and ensure they are running a high enough version and have GOROOT and GOPATH set correctly.
2015-05-29 22:25:52 +02:00
- Ensure Go was installed properly and is a supported version:
```bash
$ 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
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
`~/goprojects` to avoid write permission issues. It is also recommended to add
`$GOPATH/bin` to your `PATH` at this point.
Update README.md install section. This commit adds an additional step to the README.md install section to run the go version command and check the version so people that are installing it for the first time and ensure they are running a high enough version and have GOROOT and GOPATH set correctly.
2015-05-29 22:25:52 +02:00
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
- Run the following commands to obtain btcd, all dependencies, and install it:
Improve README readability
2015-02-08 19:00:36 +01:00
```bash
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
$ cd $GOPATH/src/github.com/btcsuite/btcd
multi: remove use of GO111MODULE The use of the GO111MODULE environment variable doesn't have any effect anymore and hasn't for a couple of versions. The default was set to "on" a while back, so we can remove that variable everywhere.
2022-09-27 22:04:18 +02:00
$ go install -v . ./cmd/...
Improve README readability
2015-02-08 19:00:36 +01:00
```
Update README.
2013-10-05 05:59:05 +02:00
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
- 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.
Update README.
2013-10-05 05:59:05 +02:00
Add updating instruction to README.md.
2013-10-08 20:30:36 +02:00
## Updating
AddMac OSX to install instructions in README.md
2015-01-24 02:45:50 +01:00
#### Linux/BSD/MacOSX/POSIX - Build from Source
Add updating instruction to README.md.
2013-10-08 20:30:36 +02:00
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
- Run the following commands to update btcd, all dependencies, and install it:
Improve README readability
2015-02-08 19:00:36 +01:00
```bash
build: Convert project to use glide. (#689) This converts the project to allow btcd to be used with the glide package manager in order to provide stable and reproducible builds without the user having to jump through all of the hoops as they do today. It consists of adding a glide.yaml file which identifies the project dependencies and locations along with a glide.lock file which contains the complete dependency tree pinned to specific versions. Glide uses these files to download the packages (or updates) to a local vendor directory and checkout the correct pinned versions. The go tool, in turn, is used to build/install btcd and will use the pinned versions in the vendor directory. This also updates TravisCI to build using glide, removes some of the exceptions in the lint checks which are no longer required, and updates the README.md with the new instructions needed to build the project with glide.
2016-05-06 17:47:53 +02:00
$ cd $GOPATH/src/github.com/btcsuite/btcd
README: require go1.11, document module installation
2018-11-30 02:53:41 +01:00
$ git pull
multi: remove use of GO111MODULE The use of the GO111MODULE environment variable doesn't have any effect anymore and hasn't for a couple of versions. The default was set to "on" a while back, so we can remove that variable everywhere.
2022-09-27 22:04:18 +02:00
$ go install -v . ./cmd/...
Improve README readability
2015-02-08 19:00:36 +01:00
```
Add updating instruction to README.md.
2013-10-08 20:30:36 +02:00
Update README.
2013-10-05 05:59:05 +02:00
## Getting Started
btcd/multi: fix a number of typos in comments.
2017-10-29 20:56:03 +01:00
btcd has several configuration options available to tweak how it runs, but all
Update README.
2013-10-05 05:59:05 +02:00
of the basic operations described in the intro section work with zero
configuration.
#### Linux/BSD/POSIX/Source
```bash
$ ./btcd
Remove extra backtick in README.md
2016-09-13 21:10:19 +02:00
```
mention IRC server
2014-03-04 18:58:59 +01:00
Update docs for IRC move to freenode.
2015-05-12 20:01:58 +02:00
## IRC
mention IRC server
2014-03-04 18:58:59 +01:00
Switch irc to libera.chat
2021-05-26 17:19:15 +02:00
- irc.libera.chat
mention IRC server
2014-03-04 18:58:59 +01:00
- channel #btcd
Switch irc to libera.chat
2021-05-26 17:19:15 +02:00
- [webchat](https://web.libera.chat/gamja/?channels=btcd)
mention IRC server
2014-03-04 18:58:59 +01:00
Update README.md with recent information.
2014-02-04 18:03:35 +01:00
## Issue Tracker
Update TODO list in README.md.
2013-09-09 18:00:46 +02:00
Update btcd import paths to new location.
2015-01-17 07:48:13 +01:00
The [integrated github issue tracker](https://github.com/btcsuite/btcd/issues)
Update README.md with recent information.
2014-02-04 18:03:35 +01:00
is used for this project.
Update README.
2013-10-05 05:59:05 +02:00
Add wiki link to README.md. T# util/loadheaders/
2014-02-04 18:06:39 +01:00
## Documentation
Move all wiki docs into docs folder of the repo. This allows the docs to be updated via pull requests and makes it easier to keep it in sync as a part of normal code updates.
2015-01-18 18:16:43 +01:00
The documentation is a work-in-progress. It is located in the [docs](https://github.com/btcsuite/btcd/tree/master/docs) folder.
Add wiki link to README.md. T# util/loadheaders/
2014-02-04 18:06:39 +01:00
release: add new release script and documentation In this commit, we add the new release script that will be used to build all release binaries going forward. We also remove the existing Conformal key as it's no longer in use, updating the README to reflect the new release build/verification process.
2019-10-11 01:17:57 +02:00
## Release Verification
Update README.
2013-10-05 05:59:05 +02:00
release: add new release script and documentation In this commit, we add the new release script that will be used to build all release binaries going forward. We also remove the existing Conformal key as it's no longer in use, updating the README to reflect the new release build/verification process.
2019-10-11 01:17:57 +02:00
Please see our [documentation on the current build/verification
process](https://github.com/btcsuite/btcd/tree/master/release) for all our
releases for information on how to verify the integrity of published releases
using our reproducible build system.
Update README.
2013-10-05 05:59:05 +02:00
## License
Remove extra parnethesis in previous.
2014-01-15 17:19:51 +01:00
btcd is licensed under the [copyfree](http://copyfree.org) ISC License.
Reference in New Issue Copy Permalink