flip/dcrd
1
0
Fork 0
mirror of https://github.com/FlipsideCrypto/dcrd.git synced 2026-02-06 10:56:47 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
master
dcrd/docs/README.md

238 lines
9.0 KiB
Markdown
Raw Permalink Normal View History

peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### Table of Contents
1. [About](#About)
2. [Getting Started](#GettingStarted)
1. [Installation](#Installation)
2. [Configuration](#Configuration)
3. [Controlling and Querying dcrd via dcrctl](#DcrctlConfig)
4. [Mining](#Mining)
3. [Help](#Help)
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
1. [Network Configuration](#NetworkConfig)
2. [Wallet](#Wallet)
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
4. [Contact](#Contact)
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
1. [Community](#ContactCommunity)
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
5. [Developer Resources](#DeveloperResources)
1. [Code Contribution Guidelines](#ContributionGuidelines)
2. [JSON-RPC Reference](#JSONRPCReference)
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
3. [Go Modules](#GoModules)
4. [Module Hierarchy](#ModuleHierarchy)
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
<a name="About" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### 1. About
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
multi: Use https links where available.
2019-06-18 19:20:06 +00:00
dcrd is a full node Decred implementation written in [Go](https://golang.org),
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
and is licensed under the [copyfree](http://www.copyfree.org) ISC License.
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
This software is currently under active development. It is extremely stable and
has been in production use since February 2016.
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
It also properly relays newly mined blocks, maintains a transaction pool, and
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
relays individual transactions that have not yet made it into a block. It
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
ensures all individual transactions admitted to the pool follow the rules
required into the block chain and also includes the vast majority of the more
strict checks which filter transactions based on miner requirements ("standard"
transactions).
<a name="GettingStarted" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### 2. Getting Started
<a name="Installation" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**2.1 Installation**<br />
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
The first step is to install dcrd. The installation instructions can be found
[here](https://github.com/decred/dcrd/tree/master/README.md#Installation).
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
<a name="Configuration" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**2.2 Configuration**<br />
multi: Use https links where available.
2019-06-18 19:20:06 +00:00
dcrd has a number of [configuration](https://godoc.org/github.com/decred/dcrd)
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
options, which can be viewed by running: `$ dcrd --help`.
<a name="DcrctlConfig" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**2.3 Controlling and Querying dcrd via dcrctl**<br />
dcrctl is a command line utility that can be used to both control and query dcrd
multi: Use https links where available.
2019-06-18 19:20:06 +00:00
via [RPC](https://www.wikipedia.org/wiki/Remote_procedure_call). dcrd does
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**not** enable its RPC server by default; You must configure at minimum both an
RPC username and password or both an RPC limited username and password:
* dcrd.conf configuration file
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
rpclimituser=mylimituser
rpclimitpass=Limitedp4ssw0rd
```
* dcrctl.conf configuration file
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
```
OR
```
[Application Options]
rpclimituser=mylimituser
rpclimitpass=Limitedp4ssw0rd
```
For a list of available options, run: `$ dcrctl --help`
<a name="Mining" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**2.4 Mining**<br />
docs: move json rpc docs to mediawiki.
2019-03-11 10:22:30 +00:00
dcrd supports the [getwork](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.mediawiki#getwork)
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
RPC. The limited user cannot access this RPC.<br />
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
**1. Add the payment addresses with the `miningaddr` option.**<br />
```
[Application Options]
rpcuser=myuser
rpcpass=SomeDecentp4ssw0rd
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
miningaddr=DsExampleAddress1
miningaddr=DsExampleAddress2
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
```
**2. Add dcrd's RPC TLS certificate to system Certificate Authority list.**<br />
multi: Use https links where available.
2019-06-18 19:20:06 +00:00
`cgminer` uses [curl](https://curl.haxx.se/) to fetch data from the RPC server.
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
Since curl validates the certificate by default, we must install the `dcrd` RPC
certificate into the default system Certificate Authority list.
**Ubuntu**<br />
1. Copy rpc.cert to /usr/share/ca-certificates: `# cp /home/user/.dcrd/rpc.cert /usr/share/ca-certificates/dcrd.crt`<br />
2. Add dcrd.crt to /etc/ca-certificates.conf: `# echo dcrd.crt >> /etc/ca-certificates.conf`<br />
3. Update the CA certificate list: `# update-ca-certificates`<br />
**3. Set your mining software url to use https.**<br />
`$ cgminer -o https://127.0.0.1:9109 -u rpcuser -p rpcpassword`
<a name="Help" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### 3. Help
<a name="NetworkConfig" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
**3.1 Network Configuration**<br />
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
* [What Ports Are Used by Default?](https://github.com/decred/dcrd/tree/master/docs/default_ports.md)
* [How To Listen on Specific Interfaces](https://github.com/decred/dcrd/tree/master/docs/configure_peer_server_listen_interfaces.md)
* [How To Configure RPC Server to Listen on Specific Interfaces](https://github.com/decred/dcrd/tree/master/docs/configure_rpc_server_listen_interfaces.md)
* [Configuring dcrd with Tor](https://github.com/decred/dcrd/tree/master/docs/configuring_tor.md)
<a name="Wallet" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
**3.2 Wallet**<br />
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
dcrd was intentionally developed without an integrated wallet for security
reasons. Please see [dcrwallet](https://github.com/decred/dcrwallet) for more
information.
<a name="Contact" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### 4. Contact
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
<a name="ContactCommunity" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
**4.1 Community**<br />
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
If you have any further questions you can find us at:
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Revamp main README.md and update docs. This revamps the main README.md file in an attempt to provide a more user-friendly introduction to the software and why someone would want to run it and also updates the docs/README.md to remove some sections that do not apply to Decred and update some others to reflect reality. It also adds minimum recommended specifications for dcrd to the main README.md and updates the build instruction for module-aware builds and the recent changes the run_test.sh script. Finally, it updates the contact information to point to the decred.org/community page.
2018-09-11 23:26:56 +00:00
https://decred.org/community
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
<a name="DeveloperResources" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
### 5. Developer Resources
<a name="ContributionGuidelines" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
**5.1 Code Contribution Guidelines**
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
* [Code Contribution Guidelines](https://github.com/decred/dcrd/tree/master/docs/code_contribution_guidelines.md)
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
peer: Refactor peer code into its own package. Contains the following upstream commits: - 00bddf7540f8aeff7ddea077cf0ce89bc09ea483 - 250228c32f0d84544ca27e654f6ab5ac6fce0ed8 - f1bd2f8d6e52253335578af322d18af3efea9e6b - cbbe3a8bbe7bcabe7f31883428b619487dfdecdd - aa03d68e1e2be9f53655cd466edf81c64e573085 In addition to the normal required changes for syncing, the following changes have been made in order to facilitate integration of the new package into Decred: - Removed check in PushRejectMsg against protocol version since all peers since the initial version support it - Fixed leaked timer in `syncMiningStateAfterSync` function - Add the Decred-specific OnGetMiningState and OnMiningState handlers to the new peer package - Add handler for the new mining state messages to the 'serverPeer' type and register them - Use the new constant for wire.InitialProtocolVersion in the reject message instead of hard coded number - Remove logic specific to the regression network since Decred does not have it
2016-05-20 04:54:40 +00:00
<a name="JSONRPCReference" />
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 and correct some previous merge conflicts.
2017-07-16 20:08:46 +00:00
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
**5.2 JSON-RPC Reference**
docs: move json rpc docs to mediawiki.
2019-03-11 10:22:30 +00:00
* [JSON-RPC Reference](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.mediawiki)
* [RPC Examples](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.mediawiki#8-example-code)
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
<a name="GoModules" />
**5.3 Go Modules**
The following versioned modules are provided by dcrd repository:
docs: Update for rpcclient v4 module.
2019-07-30 17:55:23 +00:00
* [rpcclient/v4](https://github.com/decred/dcrd/tree/master/rpcclient) - Implements
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
a robust and easy to use Websocket-enabled Decred JSON-RPC client
docs: Update for dcrjson/v3 module.
2019-07-21 05:36:06 +00:00
* [dcrjson/v3](https://github.com/decred/dcrd/tree/master/dcrjson) - Provides
infrastructure for working with Decred JSON-RPC APIs
* [rpc/jsonrpc/types](https://github.com/decred/dcrd/tree/master/rpc/jsonrpc/types) -
Provides concrete types via dcrjson for the chain server JSON-RPC commands,
return values, and notifications
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
* [wire](https://github.com/decred/dcrd/tree/master/wire) - Implements the
Decred wire protocol
docs: Update for peer v2 module.
2019-08-12 03:11:39 +00:00
* [peer/v2](https://github.com/decred/dcrd/tree/master/peer) - Provides a common
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
base for creating and managing Decred network peers
docs: Update for blockchain v2 module.
2019-08-07 17:55:47 +00:00
* [blockchain/v2](https://github.com/decred/dcrd/tree/master/blockchain) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Implements Decred block handling and chain selection rules
docs: Update for blockchain/stake v2 module.
2019-07-26 18:18:56 +00:00
* [stake/v2](https://github.com/decred/dcrd/tree/master/blockchain/stake) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Provides an API for working with stake transactions and other portions
related to the Proof-of-Stake (PoS) system
blockchain/standalone: Prepare v1.0.0. This updates the documentation for the new blockchain/standalone module along with main module dependencies to ensure it is tested as well as uses the latest version of the code as the new module is integrated. It also serves as a base for blockchain/stake/v1.0.0. The new modules has the following direct dependencies: - github.com/decred/dcrd/chaincfg/chainhash@v1.0.1 - github.com/decred/dcrd/wire@v1.2.0
2019-08-07 04:24:31 +00:00
* [standalone](https://github.com/decred/dcrd/tree/master/blockchain/standalone) -
Provides standalone functions useful for working with the Decred blockchain
consensus rules
docs: Update for txscript v2 module.
2019-06-19 04:51:28 +00:00
* [txscript/v2](https://github.com/decred/dcrd/tree/master/txscript) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Implements the Decred transaction scripting language
* [dcrec](https://github.com/decred/dcrd/tree/master/dcrec) - Provides constants
for the supported cryptographic signatures supported by Decred scripts
docs: Update for secp256k1 v2 module.
2019-10-08 04:42:22 +00:00
* [secp256k1/v2](https://github.com/decred/dcrd/tree/master/dcrec/secp256k1) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Implements the secp256k1 elliptic curve
docs: Update for dcrec/edwards v2 module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new module version.
2019-06-14 16:32:21 +00:00
* [edwards/v2](https://github.com/decred/dcrd/tree/master/dcrec/edwards) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Implements the edwards25519 twisted Edwards curve
docs: Update for database v2 module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new module version
2019-07-23 00:31:34 +00:00
* [database/v2](https://github.com/decred/dcrd/tree/master/database) -
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Provides a database interface for the Decred block chain
docs: Update for mempool v3 module.
2019-08-12 09:02:01 +00:00
* [mempool/v3](https://github.com/decred/dcrd/tree/master/mempool) - Provides a
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
policy-enforced pool of unmined Decred transactions
docs: Update for dcrutil v2 module.
2019-06-15 04:01:09 +00:00
* [dcrutil/v2](https://github.com/decred/dcrd/tree/master/dcrutil) - Provides
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
Decred-specific convenience functions and types
docs: Update for chaincfg v2 module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new module version
2019-03-15 03:43:33 +00:00
* [chaincfg/v2](https://github.com/decred/dcrd/tree/master/chaincfg) - Defines
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
chain configuration parameters for the standard Decred networks and allows
callers to define their own custom Decred networks for testing puproses
docs: Add fullblocktests entry and minor consistency updates
2017-12-30 17:41:50 +00:00
* [chainhash](https://github.com/decred/dcrd/tree/master/chaincfg/chainhash) -
Provides a generic hash type and associated functions that allows the
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
specific hash algorithm to be abstracted
* [certgen](https://github.com/decred/dcrd/tree/master/certgen) - Provides a
function for creating a new TLS certificate key pair, typically used for
encrypting RPC and websocket communications
* [addrmgr](https://github.com/decred/dcrd/tree/master/addrmgr) - Provides a
concurrency safe Decred network address manager
docs: Update for connmgr v2 module.
2019-08-09 20:26:11 +00:00
* [connmgr/v2](https://github.com/decred/dcrd/tree/master/connmgr) - Implements
a generic Decred network connection manager
docs: Update for hdkeychain v2 module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new module version
2019-03-25 19:10:45 +00:00
* [hdkeychain/v2](https://github.com/decred/dcrd/tree/master/hdkeychain) -
Provides an API for working with Decred hierarchical deterministic extended
keys
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
* [gcs](https://github.com/decred/dcrd/tree/master/gcs) - Provides an API for
building and using Golomb-coded set filters useful for light clients such as
SPV wallets
docs: Update for fees package. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to include the recently added fees package.
2018-12-08 04:57:10 +00:00
* [fees](https://github.com/decred/dcrd/tree/master/fees) - Provides methods for
tracking and estimating fee rates for new transactions to be mined into the
network
docs: Update for lru module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new lru module.
2019-03-18 15:08:29 +00:00
* [lru](https://github.com/decred/dcrd/tree/master/lru) - Implements a generic
concurrent safe least-recently-used cache with near O(1) perf
docs: Update docs for versioned modules. This updates the overall docs README to include all of the new modules as well as introduce a module hierarchy diagram.
2018-08-10 02:21:16 +00:00
<a name="ModuleHierarchy" />
**5.4 Module Hierarchy**
The following diagram shows an overview of the hierarchy for the modules
provided by the dcrd repository.
multi: Use https links where available.
2019-06-18 19:20:06 +00:00
![Module Hierarchy](./assets/module_hierarchy.svg)
Reference in New Issue Copy Permalink