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

multi: Update markdown files for GFM changes.

Browse source 
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.
This commit is contained in:
Dave Collins 2017-05-25 11:29:23 -05:00
parent f8673776ab
commit 9918e2a561
No known key found for this signature in database
GPG key ID: B8904D9D9C93D1F2
25 changed files with 143 additions and 163 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -1,8 +1,9 @@
btcd btcd
==== ====
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd)
btcd is an alternative full node bitcoin implementation written in Go (golang). btcd is an alternative full node bitcoin implementation written in Go (golang).

17
blockchain/README.md
View file

@ -1,11 +1,9 @@
blockchain blockchain
========== ==========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/blockchain)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/blockchain)
Package blockchain implements bitcoin block handling and chain selection rules. Package blockchain implements bitcoin block handling and chain selection rules.
The test coverage is currently only around 60%, but will be increasing over The test coverage is currently only around 60%, but will be increasing over
@ -63,21 +61,18 @@ is by no means exhaustive:
## Examples ## Examples
* [ProcessBlock Example] * [ProcessBlock Example](http://godoc.org/github.com/btcsuite/btcd/blockchain#example-BlockChain-ProcessBlock)
(http://godoc.org/github.com/btcsuite/btcd/blockchain#example-BlockChain-ProcessBlock)
Demonstrates how to create a new chain instance and use ProcessBlock to Demonstrates how to create a new chain instance and use ProcessBlock to
attempt to attempt add a block to the chain. This example intentionally attempt to attempt add a block to the chain. This example intentionally
attempts to insert a duplicate genesis block to illustrate how an invalid attempts to insert a duplicate genesis block to illustrate how an invalid
block is handled. block is handled.
* [CompactToBig Example] * [CompactToBig Example](http://godoc.org/github.com/btcsuite/btcd/blockchain#example-CompactToBig)
(http://godoc.org/github.com/btcsuite/btcd/blockchain#example-CompactToBig)
Demonstrates how to convert the compact "bits" in a block header which Demonstrates how to convert the compact "bits" in a block header which
represent the target difficulty to a big integer and display it using the represent the target difficulty to a big integer and display it using the
typical hex notation. typical hex notation.
* [BigToCompact Example] * [BigToCompact Example](http://godoc.org/github.com/btcsuite/btcd/blockchain#example-BigToCompact)
(http://godoc.org/github.com/btcsuite/btcd/blockchain#example-BigToCompact)
Demonstrates how to convert how to convert a target difficulty into the Demonstrates how to convert how to convert a target difficulty into the
compact "bits" in a block header which represent that target difficulty. compact "bits" in a block header which represent that target difficulty.

8
blockchain/fullblocktests/README.md
View file

@ -1,11 +1,9 @@
fullblocktests fullblocktests
============== ==============
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/blockchain/fullblocktests)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/blockchain/fullblocktests)
Package fullblocktests provides a set of full block tests to be used for testing Package fullblocktests provides a set of full block tests to be used for testing
the consensus validation rules. The tests are intended to be flexible enough to the consensus validation rules. The tests are intended to be flexible enough to

18
blockchain/indexers/README.md
View file

@ -1,8 +1,9 @@
indexers indexers
======== ========
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/blockchain/indexers?status.png)](http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers)
Package indexers implements optional block chain indexes. Package indexers implements optional block chain indexes.
@ -19,19 +20,6 @@ via an RPC interface.
or debit the address or debit the address
- Requires the transaction-by-hash index - Requires the transaction-by-hash index
## Documentation
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/blockchain/indexers?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/blockchain/indexers
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/blockchain/indexers
## Installation ## Installation
```bash ```bash

20
btcec/README.md
View file

@ -1,11 +1,9 @@
btcec btcec
===== =====
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcec)
(https://travis-ci.org/btcsuite/btcec) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://godoc.org/github.com/btcsuite/btcd/btcec?status.png)](http://godoc.org/github.com/btcsuite/btcd/btcec)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/btcec?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/btcec)
Package btcec implements elliptic curve cryptography needed for working with Package btcec implements elliptic curve cryptography needed for working with
Bitcoin (secp256k1 only for now). It is designed so that it may be used with the Bitcoin (secp256k1 only for now). It is designed so that it may be used with the
@ -27,23 +25,19 @@ $ go get -u github.com/btcsuite/btcd/btcec
## Examples ## Examples
* [Sign Message] * [Sign Message](http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--SignMessage)
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--SignMessage)
Demonstrates signing a message with a secp256k1 private key that is first Demonstrates signing a message with a secp256k1 private key that is first
parsed form raw bytes and serializing the generated signature. parsed form raw bytes and serializing the generated signature.
* [Verify Signature] * [Verify Signature](http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--VerifySignature)
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--VerifySignature)
Demonstrates verifying a secp256k1 signature against a public key that is Demonstrates verifying a secp256k1 signature against a public key that is
first parsed from raw bytes. The signature is also parsed from raw bytes. first parsed from raw bytes. The signature is also parsed from raw bytes.
* [Encryption] * [Encryption](http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--EncryptMessage)
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--EncryptMessage)
Demonstrates encrypting a message for a public key that is first parsed from Demonstrates encrypting a message for a public key that is first parsed from
raw bytes, then decrypting it using the corresponding private key. raw bytes, then decrypting it using the corresponding private key.
* [Decryption] * [Decryption](http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--DecryptMessage)
(http://godoc.org/github.com/btcsuite/btcd/btcec#example-package--DecryptMessage)
Demonstrates decrypting a message using a private key that is first parsed Demonstrates decrypting a message using a private key that is first parsed
from raw bytes. from raw bytes.

20
btcjson/README.md
View file

@ -1,11 +1,9 @@
btcjson btcjson
======= =======
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/btcjson)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/btcjson)
Package btcjson implements concrete types for marshalling to and from the Package btcjson implements concrete types for marshalling to and from the
bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure
@ -32,21 +30,17 @@ $ go get -u github.com/btcsuite/btcd/btcjson
## Examples ## Examples
* [Marshal Command] * [Marshal Command](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalCmd)
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalCmd)
Demonstrates how to create and marshal a command into a JSON-RPC request. Demonstrates how to create and marshal a command into a JSON-RPC request.
* [Unmarshal Command] * [Unmarshal Command](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-UnmarshalCmd)
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-UnmarshalCmd)
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the
concrete request into a concrete command. concrete request into a concrete command.
* [Marshal Response] * [Marshal Response](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalResponse)
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-MarshalResponse)
Demonstrates how to marshal a JSON-RPC response. Demonstrates how to marshal a JSON-RPC response.
* [Unmarshal Response] * [Unmarshal Response](http://godoc.org/github.com/btcsuite/btcd/btcjson#example-package--UnmarshalResponse)
(http://godoc.org/github.com/btcsuite/btcd/btcjson#example-package--UnmarshalResponse)
Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the
result field in the response to a concrete type. result field in the response to a concrete type.

8
chaincfg/README.md
View file

@ -1,11 +1,9 @@
chaincfg chaincfg
======== ========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/chaincfg)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/chaincfg)
Package chaincfg defines chain configuration parameters for the three standard Package chaincfg defines chain configuration parameters for the three standard
Bitcoin networks and provides the ability for callers to define their own custom Bitcoin networks and provides the ability for callers to define their own custom

8
chaincfg/chainhash/README.md
View file

@ -1,11 +1,9 @@
chainhash chainhash
========= =========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/chaincfg/chainhash)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/chaincfg/chainhash)
chainhash provides a generic hash type and associated functions that allows the chainhash provides a generic hash type and associated functions that allows the
specific hash algorithm to be abstracted. specific hash algorithm to be abstracted.

8
connmgr/README.md
View file

@ -1,11 +1,9 @@
connmgr connmgr
======= =======
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/connmgr)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/connmgr)
Package connmgr implements a generic Bitcoin network connection manager. Package connmgr implements a generic Bitcoin network connection manager.

17
database/README.md
View file

@ -1,11 +1,9 @@
database database
======== ========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/database)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/database)
Package database provides a block and metadata storage database. Package database provides a block and metadata storage database.
@ -16,8 +14,7 @@ and that entity will be btcd.
When a client wants programmatic access to the data provided by btcd, they'll When a client wants programmatic access to the data provided by btcd, they'll
likely want to use the [btcrpcclient](https://github.com/btcsuite/btcrpcclient) likely want to use the [btcrpcclient](https://github.com/btcsuite/btcrpcclient)
package which makes use of the [JSON-RPC API] package which makes use of the [JSON-RPC API](https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).
(https://github.com/btcsuite/btcd/tree/master/docs/json_rpc_api.md).
However, this package could be extremely useful for any applications requiring However, this package could be extremely useful for any applications requiring
Bitcoin block storage capabilities. Bitcoin block storage capabilities.
@ -45,13 +42,11 @@ $ go get -u github.com/btcsuite/btcd/database
## Examples ## Examples
* [Basic Usage Example] * [Basic Usage Example](http://godoc.org/github.com/btcsuite/btcd/database#example-package--BasicUsage)
(http://godoc.org/github.com/btcsuite/btcd/database#example-package--BasicUsage)
Demonstrates creating a new database and using a managed read-write Demonstrates creating a new database and using a managed read-write
transaction to store and retrieve metadata. transaction to store and retrieve metadata.
* [Block Storage and Retrieval Example] * [Block Storage and Retrieval Example](http://godoc.org/github.com/btcsuite/btcd/database#example-package--BlockStorageAndRetrieval)
(http://godoc.org/github.com/btcsuite/btcd/database#example-package--BlockStorageAndRetrieval)
Demonstrates creating a new database, using a managed read-write transaction Demonstrates creating a new database, using a managed read-write transaction
to store a block, and then using a managed read-only transaction to fetch the to store a block, and then using a managed read-only transaction to fetch the
block. block.

18
database/ffldb/README.md
View file

@ -1,8 +1,9 @@
ffldb ffldb
===== =====
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/database/ffldb?status.png)](http://godoc.org/github.com/btcsuite/btcd/database/ffldb)
Package ffldb implements a driver for the database package that uses leveldb for Package ffldb implements a driver for the database package that uses leveldb for
the backing metadata and flat files for block storage. the backing metadata and flat files for block storage.
@ -33,19 +34,6 @@ if err != nil {
} }
``` ```
## Documentation
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/database/ffldb?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/database/ffldb)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/database/ffldb
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/database/ffldb
## License ## License
Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC

18
database/internal/treap/README.md
View file

@ -1,8 +1,9 @@
treap treap
===== =====
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/database/internal/treap?status.png)](http://godoc.org/github.com/btcsuite/btcd/database/internal/treap)
Package treap implements a treap data structure that is used to hold ordered Package treap implements a treap data structure that is used to hold ordered
key/value pairs using a combination of binary search tree and heap semantics. key/value pairs using a combination of binary search tree and heap semantics.
@ -32,19 +33,6 @@ Package treap is licensed under the copyfree ISC license.
This package is only used internally in the database code and as such is not This package is only used internally in the database code and as such is not
available for use outside of it. available for use outside of it.
## Documentation
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/database/internal/treap?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/database/internal/treap)
Full `go doc` style documentation for the project can be viewed online without
installing this package by using the GoDoc site here:
http://godoc.org/github.com/btcsuite/btcd/database/internal/treap
You can also view the documentation locally once the package is installed with
the `godoc` tool by running `godoc -http=":6060"` and pointing your browser to
http://localhost:6060/pkg/github.com/btcsuite/btcd/database/internal/treap
## License ## License
Package treap is licensed under the [copyfree](http://copyfree.org) ISC Package treap is licensed under the [copyfree](http://copyfree.org) ISC

1
docs/README.md
View file

@ -214,6 +214,7 @@ configuration necessary, however, there is an optional method to use a
**3.1.1 bootstrap.dat** **3.1.1 bootstrap.dat**
* [Using bootstrap.dat](https://github.com/btcsuite/btcd/tree/master/docs/using_bootstrap_dat.md) * [Using bootstrap.dat](https://github.com/btcsuite/btcd/tree/master/docs/using_bootstrap_dat.md)
<a name="NetworkConfig" /> <a name="NetworkConfig" />
**3.1.2 Network Configuration** **3.1.2 Network Configuration**

17
docs/code_contribution_guidelines.md
View file

@ -16,6 +16,7 @@
6.2. [Licensing of Contributions](#Licensing)<br /> 6.2. [Licensing of Contributions](#Licensing)<br />
<a name="Overview" /> <a name="Overview" />
### 1. Overview ### 1. Overview
Developing cryptocurrencies is an exciting endeavor that touches a wide variety Developing cryptocurrencies is an exciting endeavor that touches a wide variety
@ -38,6 +39,7 @@ We highly encourage code contributions, however it is imperative that you adhere
to the guidelines established on this page. to the guidelines established on this page.
<a name="MinSkillset" /> <a name="MinSkillset" />
### 2. Minimum Recommended Skillset ### 2. Minimum Recommended Skillset
The following list is a set of core competencies that we recommend you possess The following list is a set of core competencies that we recommend you possess
@ -63,6 +65,7 @@ understanding of the various aspects involved with cryptography such as the
security and performance implications. security and performance implications.
<a name="ReqReading" /> <a name="ReqReading" />
### 3. Required Reading ### 3. Required Reading
- [Effective Go](http://golang.org/doc/effective_go.html) - The entire btcd - [Effective Go](http://golang.org/doc/effective_go.html) - The entire btcd
@ -72,6 +75,7 @@ security and performance implications.
foundation to build on will make the code much more comprehensible. foundation to build on will make the code much more comprehensible.
<a name="DevelopmentPractices" /> <a name="DevelopmentPractices" />
### 4. Development Practices ### 4. Development Practices
Developers are expected to work in their own trees and submit pull requests when Developers are expected to work in their own trees and submit pull requests when
@ -79,6 +83,7 @@ they feel their feature or bug fix is ready for integration into the master
branch. branch.
<a name="ShareEarly" /> <a name="ShareEarly" />
### 4.1 Share Early, Share Often ### 4.1 Share Early, Share Often
We firmly believe in the share early, share often approach. The basic premise We firmly believe in the share early, share often approach. The basic premise
@ -101,6 +106,7 @@ This approach has several benefits:
spend rebasing and otherwise trying to keep up with the main code base spend rebasing and otherwise trying to keep up with the main code base
<a name="Testing" /> <a name="Testing" />
### 4.2 Testing ### 4.2 Testing
One of the major design goals of all core btcd packages is to aim for complete One of the major design goals of all core btcd packages is to aim for complete
@ -127,6 +133,7 @@ A quick summary of test practices follows:
to both prove it has been resolved and to prevent future regressions to both prove it has been resolved and to prevent future regressions
<a name="CodeDocumentation" /> <a name="CodeDocumentation" />
### 4.3 Code Documentation and Commenting ### 4.3 Code Documentation and Commenting
- At a minimum every function must be commented with its intended purpose and - At a minimum every function must be commented with its intended purpose and
@ -196,6 +203,7 @@ but it was left as a magic number to show how much of a difference a good
comment can make. comment can make.
<a name="ModelGitCommitMessages" /> <a name="ModelGitCommitMessages" />
### 4.4 Model Git Commit Messages ### 4.4 Model Git Commit Messages
This project prefers to keep a clean commit history with well-formed commit This project prefers to keep a clean commit history with well-formed commit
@ -248,12 +256,14 @@ a good thing.
reply indicators without overflow in an 80 column terminal. reply indicators without overflow in an 80 column terminal.
<a name="CodeApproval" /> <a name="CodeApproval" />
### 5. Code Approval Process ### 5. Code Approval Process
This section describes the code approval process that is used for code This section describes the code approval process that is used for code
contributions. This is how to get your changes into btcd. contributions. This is how to get your changes into btcd.
<a name="CodeReview" /> <a name="CodeReview" />
### 5.1 Code Review ### 5.1 Code Review
All code which is submitted will need to be reviewed before inclusion into the All code which is submitted will need to be reviewed before inclusion into the
@ -289,6 +299,7 @@ checks which are generally performed as follows:
consensus consensus
<a name="CodeRework" /> <a name="CodeRework" />
### 5.2 Rework Code (if needed) ### 5.2 Rework Code (if needed)
After the code review, the change will be accepted immediately if no issues are After the code review, the change will be accepted immediately if no issues are
@ -301,6 +312,7 @@ make the necessary changes.
This process will continue until the code is finally accepted. This process will continue until the code is finally accepted.
<a name="CodeAcceptance" /> <a name="CodeAcceptance" />
### 5.3 Acceptance ### 5.3 Acceptance
Once your code is accepted, it will be integrated with the master branch. Once your code is accepted, it will be integrated with the master branch.
@ -312,9 +324,11 @@ the master branch and the pull request will be closed.
Rejoice as you will now be listed as a [contributor](https://github.com/btcsuite/btcd/graphs/contributors)! Rejoice as you will now be listed as a [contributor](https://github.com/btcsuite/btcd/graphs/contributors)!
<a name="Standards" /> <a name="Standards" />
### 6. Contribution Standards ### 6. Contribution Standards
<a name="Checklist" /> <a name="Checklist" />
### 6.1. Contribution Checklist ### 6.1. Contribution Checklist
- [&nbsp;&nbsp;] All changes are Go version 1.3 compliant - [&nbsp;&nbsp;] All changes are Go version 1.3 compliant
@ -333,8 +347,9 @@ Rejoice as you will now be listed as a [contributor](https://github.com/btcsuite
report any **new** issues that did not already exist report any **new** issues that did not already exist
<a name="Licensing" /> <a name="Licensing" />
### 6.2. Licensing of Contributions ### 6.2. Licensing of Contributions
****
All contributions must be licensed with the All contributions must be licensed with the
[ISC license](https://github.com/btcsuite/btcd/blob/master/LICENSE). This is [ISC license](https://github.com/btcsuite/btcd/blob/master/LICENSE). This is
the same license as all of the code in the btcd suite. the same license as all of the code in the btcd suite.

17
docs/configuring_tor.md
View file

@ -18,6 +18,7 @@
5.3 [Config File Example](#TorStreamIsolationFileExample)<br /> 5.3 [Config File Example](#TorStreamIsolationFileExample)<br />
<a name="Overview" /> <a name="Overview" />
### 1. Overview ### 1. Overview
btcd provides full support for anonymous networking via the btcd provides full support for anonymous networking via the
@ -34,9 +35,11 @@ you are connecting to them. We recommend you take the time to setup a Tor
hidden service for this reason. hidden service for this reason.
<a name="Client" /> <a name="Client" />
### 2. Client-Only ### 2. Client-Only
<a name="ClientDescription" /> <a name="ClientDescription" />
**2.1 Description**<br /> **2.1 Description**<br />
Configuring btcd as a Tor client is straightforward. The first step is Configuring btcd as a Tor client is straightforward. The first step is
@ -56,6 +59,7 @@ not be reachable for inbound connections unless you also configure a Tor
[hidden service](#HiddenService). [hidden service](#HiddenService).
<a name="ClientCLIExample" /> <a name="ClientCLIExample" />
**2.2 Command Line Example**<br /> **2.2 Command Line Example**<br />
```bash ```bash
@ -63,6 +67,7 @@ $ ./btcd --proxy=127.0.0.1:9050
``` ```
<a name="ClientConfigFileExample" /> <a name="ClientConfigFileExample" />
**2.3 Config File Example**<br /> **2.3 Config File Example**<br />
```text ```text
@ -72,9 +77,11 @@ proxy=127.0.0.1:9050
``` ```
<a name="HiddenService" /> <a name="HiddenService" />
### 3. Client-Server via Tor Hidden Service ### 3. Client-Server via Tor Hidden Service
<a name="HiddenServiceDescription" /> <a name="HiddenServiceDescription" />
**3.1 Description**<br /> **3.1 Description**<br />
The first step is to configure Tor to provide a hidden service. Documentation The first step is to configure Tor to provide a hidden service. Documentation
@ -103,6 +110,7 @@ three flags:
* `--externalip` to set the .onion address that is advertised to other peers * `--externalip` to set the .onion address that is advertised to other peers
<a name="HiddenServiceCLIExample" /> <a name="HiddenServiceCLIExample" />
**3.2 Command Line Example**<br /> **3.2 Command Line Example**<br />
```bash ```bash
@ -110,6 +118,7 @@ $ ./btcd --proxy=127.0.0.1:9050 --listen=127.0.0.1 --externalip=fooanon.onion
``` ```
<a name="HiddenServiceConfigFileExample" /> <a name="HiddenServiceConfigFileExample" />
**3.3 Config File Example**<br /> **3.3 Config File Example**<br />
```text ```text
@ -121,9 +130,11 @@ externalip=fooanon.onion
``` ```
<a name="Bridge" /> <a name="Bridge" />
### 4. Bridge Mode (Not Anonymous) ### 4. Bridge Mode (Not Anonymous)
<a name="BridgeDescription" /> <a name="BridgeDescription" />
**4.1 Description**<br /> **4.1 Description**<br />
btcd provides support for operating as a bridge between regular nodes and hidden btcd provides support for operating as a bridge between regular nodes and hidden
@ -144,6 +155,7 @@ mode, you only need to specify your hidden service's .onion address via the
routed via Tor due to the `--onion` flag. routed via Tor due to the `--onion` flag.
<a name="BridgeCLIExample" /> <a name="BridgeCLIExample" />
**4.2 Command Line Example**<br /> **4.2 Command Line Example**<br />
```bash ```bash
@ -151,6 +163,7 @@ $ ./btcd --onion=127.0.0.1:9050 --externalip=fooanon.onion
``` ```
<a name="BridgeConfigFileExample" /> <a name="BridgeConfigFileExample" />
**4.3 Config File Example**<br /> **4.3 Config File Example**<br />
```text ```text
@ -161,9 +174,11 @@ externalip=fooanon.onion
``` ```
<a name="TorStreamIsolation" /> <a name="TorStreamIsolation" />
### 5. Tor Stream Isolation ### 5. Tor Stream Isolation
<a name="TorStreamIsolationDescription" /> <a name="TorStreamIsolationDescription" />
**5.1 Description**<br /> **5.1 Description**<br />
Tor stream isolation forces Tor to build a new circuit for each connection Tor stream isolation forces Tor to build a new circuit for each connection
@ -173,6 +188,7 @@ btcd provides support for Tor stream isolation by using the `--torisolation`
flag. This option requires --proxy or --onionproxy to be set. flag. This option requires --proxy or --onionproxy to be set.
<a name="TorStreamIsolationCLIExample" /> <a name="TorStreamIsolationCLIExample" />
**5.2 Command Line Example**<br /> **5.2 Command Line Example**<br />
```bash ```bash
@ -180,6 +196,7 @@ $ ./btcd --proxy=127.0.0.1:9050 --torisolation
``` ```
<a name="TorStreamIsolationFileExample" /> <a name="TorStreamIsolationFileExample" />
**5.3 Config File Example**<br /> **5.3 Config File Example**<br />
```text ```text

27
docs/json_rpc_api.md
View file

@ -23,6 +23,7 @@
9.2. [node.js](#ExampleNodeJsCode)<br /> 9.2. [node.js](#ExampleNodeJsCode)<br />
<a name="Overview" /> <a name="Overview" />
### 1. Overview ### 1. Overview
btcd provides a [JSON-RPC](http://json-rpc.org/wiki/specification) API that is btcd provides a [JSON-RPC](http://json-rpc.org/wiki/specification) API that is
@ -59,6 +60,7 @@ progress, incomplete, and susceptible to changes (both additions and removals).
The original bitcoind/bitcoin-qt JSON-RPC API documentation is available at [https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list) The original bitcoind/bitcoin-qt JSON-RPC API documentation is available at [https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list](https://en.bitcoin.it/wiki/Original_Bitcoin_client/API_Calls_list)
<a name="HttpPostVsWebsockets" /> <a name="HttpPostVsWebsockets" />
### 2. HTTP POST Versus Websockets ### 2. HTTP POST Versus Websockets
The btcd RPC server supports both [HTTP POST](http://en.wikipedia.org/wiki/POST_%28HTTP%29) The btcd RPC server supports both [HTTP POST](http://en.wikipedia.org/wiki/POST_%28HTTP%29)
@ -81,9 +83,11 @@ JSON-RPC API are:
|Scales well with large numbers of requests|No|Yes| |Scales well with large numbers of requests|No|Yes|
<a name="Authentication" /> <a name="Authentication" />
### 3. Authentication ### 3. Authentication
<a name="AuthenticationOverview" /> <a name="AuthenticationOverview" />
**3.1 Authentication Overview**<br /> **3.1 Authentication Overview**<br />
The following authentication details are needed before establishing a connection The following authentication details are needed before establishing a connection
@ -109,6 +113,7 @@ two, mutually exclusive, methods.
- [Use the JSON-RPC "authenticate" command](#JSONAuth) - Websockets only - [Use the JSON-RPC "authenticate" command](#JSONAuth) - Websockets only
<a name="HTTPAuth" /> <a name="HTTPAuth" />
**3.2 HTTP Basic Access Authentication**<br /> **3.2 HTTP Basic Access Authentication**<br />
The btcd RPC server uses HTTP [basic access authentication](http://en.wikipedia.org/wiki/Basic_access_authentication) with the **rpcuser** The btcd RPC server uses HTTP [basic access authentication](http://en.wikipedia.org/wiki/Basic_access_authentication) with the **rpcuser**
@ -116,6 +121,7 @@ and **rpcpass** detailed above. If the supplied credentials are invalid, you
will be disconnected immediately upon making the connection. will be disconnected immediately upon making the connection.
<a name="JSONAuth" /> <a name="JSONAuth" />
**3.3 JSON-RPC Authenticate Command (Websocket-specific)**<br /> **3.3 JSON-RPC Authenticate Command (Websocket-specific)**<br />
While the HTTP basic access authentication method is the preferred method, the While the HTTP basic access authentication method is the preferred method, the
@ -129,6 +135,7 @@ authenticated will cause the websocket to be closed immediately.
<a name="CLIUtil" /> <a name="CLIUtil" />
### 4. Command-line Utility ### 4. Command-line Utility
btcd comes with a separate utility named `btcctl` which can be used to issue btcd comes with a separate utility named `btcctl` which can be used to issue
@ -138,9 +145,11 @@ be used to communicate with any server/daemon/service which provides a JSON-RPC
API compatible with the original bitcoind/bitcoin-qt client. API compatible with the original bitcoind/bitcoin-qt client.
<a name="Methods" /> <a name="Methods" />
### 5. Standard Methods ### 5. Standard Methods
<a name="MethodOverview" /> <a name="MethodOverview" />
**5.1 Method Overview**<br /> **5.1 Method Overview**<br />
The following is an overview of the RPC methods and their current status. Click The following is an overview of the RPC methods and their current status. Click
@ -180,6 +189,7 @@ the method name for further details such as parameter and return information.
|30|[verifychain](#verifychain)|N|Verifies the block chain database.| |30|[verifychain](#verifychain)|N|Verifies the block chain database.|
<a name="MethodDetails" /> <a name="MethodDetails" />
**5.2 Method Details**<br /> **5.2 Method Details**<br />
<a name="addnode"/> <a name="addnode"/>
@ -552,9 +562,11 @@ Example Return|`{`<br />&nbsp;&nbsp;`"bytes": 310768,`<br />&nbsp;&nbsp;`"size":
<a name="ExtensionMethods" /> <a name="ExtensionMethods" />
### 6. Extension Methods ### 6. Extension Methods
<a name="ExtMethodOverview" /> <a name="ExtMethodOverview" />
**6.1 Method Overview**<br /> **6.1 Method Overview**<br />
The following is an overview of the RPC methods which are implemented by btcd, but not the original bitcoind client. Click the method name for further details such as parameter and return information. The following is an overview of the RPC methods which are implemented by btcd, but not the original bitcoind client. Click the method name for further details such as parameter and return information.
@ -572,6 +584,7 @@ The following is an overview of the RPC methods which are implemented by btcd, b
<a name="ExtMethodDetails" /> <a name="ExtMethodDetails" />
**6.2 Method Details**<br /> **6.2 Method Details**<br />
<a name="debuglevel"/> <a name="debuglevel"/>
@ -677,9 +690,11 @@ The following is an overview of the RPC methods which are implemented by btcd, b
*** ***
<a name="WSExtMethods" /> <a name="WSExtMethods" />
### 7. Websocket Extension Methods (Websocket-specific) ### 7. Websocket Extension Methods (Websocket-specific)
<a name="WSExtMethodOverview" /> <a name="WSExtMethodOverview" />
**7.1 Method Overview**<br /> **7.1 Method Overview**<br />
The following is an overview of the RPC method requests available exclusively to Websocket clients. All of these RPC methods are available to the limited The following is an overview of the RPC method requests available exclusively to Websocket clients. All of these RPC methods are available to the limited
@ -702,6 +717,7 @@ user. Click the method name for further details such as parameter and return in
|13|[rescanblocks](#rescanblocks)|Rescan blocks for transactions matching the loaded transaction filter.|None| |13|[rescanblocks](#rescanblocks)|Rescan blocks for transactions matching the loaded transaction filter.|None|
<a name="WSExtMethodDetails" /> <a name="WSExtMethodDetails" />
**7.2 Method Details**<br /> **7.2 Method Details**<br />
<a name="authenticate"/> <a name="authenticate"/>
@ -728,6 +744,7 @@ user. Click the method name for further details such as parameter and return in
[Return to Overview](#WSExtMethodOverview)<br /> [Return to Overview](#WSExtMethodOverview)<br />
*** ***
<a name="stopnotifyblocks"/> <a name="stopnotifyblocks"/>
| | | | | |
@ -872,11 +889,13 @@ user. Click the method name for further details such as parameter and return in
<a name="Notifications" /> <a name="Notifications" />
### 8. Notifications (Websocket-specific) ### 8. Notifications (Websocket-specific)
btcd uses standard JSON-RPC notifications to notify clients of changes, rather than requiring clients to poll btcd for updates. JSON-RPC notifications are a subset of requests, but do not contain an ID. The notification type is categorized by the `method` field and additional details are sent as a JSON array in the `params` field. btcd uses standard JSON-RPC notifications to notify clients of changes, rather than requiring clients to poll btcd for updates. JSON-RPC notifications are a subset of requests, but do not contain an ID. The notification type is categorized by the `method` field and additional details are sent as a JSON array in the `params` field.
<a name="NotificationOverview" /> <a name="NotificationOverview" />
**8.1 Notification Overview**<br /> **8.1 Notification Overview**<br />
The following is an overview of the JSON-RPC notifications used for Websocket connections. Click the method name for further details of the context(s) in which they are sent and their parameters. The following is an overview of the JSON-RPC notifications used for Websocket connections. Click the method name for further details of the context(s) in which they are sent and their parameters.
@ -896,6 +915,7 @@ The following is an overview of the JSON-RPC notifications used for Websocket co
|11|[filteredblockdisconnected](#filteredblockdisconnected)|Block disconnected from the main chain.|[notifyblocks](#notifyblocks), [loadtxfilter](#loadtxfilter)| |11|[filteredblockdisconnected](#filteredblockdisconnected)|Block disconnected from the main chain.|[notifyblocks](#notifyblocks), [loadtxfilter](#loadtxfilter)|
<a name="NotificationDetails" /> <a name="NotificationDetails" />
**8.2 Notification Details**<br /> **8.2 Notification Details**<br />
<a name="blockconnected"/> <a name="blockconnected"/>
@ -1040,6 +1060,7 @@ The following is an overview of the JSON-RPC notifications used for Websocket co
<a name="ExampleCode" /> <a name="ExampleCode" />
### 9. Example Code ### 9. Example Code
This section provides example code for interacting with the JSON-RPC API in This section provides example code for interacting with the JSON-RPC API in
@ -1049,6 +1070,7 @@ various languages.
* [node.js](#ExampleNodeJsCode) * [node.js](#ExampleNodeJsCode)
<a name="ExampleGoApp" /> <a name="ExampleGoApp" />
**9.1 Go** **9.1 Go**
This section provides examples of using the RPC interface using Go and the This section provides examples of using the RPC interface using Go and the
@ -1060,6 +1082,7 @@ This section provides examples of using the RPC interface using Go and the
<a name="ExampleGetBlockCount" /> <a name="ExampleGetBlockCount" />
**9.1.1 Using getblockcount to Retrieve the Current Block Height**<br /> **9.1.1 Using getblockcount to Retrieve the Current Block Height**<br />
The following is an example Go application which uses the The following is an example Go application which uses the
@ -1120,6 +1143,7 @@ Block count: 276978
``` ```
<a name="ExampleGetBlock" /> <a name="ExampleGetBlock" />
**9.1.2 Using getblock to Retrieve the Genesis Block**<br /> **9.1.2 Using getblock to Retrieve the Genesis Block**<br />
The following is an example Go application which uses the The following is an example Go application which uses the
@ -1208,6 +1232,7 @@ Num transactions: 1
``` ```
<a name="ExampleNotifyBlocks" /> <a name="ExampleNotifyBlocks" />
**9.1.3 Using notifyblocks to Receive blockconnected and blockdisconnected **9.1.3 Using notifyblocks to Receive blockconnected and blockdisconnected
Notifications (Websocket-specific)**<br /> Notifications (Websocket-specific)**<br />
@ -1298,9 +1323,11 @@ Example output:
``` ```
<a name="ExampleNodeJsCode" /> <a name="ExampleNodeJsCode" />
### 9.2. Example node.js Code ### 9.2. Example node.js Code
<a name="ExampleNotifyBlocks" /> <a name="ExampleNotifyBlocks" />
**9.2.1 Using notifyblocks to be Notified of Block Connects and Disconnects**<br /> **9.2.1 Using notifyblocks to be Notified of Block Connects and Disconnects**<br />
The following is example node.js code which uses [ws](https://github.com/einaros/ws) The following is example node.js code which uses [ws](https://github.com/einaros/ws)

5
docs/using_bootstrap_dat.md
View file

@ -6,6 +6,7 @@
5. [How do I use bootstrap.dat with btcd?](#Importing) 5. [How do I use bootstrap.dat with btcd?](#Importing)
<a name="What" /> <a name="What" />
### 1. What is bootstrap.dat? ### 1. What is bootstrap.dat?
It is a flat, binary file containing bitcoin blockchain data starting from the It is a flat, binary file containing bitcoin blockchain data starting from the
@ -20,6 +21,7 @@ block chain from other peers through the Bitcoin protocol with no extra
configuration needed. configuration needed.
<a name="ProsCons" /> <a name="ProsCons" />
### 2. What are the pros and cons of using bootstrap.dat? ### 2. What are the pros and cons of using bootstrap.dat?
Pros: Pros:
@ -36,6 +38,7 @@ Cons:
well as the imported database well as the imported database
<a name="Obtaining" /> <a name="Obtaining" />
### 3. Where do I get bootstrap.dat? ### 3. Where do I get bootstrap.dat?
The bootstrap.dat file is made available via a torrent. See The bootstrap.dat file is made available via a torrent. See
@ -43,6 +46,7 @@ The bootstrap.dat file is made available via a torrent. See
for the torrent download details. for the torrent download details.
<a name="Trust" /> <a name="Trust" />
### 4. How do I know I can trust the bootstrap.dat I downloaded? ### 4. How do I know I can trust the bootstrap.dat I downloaded?
You don't need to trust the file as the `addblock` utility verifies every block You don't need to trust the file as the `addblock` utility verifies every block
@ -53,6 +57,7 @@ that not only is it a valid chain, but it is the same chain that everyone else
is using. is using.
<a name="Importing" /> <a name="Importing" />
### 5. How do I use bootstrap.dat with btcd? ### 5. How do I use bootstrap.dat with btcd?
btcd comes with a separate utility named `addblock` which can be used to import btcd comes with a separate utility named `addblock` which can be used to import

5
integration/README.md
View file

@ -1,9 +1,8 @@
integration integration
=========== ===========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
This contains integration tests which make use of the This contains integration tests which make use of the
[rpctest](https://github.com/btcsuite/btcd/tree/master/integration/rpctest) [rpctest](https://github.com/btcsuite/btcd/tree/master/integration/rpctest)

9
integration/rpctest/README.md
View file

@ -1,11 +1,9 @@
rpctest rpctest
======= =======
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/integration/rpctest)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/integration/rpctest)
Package rpctest provides a btcd-specific RPC testing harness crafting and Package rpctest provides a btcd-specific RPC testing harness crafting and
executing integration tests by driving a `btcd` instance via the `RPC` executing integration tests by driving a `btcd` instance via the `RPC`
@ -27,7 +25,6 @@ $ go get -u github.com/btcsuite/btcd/integration/rpctest
## License ## License
Package rpctest is licensed under the [copyfree](http://copyfree.org) ISC Package rpctest is licensed under the [copyfree](http://copyfree.org) ISC
License. License.

8
mempool/README.md
View file

@ -1,11 +1,9 @@
mempool mempool
======= =======
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/mempool)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/mempool)
Package mempool provides a policy-enforced pool of unmined bitcoin transactions. Package mempool provides a policy-enforced pool of unmined bitcoin transactions.

8
mining/README.md
View file

@ -1,11 +1,9 @@
mining mining
====== ======
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/mining)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/mining)
## Overview ## Overview

8
mining/cpuminer/README.md
View file

@ -1,11 +1,9 @@
cpuminer cpuminer
======== ========
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/mining/cpuminer)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/mining/cpuminer)
## Overview ## Overview

11
peer/README.md
View file

@ -1,11 +1,9 @@
peer peer
==== ====
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/peer)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/peer)
Package peer provides a common base for creating and managing bitcoin network Package peer provides a common base for creating and managing bitcoin network
peers. peers.
@ -65,8 +63,7 @@ $ go get -u github.com/btcsuite/btcd/peer
## Examples ## Examples
* [New Outbound Peer Example] * [New Outbound Peer Example](https://godoc.org/github.com/btcsuite/btcd/peer#example-package--NewOutboundPeer)
(https://godoc.org/github.com/btcsuite/btcd/peer#example-package--NewOutboundPeer)
Demonstrates the basic process for initializing and creating an outbound peer. Demonstrates the basic process for initializing and creating an outbound peer.
Peers negotiate by exchanging version and verack messages. For demonstration, Peers negotiate by exchanging version and verack messages. For demonstration,
a simple handler for the version message is attached to the peer. a simple handler for the version message is attached to the peer.

17
txscript/README.md
View file

@ -1,11 +1,9 @@
txscript txscript
======== ========
[![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)] [![Build Status](https://travis-ci.org/btcsuite/btcd.png?branch=master)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://godoc.org/github.com/btcsuite/btcd/txscript?status.png)](http://godoc.org/github.com/btcsuite/btcd/txscript)
[![GoDoc](https://godoc.org/github.com/btcsuite/btcd/txscript?status.png)]
(http://godoc.org/github.com/btcsuite/btcd/txscript)
Package txscript implements the bitcoin transaction script language. There is Package txscript implements the bitcoin transaction script language. There is
a comprehensive test suite. a comprehensive test suite.
@ -28,18 +26,15 @@ $ go get -u github.com/btcsuite/btcd/txscript
## Examples ## Examples
* [Standard Pay-to-pubkey-hash Script] * [Standard Pay-to-pubkey-hash Script](http://godoc.org/github.com/btcsuite/btcd/txscript#example-PayToAddrScript)
(http://godoc.org/github.com/btcsuite/btcd/txscript#example-PayToAddrScript)
Demonstrates creating a script which pays to a bitcoin address. It also Demonstrates creating a script which pays to a bitcoin address. It also
prints the created script hex and uses the DisasmString function to display prints the created script hex and uses the DisasmString function to display
the disassembled script. the disassembled script.
* [Extracting Details from Standard Scripts] * [Extracting Details from Standard Scripts](http://godoc.org/github.com/btcsuite/btcd/txscript#example-ExtractPkScriptAddrs)
(http://godoc.org/github.com/btcsuite/btcd/txscript#example-ExtractPkScriptAddrs)
Demonstrates extracting information from a standard public key script. Demonstrates extracting information from a standard public key script.
* [Manually Signing a Transaction Output] * [Manually Signing a Transaction Output](http://godoc.org/github.com/btcsuite/btcd/txscript#example-SignTxOutput)
(http://godoc.org/github.com/btcsuite/btcd/txscript#example-SignTxOutput)
Demonstrates manually creating and signing a redeem transaction. Demonstrates manually creating and signing a redeem transaction.
## GPG Verification Key ## GPG Verification Key

8
wire/README.md
View file

@ -1,11 +1,9 @@
wire wire
==== ====
[![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)] [![Build Status](http://img.shields.io/travis/btcsuite/btcd.svg)](https://travis-ci.org/btcsuite/btcd)
(https://travis-ci.org/btcsuite/btcd) [![ISC License] [![ISC License](http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org) [![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)](http://godoc.org/github.com/btcsuite/btcd/wire)
[![GoDoc](https://img.shields.io/badge/godoc-reference-blue.svg)]
(http://godoc.org/github.com/btcsuite/btcd/wire)
Package wire implements the bitcoin wire protocol. A comprehensive suite of Package wire implements the bitcoin wire protocol. A comprehensive suite of
tests with 100% test coverage is provided to ensure proper functionality. tests with 100% test coverage is provided to ensure proper functionality.