mirror of
https://github.com/FlipsideCrypto/dcrd.git
synced 2026-02-06 10:56:47 +00:00
multi: Update markdown in README files to match change in github parser.
This borrows a lot from btcsuite/btcd 9918e2a56196fb6b1b2837a9e7fb84f3454098fd
This commit is contained in:
John C. Vernaleo
parent
e1f94554ef
commit
e7b128a672
@ -1,9 +1,9 @@
|
||||
dcrd
|
||||
====
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd)
|
||||
|
||||
dcrd is a Decred full node implementation written in Go (golang).
|
||||
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
blockchain
|
||||
==========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/blockchain)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/blockchain)
|
||||
|
||||
Package blockchain implements decred block handling and chain selection rules.
|
||||
The test coverage is currently only around 60%, but will be increasing over
|
||||
@ -63,21 +61,18 @@ is by no means exhaustive:
|
||||
|
||||
## Examples
|
||||
|
||||
* [ProcessBlock Example]
|
||||
(http://godoc.org/github.com/decred/dcrd/blockchain#example-BlockChain-ProcessBlock)
|
||||
* [ProcessBlock Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-BlockChain-ProcessBlock)
|
||||
Demonstrates how to create a new chain instance and use ProcessBlock to
|
||||
attempt to attempt add a block to the chain. This example intentionally
|
||||
attempts to insert a duplicate genesis block to illustrate how an invalid
|
||||
block is handled.
|
||||
|
||||
* [CompactToBig Example]
|
||||
(http://godoc.org/github.com/decred/dcrd/blockchain#example-CompactToBig)
|
||||
* [CompactToBig Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-CompactToBig)
|
||||
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
|
||||
typical hex notation.
|
||||
|
||||
* [BigToCompact Example]
|
||||
(http://godoc.org/github.com/decred/dcrd/blockchain#example-BigToCompact)
|
||||
* [BigToCompact Example](http://godoc.org/github.com/decred/dcrd/blockchain#example-BigToCompact)
|
||||
Demonstrates how to convert how to convert a target difficulty into the
|
||||
compact "bits" in a block header which represent that target difficulty.
|
||||
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
indexers
|
||||
========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/btcsuite/btcd)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/blockchain/indexers)
|
||||
|
||||
Package indexers implements optional block chain indexes.
|
||||
|
||||
@ -23,19 +24,6 @@ via an RPC interface.
|
||||
and was seen by the client
|
||||
- Requires the transaction-by-hash index
|
||||
|
||||
## Documentation
|
||||
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/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/decred/dcrd/blockchain/indexers
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
chaincfg
|
||||
========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/chaincfg)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/chaincfg)
|
||||
|
||||
Package chaincfg defines chain configuration parameters for the three standard
|
||||
Decred networks and provides the ability for callers to define their own custom
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
chainhash
|
||||
=========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/chaincfg/chainhash)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/chaincfg/chainhash)
|
||||
|
||||
chainhash provides a generic hash type and associated functions that allows the
|
||||
specific hash algorithm to be abstracted.
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
connmgr
|
||||
=======
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/connmgr)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/connmgr)
|
||||
|
||||
Package connmgr implements a generic Decred network connection manager.
|
||||
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
database
|
||||
========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/database)
|
||||
|
||||
Package database provides a block and metadata storage database.
|
||||
|
||||
@ -13,8 +14,7 @@ and that entity will be dcrd.
|
||||
|
||||
When a client wants programmatic access to the data provided by dcrd, they'll
|
||||
likely want to use the [dcrrpcclient](https://github.com/decred/dcrrpcclient)
|
||||
package which makes use of the [JSON-RPC API]
|
||||
(https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md).
|
||||
package which makes use of the [JSON-RPC API](https://github.com/decred/dcrd/tree/master/docs/json_rpc_api.md).
|
||||
|
||||
However, this package could be extremely useful for any applications requiring
|
||||
Decred block storage capabilities.
|
||||
@ -34,19 +34,6 @@ storage, and strict checksums in key areas to ensure data integrity.
|
||||
- Supports registration of backend databases
|
||||
- Comprehensive test coverage
|
||||
|
||||
## Documentation
|
||||
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/database2)
|
||||
|
||||
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/decred/dcrd/database2
|
||||
|
||||
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/decred/dcrd/database2
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
@ -55,13 +42,11 @@ $ go get github.com/decred/dcrd/database2
|
||||
|
||||
## Examples
|
||||
|
||||
* [Basic Usage Example]
|
||||
(http://godoc.org/github.com/decred/dcrd/database2#example-package--BasicUsage)
|
||||
* [Basic Usage Example](http://godoc.org/github.com/decred/dcrd/database2#example-package--BasicUsage)
|
||||
Demonstrates creating a new database and using a managed read-write
|
||||
transaction to store and retrieve metadata.
|
||||
|
||||
* [Block Storage and Retrieval Example]
|
||||
(http://godoc.org/github.com/decred/dcrd/database2#example-package--BlockStorageAndRetrieval)
|
||||
* [Block Storage and Retrieval Example](http://godoc.org/github.com/decred/dcrd/database2#example-package--BlockStorageAndRetrieval)
|
||||
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
|
||||
block.
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
ffldb
|
||||
=====
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/database/ffldb)
|
||||
|
||||
Package ffldb implements a driver for the database package that uses leveldb for
|
||||
the backing metadata and flat files for block storage.
|
||||
@ -33,19 +34,6 @@ if err != nil {
|
||||
}
|
||||
```
|
||||
|
||||
## Documentation
|
||||
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/database2/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/decred/dcrd/database2/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/decred/dcrd/database2/ffldb
|
||||
|
||||
## License
|
||||
|
||||
Package ffldb is licensed under the [copyfree](http://copyfree.org) ISC
|
||||
|
||||
@ -1,8 +1,9 @@
|
||||
treap
|
||||
=====
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/database/internal/treap)
|
||||
|
||||
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.
|
||||
@ -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
|
||||
available for use outside of it.
|
||||
|
||||
## Documentation
|
||||
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/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/decred/dcrd/database2/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/decred/dcrd/database2/internal/treap
|
||||
|
||||
## License
|
||||
|
||||
Package treap is licensed under the [copyfree](http://copyfree.org) ISC
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
dcrjson
|
||||
=======
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/dcrjson)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/dcrjson)
|
||||
|
||||
Package dcrjson implements concrete types for marshalling to and from the
|
||||
bitcoin JSON-RPC API. A comprehensive suite of tests is provided to ensure
|
||||
@ -32,21 +30,17 @@ $ go get -u github.com/decred/dcrd/dcrjson
|
||||
|
||||
## Examples
|
||||
|
||||
* [Marshal Command]
|
||||
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalCmd)
|
||||
* [Marshal Command](http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalCmd)
|
||||
Demonstrates how to create and marshal a command into a JSON-RPC request.
|
||||
|
||||
* [Unmarshal Command]
|
||||
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-UnmarshalCmd)
|
||||
* [Unmarshal Command](http://godoc.org/github.com/decred/dcrd/dcrjson#example-UnmarshalCmd)
|
||||
Demonstrates how to unmarshal a JSON-RPC request and then unmarshal the
|
||||
concrete request into a concrete command.
|
||||
|
||||
* [Marshal Response]
|
||||
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalResponse)
|
||||
* [Marshal Response](http://godoc.org/github.com/decred/dcrd/dcrjson#example-MarshalResponse)
|
||||
Demonstrates how to marshal a JSON-RPC response.
|
||||
|
||||
* [Unmarshal Response]
|
||||
(http://godoc.org/github.com/decred/dcrd/dcrjson#example-package--UnmarshalResponse)
|
||||
* [Unmarshal Response](http://godoc.org/github.com/decred/dcrd/dcrjson#example-package--UnmarshalResponse)
|
||||
Demonstrates how to unmarshal a JSON-RPC response and then unmarshal the
|
||||
result field in the response to a concrete type.
|
||||
|
||||
|
||||
@ -202,4 +202,4 @@ information.
|
||||
Provides a generic hash type and associated functions that allows the
|
||||
specific hash algorithm to be abstracted.
|
||||
* [connmgr](https://github.com/decred/dcrd/tree/master/connmgr) -
|
||||
Package connmgr implements a generic Decred network connection manager.
|
||||
Package connmgr implements a generic Decred network connection manager.
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
mempool
|
||||
=======
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/mempool)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/mempool)
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
mining
|
||||
======
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/mining)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/mining)
|
||||
|
||||
## Overview
|
||||
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
peer
|
||||
====
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/peer)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/peer)
|
||||
|
||||
Package peer provides a common base for creating and managing bitcoin network
|
||||
peers.
|
||||
@ -65,8 +63,7 @@ $ go get -u github.com/decred/dcrd/peer
|
||||
|
||||
## Examples
|
||||
|
||||
* [New Outbound Peer Example]
|
||||
(https://godoc.org/github.com/decred/dcrd/peer#example-package--NewOutboundPeer)
|
||||
* [New Outbound Peer Example](https://godoc.org/github.com/decred/dcrd/peer#example-package--NewOutboundPeer)
|
||||
Demonstrates the basic process for initializing and creating an outbound peer.
|
||||
Peers negotiate by exchanging version and verack messages. For demonstration,
|
||||
a simple handler for the version message is attached to the peer.
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
txscript
|
||||
========
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/txscript)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/txscript)
|
||||
|
||||
Package txscript implements the decred transaction script language. There is
|
||||
a comprehensive test suite.
|
||||
@ -27,18 +25,15 @@ $ go get -u github.com/decred/dcrd/txscript
|
||||
|
||||
## Examples
|
||||
|
||||
* [Standard Pay-to-pubkey-hash Script]
|
||||
(http://godoc.org/github.com/decred/dcrd/txscript#example-PayToAddrScript)
|
||||
* [Standard Pay-to-pubkey-hash Script](http://godoc.org/github.com/decred/dcrd/txscript#example-PayToAddrScript)
|
||||
Demonstrates creating a script which pays to a decred address. It also
|
||||
prints the created script hex and uses the DisasmString function to display
|
||||
the disassembled script.
|
||||
|
||||
* [Extracting Details from Standard Scripts]
|
||||
(http://godoc.org/github.com/decred/dcrd/txscript#example-ExtractPkScriptAddrs)
|
||||
* [Extracting Details from Standard Scripts](http://godoc.org/github.com/decred/dcrd/txscript#example-ExtractPkScriptAddrs)
|
||||
Demonstrates extracting information from a standard public key script.
|
||||
|
||||
* [Manually Signing a Transaction Output]
|
||||
(http://godoc.org/github.com/decred/dcrd/txscript#example-SignTxOutput)
|
||||
* [Manually Signing a Transaction Output](http://godoc.org/github.com/decred/dcrd/txscript#example-SignTxOutput)
|
||||
Demonstrates manually creating and signing a redeem transaction.
|
||||
|
||||
## License
|
||||
|
||||
@ -1,11 +1,9 @@
|
||||
wire
|
||||
====
|
||||
|
||||
[]
|
||||
(https://travis-ci.org/decred/dcrd) [![ISC License]
|
||||
(http://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)
|
||||
[]
|
||||
(http://godoc.org/github.com/decred/dcrd/wire)
|
||||
[](https://travis-ci.org/decred/dcrd)
|
||||
[](http://copyfree.org)
|
||||
[](http://godoc.org/github.com/decred/dcrd/wire)
|
||||
|
||||
Package wire implements the decred wire protocol. A comprehensive suite of
|
||||
tests with 100% test coverage is provided to ensure proper functionality.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user