LBRYCommunity/lbcd
1
0
Fork 0
Code Issues 17 Pull requests 4 Projects Releases 28 Packages Wiki Activity
lbcd/docs/README.md

306 lines
11 KiB
Markdown
Raw Normal View History

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
### Table of Contents
1. [About](#About)
2. [Getting Started](#GettingStarted)
1. [Installation](#Installation)
1. [Windows](#WindowsInstallation)
2. [Linux/BSD/MacOSX/POSIX](#PosixInstallation)
add installation instructions for Gentoo
2015-11-08 21:55:08 +01:00
1. [Gentoo Linux](#GentooInstallation)
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
2. [Configuration](#Configuration)
3. [Controlling and Querying btcd via btcctl](#BtcctlConfig)
4. [Mining](#Mining)
3. [Help](#Help)
1. [Startup](#Startup)
1. [Using bootstrap.dat](#BootstrapDat)
2. [Network Configuration](#NetworkConfig)
3. [Wallet](#Wallet)
4. [Contact](#Contact)
1. [IRC](#ContactIRC)
2. [Mailing Lists](#MailingLists)
5. [Developer Resources](#DeveloperResources)
1. [Code Contribution Guidelines](#ContributionGuidelines)
2. [JSON-RPC Reference](#JSONRPCReference)
Relicense to the btcsuite developers. This commit relicenses all code in this repository to the btcsuite developers.
2015-05-01 08:28:01 +02:00
3. [The btcsuite Bitcoin-related Go Packages](#GoPackages)
Add Dockerfile to build and run btcd on Docker.
2019-09-05 15:37:43 +02:00
6. [Using Docker](#Docker)
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
<a name="About" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
### 1. About
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
btcd is a full node bitcoin implementation written in [Go](http://golang.org),
licensed under the [copyfree](http://www.copyfree.org) ISC License.
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
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.
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
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 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.
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
It also properly relays newly mined blocks, maintains a transaction pool, and
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
relays individual transactions that have not yet made it into a block. It
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
ensures all individual transactions admitted to the pool follow the rules
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
required by the block chain and also includes more strict checks which filter
transactions based on miner requirements ("standard" transactions).
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
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
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
Update README.md Use internet archive for old conformal blog entry link.
2018-04-16 06:38:35 +02:00
blog entry [here](https://web.archive.org/web/20171125143919/https://blog.conformal.com/btcd-not-your-moms-bitcoin-daemon)
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
for more details. This means you can't actually make or receive payments
directly with btcd. That functionality is provided by the
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
[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.
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
<a name="GettingStarted" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
### 2. Getting Started
<a name="Installation" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.1 Installation**
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 first step is to install btcd. See one of the following sections for
details on how to install on the supported operating systems.
<a name="WindowsInstallation" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
**2.1.1 Windows Installation**<br />
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* Install the MSI available at: https://github.com/btcsuite/btcd/releases
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
* Launch btcd from the Start Menu
<a name="PosixInstallation" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.1.2 Linux/BSD/MacOSX/POSIX Installation**
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
Update installation instructions using Glide (#698) The main README.md file had newer installation that uses Glide, while these did not.
2016-05-22 00:30:26 +02:00
- Install Go according to the installation instructions here:
http://golang.org/doc/install
- 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
`~/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:
```bash
multi: correct all import paths
2018-05-15 05:44:11 +02:00
$ git clone https://github.com/btcsuite/btcd $GOPATH/src/github.com/btcsuite/btcd
$ cd $GOPATH/src/github.com/btcsuite/btcd
docs: use go modules instead of glide Fixes https://github.com/btcsuite/btcd/issues/1379
2019-03-15 21:16:42 +01:00
$ GO111MODULE=on go install -v . ./cmd/...
Update installation instructions using Glide (#698) The main README.md file had newer installation that uses Glide, while these did not.
2016-05-22 00:30:26 +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.
**Updating**
- Run the following commands to update btcd, all dependencies, and install it:
```bash
multi: correct all import paths
2018-05-15 05:44:11 +02:00
$ cd $GOPATH/src/github.com/btcsuite/btcd
docs: use go modules instead of glide Fixes https://github.com/btcsuite/btcd/issues/1379
2019-03-15 21:16:42 +01:00
$ git pull && GO111MODULE=on go install -v . ./cmd/...
Update installation instructions using Glide (#698) The main README.md file had newer installation that uses Glide, while these did not.
2016-05-22 00:30:26 +02:00
```
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
add installation instructions for Gentoo
2015-11-08 21:55:08 +01:00
<a name="GentooInstallation" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.1.2.1 Gentoo Linux Installation**
add installation instructions for Gentoo
2015-11-08 21:55:08 +01:00
* Install Layman and enable the Bitcoin overlay.
* https://gitlab.com/bitcoin/gentoo
* Copy or symlink `/var/lib/layman/bitcoin/Documentation/package.keywords/btcd-live` to `/etc/portage/package.keywords/`
* Install btcd: `$ emerge net-p2p/btcd`
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
<a name="Configuration" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.2 Configuration**
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
multi: correct all import paths
2018-05-15 05:44:11 +02:00
btcd has a number of [configuration](http://godoc.org/github.com/btcsuite/btcd)
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
options, which can be viewed by running: `$ btcd --help`.
<a name="BtcctlConfig" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.3 Controlling and Querying btcd via btcctl**
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
btcctl is a command line utility that can be used to both control and query btcd
via [RPC](http://www.wikipedia.org/wiki/Remote_procedure_call). btcd does
**not** enable its RPC server by default; You must configure at minimum both an
Create limited RPC user. The limited user is specified with the --rpclimituser and --rpclimitpass options (or the equivalent in the config file). The config struct and loadConfig() are updated to take the new options into account. The limited user can have neither the same username nor the same password as the admin user. The package-level rpcLimit map in rpcserver.go specifies the RPC commands accessible by limited users. This map includes both HTTP/S and websocket commands. The checkAuth function gets a new return parameter to signify whether the user is authorized to change server state. The result is passed to the jsonRPCRead function and to the WebsocketHandler function in rpcwebsocket.go. The wsClient struct is updated with an "isAdmin" field signifying that the client is authorized to change server state, written by WebsocketHandler and handleMessage. The handleMessage function also checks the field to allow or disallow an RPC call. The following documentation files are updated: - doc.go - sample-btcd.conf - docs/README.md - docs/json_rpc_api.md - docs/configure_rpc_server_listen_interfaces.md
2015-03-30 19:45:31 +02:00
RPC username and password or both an RPC limited username and password:
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
* btcd.conf configuration file
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
Create limited RPC user. The limited user is specified with the --rpclimituser and --rpclimitpass options (or the equivalent in the config file). The config struct and loadConfig() are updated to take the new options into account. The limited user can have neither the same username nor the same password as the admin user. The package-level rpcLimit map in rpcserver.go specifies the RPC commands accessible by limited users. This map includes both HTTP/S and websocket commands. The checkAuth function gets a new return parameter to signify whether the user is authorized to change server state. The result is passed to the jsonRPCRead function and to the WebsocketHandler function in rpcwebsocket.go. The wsClient struct is updated with an "isAdmin" field signifying that the client is authorized to change server state, written by WebsocketHandler and handleMessage. The handleMessage function also checks the field to allow or disallow an RPC call. The following documentation files are updated: - doc.go - sample-btcd.conf - docs/README.md - docs/json_rpc_api.md - docs/configure_rpc_server_listen_interfaces.md
2015-03-30 19:45:31 +02:00
rpclimituser=mylimituser
rpclimitpass=Limitedp4ssw0rd
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
```
* btcctl.conf configuration file
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
```
Create limited RPC user. The limited user is specified with the --rpclimituser and --rpclimitpass options (or the equivalent in the config file). The config struct and loadConfig() are updated to take the new options into account. The limited user can have neither the same username nor the same password as the admin user. The package-level rpcLimit map in rpcserver.go specifies the RPC commands accessible by limited users. This map includes both HTTP/S and websocket commands. The checkAuth function gets a new return parameter to signify whether the user is authorized to change server state. The result is passed to the jsonRPCRead function and to the WebsocketHandler function in rpcwebsocket.go. The wsClient struct is updated with an "isAdmin" field signifying that the client is authorized to change server state, written by WebsocketHandler and handleMessage. The handleMessage function also checks the field to allow or disallow an RPC call. The following documentation files are updated: - doc.go - sample-btcd.conf - docs/README.md - docs/json_rpc_api.md - docs/configure_rpc_server_listen_interfaces.md
2015-03-30 19:45:31 +02:00
OR
```
[Application Options]
Fix documentation example
2015-05-06 18:46:04 +02:00
rpclimituser=mylimituser
rpclimitpass=Limitedp4ssw0rd
Create limited RPC user. The limited user is specified with the --rpclimituser and --rpclimitpass options (or the equivalent in the config file). The config struct and loadConfig() are updated to take the new options into account. The limited user can have neither the same username nor the same password as the admin user. The package-level rpcLimit map in rpcserver.go specifies the RPC commands accessible by limited users. This map includes both HTTP/S and websocket commands. The checkAuth function gets a new return parameter to signify whether the user is authorized to change server state. The result is passed to the jsonRPCRead function and to the WebsocketHandler function in rpcwebsocket.go. The wsClient struct is updated with an "isAdmin" field signifying that the client is authorized to change server state, written by WebsocketHandler and handleMessage. The handleMessage function also checks the field to allow or disallow an RPC call. The following documentation files are updated: - doc.go - sample-btcd.conf - docs/README.md - docs/json_rpc_api.md - docs/configure_rpc_server_listen_interfaces.md
2015-03-30 19:45:31 +02:00
```
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
For a list of available options, run: `$ btcctl --help`
<a name="Mining" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2.4 Mining**
btcd supports the `getblocktemplate` RPC.
The limited user cannot access this RPC.
**1. Add the payment addresses with the `miningaddr` option.**
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
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
miningaddr=12c6DSiU4Rq3P4ZxziKxzrL5LmMBrzjrJX
miningaddr=1M83ju3EChKYyysmM2FXtLNftbacagd8FR
```
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**2. Add btcd's RPC TLS certificate to system Certificate Authority list.**
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
`cgminer` uses [curl](http://curl.haxx.se/) to fetch data from the RPC server.
Since curl validates the certificate by default, we must install the `btcd` RPC
certificate into the default system Certificate Authority list.
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**Ubuntu**
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
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
1. Copy rpc.cert to /usr/share/ca-certificates: `# cp /home/user/.btcd/rpc.cert /usr/share/ca-certificates/btcd.crt`
2. Add btcd.crt to /etc/ca-certificates.conf: `# echo btcd.crt >> /etc/ca-certificates.conf`
3. Update the CA certificate list: `# update-ca-certificates`
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
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**3. Set your mining software url to use https.**
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
`$ cgminer -o https://127.0.0.1:8334 -u rpcuser -p rpcpassword`
<a name="Help" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
### 3. Help
<a name="Startup" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**3.1 Startup**
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
Typically btcd will run and start downloading the block chain with no extra
configuration necessary, however, there is an optional method to use a
`bootstrap.dat` file that may speed up the initial block chain download process.
<a name="BootstrapDat" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**3.1.1 bootstrap.dat**
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [Using bootstrap.dat](https://github.com/btcsuite/btcd/tree/master/docs/using_bootstrap_dat.md)
multi: Update markdown files for GFM changes. The github markdown interpreter has been changed such that it no longer allows spaces in between the brackets and parenthesis of links and now requires a newline in between anchors and other formatting. This updates all of the markdown files accordingly. While here, it also corrects a couple of inconsistencies in some of the README.md files.
2017-05-25 18:29:23 +02:00
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
<a name="NetworkConfig" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**3.1.2 Network Configuration**
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [What Ports Are Used by Default?](https://github.com/btcsuite/btcd/tree/master/docs/default_ports.md)
* [How To Listen on Specific Interfaces](https://github.com/btcsuite/btcd/tree/master/docs/configure_peer_server_listen_interfaces.md)
* [How To Configure RPC Server to Listen on Specific Interfaces](https://github.com/btcsuite/btcd/tree/master/docs/configure_rpc_server_listen_interfaces.md)
* [Configuring btcd with Tor](https://github.com/btcsuite/btcd/tree/master/docs/configuring_tor.md)
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
<a name="Wallet" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**3.1 Wallet**
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
btcd was intentionally developed without an integrated wallet for security
reasons. Please see [btcwallet](https://github.com/btcsuite/btcwallet) for more
information.
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
<a name="Contact" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
### 4. Contact
<a name="ContactIRC" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**4.1 IRC**
* [irc.freenode.net](irc://irc.freenode.net), channel `#btcd`
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
<a name="MailingLists" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
**4.2 Mailing Lists**
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
* <a href="mailto:btcd+subscribe@opensource.conformal.com">btcd</a>: discussion
of btcd and its packages.
* <a href="mailto:btcd-commits+subscribe@opensource.conformal.com">btcd-commits</a>:
readonly mail-out of source code changes.
<a name="DeveloperResources" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
### 5. Developer Resources
<a name="ContributionGuidelines" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [Code Contribution Guidelines](https://github.com/btcsuite/btcd/tree/master/docs/code_contribution_guidelines.md)
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
<a name="JSONRPCReference" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [JSON-RPC Reference](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md)
* [RPC Examples](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md#ExampleCode)
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
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
<a name="GoPackages" />
Fix docs/README.md Invalid tokens: github had made some changes the past months, the old style is not rendering at all, so I fixed that for you. Other contributors can do the same for all of the project's documents. Thanks.
2017-05-03 20:59:47 +02:00
Relicense to the btcsuite developers. This commit relicenses all code in this repository to the btcsuite developers.
2015-05-01 08:28:01 +02:00
* The btcsuite Bitcoin-related Go Packages:
Fix sub packages links
2018-02-04 15:55:31 +01:00
* [btcrpcclient](https://github.com/btcsuite/btcd/tree/master/rpcclient) - Implements a
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
robust and easy to use Websocket-enabled Bitcoin JSON-RPC client
Fix sub packages links
2018-02-04 15:55:31 +01:00
* [btcjson](https://github.com/btcsuite/btcd/tree/master/btcjson) - Provides an extensive API
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
for the underlying JSON-RPC command and return values
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [wire](https://github.com/btcsuite/btcd/tree/master/wire) - Implements the
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Bitcoin wire protocol
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [peer](https://github.com/btcsuite/btcd/tree/master/peer) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Provides a common base for creating and managing Bitcoin network peers.
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [blockchain](https://github.com/btcsuite/btcd/tree/master/blockchain) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Implements Bitcoin block handling and chain selection rules
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [blockchain/fullblocktests](https://github.com/btcsuite/btcd/tree/master/blockchain/fullblocktests) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Provides a set of block tests for testing the consensus validation rules
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [txscript](https://github.com/btcsuite/btcd/tree/master/txscript) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Implements the Bitcoin transaction scripting language
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [btcec](https://github.com/btcsuite/btcd/tree/master/btcec) - Implements
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
support for the elliptic curve cryptographic functions needed for the
Bitcoin scripts
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [database](https://github.com/btcsuite/btcd/tree/master/database) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Provides a database interface for the Bitcoin block chain
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [mempool](https://github.com/btcsuite/btcd/tree/master/mempool) -
docs: Add mempool entry to developer tools section.
2016-10-24 02:38:52 +02:00
Package mempool provides a policy-enforced pool of unmined bitcoin
transactions.
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [btcutil](https://github.com/btcsuite/btcutil) - Provides Bitcoin-specific
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
convenience functions and types
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [chainhash](https://github.com/btcsuite/btcd/tree/master/chaincfg/chainhash) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Provides a generic hash type and associated functions that allows the
specific hash algorithm to be abstracted.
multi: correct all import paths
2018-05-15 05:44:11 +02:00
* [connmgr](https://github.com/btcsuite/btcd/tree/master/connmgr) -
docs: Add fullblocktests entry and make consistent.
2016-10-21 02:37:14 +02:00
Package connmgr implements a generic Bitcoin network connection manager.
Add Dockerfile to build and run btcd on Docker.
2019-09-05 15:37:43 +02:00
<a name="Docker" />
### 6. Using Docker
You can run btcd in a Docker container, without the need to compile the source by yourself. Visit the [Using Docker](https://github.com/btcsuite/btcd/tree/master/docs/using_docker.md) page for more inrormation and examples.
* [Using Docker](https://github.com/btcsuite/btcd/tree/master/docs/using_docker.md) details page
Reference in a new issue Copy permalink