From 7a67caa4fb2db4cc3a78ea2c08f0fdd8f07d93f7 Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Sat, 26 Sep 2020 15:32:35 -0500 Subject: [PATCH] docs: Update for blockchain/standalone v2 module. This updates the docs/README.md file, module hierarchy graphviz, and module hierarchy diagram to reflect the new module version and the removal of the chaincfg dependency. --- docs/README.md | 2 +- docs/assets/module_hierarchy.gv | 3 +- docs/assets/module_hierarchy.svg | 369 ++++++++++++++++--------------- 3 files changed, 190 insertions(+), 184 deletions(-) diff --git a/docs/README.md b/docs/README.md index f36dbce4..662ebf9c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -187,7 +187,7 @@ The following versioned modules are provided by dcrd repository: * [stake/v2](https://github.com/decred/dcrd/tree/master/blockchain/stake) - Provides an API for working with stake transactions and other portions related to the Proof-of-Stake (PoS) system - * [standalone](https://github.com/decred/dcrd/tree/master/blockchain/standalone) - + * [standalone/v2](https://github.com/decred/dcrd/tree/master/blockchain/standalone) - Provides standalone functions useful for working with the Decred blockchain consensus rules * [txscript/v3](https://github.com/decred/dcrd/tree/master/txscript) - diff --git a/docs/assets/module_hierarchy.gv b/docs/assets/module_hierarchy.gv index d7817af6..9ae542a3 100644 --- a/docs/assets/module_hierarchy.gv +++ b/docs/assets/module_hierarchy.gv @@ -18,7 +18,7 @@ digraph { hdkeychain [label="hdkeychain/v3" fillcolor=deepskyblue] txscript [label="txscript/v3" fillcolor=mediumspringgreen] stake [label="blockchain/stake/v2" fillcolor=bisque] - standalone [label="blockchain/standalone" fillcolor=firebrick4] + standalone [label="blockchain/standalone/v2" fillcolor=firebrick4] gcs [label="gcs" fillcolor=gold] blockchain [label="blockchain/v2" fillcolor=orchid] lru [label="lru" fillcolor=royalblue3] @@ -35,6 +35,7 @@ digraph { wire -> addrmgr [dir=back color=coral] wire -> chaincfg [dir=back color=coral] wire -> connmgr [dir=back color=coral] + wire -> standalone [dir=back color=coral] chainhash -> secp256k1 [dir=back color=aquamarine] dcrec -> dcrutil [dir=back color=mediumpurple] edwards -> dcrutil [dir=back color=lightseagreen] diff --git a/docs/assets/module_hierarchy.svg b/docs/assets/module_hierarchy.svg index 9a1d5438..1169d97e 100644 --- a/docs/assets/module_hierarchy.svg +++ b/docs/assets/module_hierarchy.svg @@ -4,271 +4,276 @@ - + %3 - -Module Hierarchy + +Module Hierarchy certgen - -certgen + +certgen dcrd - -dcrd + +dcrd -certgen->dcrd - - +certgen->dcrd + + chainhash - -chaincfg/chainhash + +chaincfg/chainhash dcrjson - -dcrjson/v3 + +dcrjson/v3 chainhash->dcrjson - - + + wire - -wire + +wire chainhash->wire - - + + secp256k1 - -dcrec/secp256k1/v3 + +dcrec/secp256k1/v3 -chainhash->secp256k1 - - +chainhash->secp256k1 + + types - -rpc/jsonrpc/types + +rpc/jsonrpc/types -dcrjson->types - - +dcrjson->types + + rpcclient - -rpcclient/v4 + +rpcclient/v4 -types->rpcclient - - +types->rpcclient + + addrmgr - -addrmgr + +addrmgr wire->addrmgr - - + + chaincfg - -chaincfg/v3 + +chaincfg/v3 wire->chaincfg - - + + connmgr - -connmgr/v3 + +connmgr/v3 wire->connmgr - - - - -addrmgr->dcrd - - - - -txscript - -txscript/v3 - - -chaincfg->txscript - - - - -connmgr->dcrd - - - - -dcrec - -dcrec - - -dcrutil - -dcrutil/v3 - - -dcrec->dcrutil - - - - -edwards - -dcrec/edwards/v2 - - -edwards->dcrutil - - - - -secp256k1->dcrutil - - - - -database - -database/v2 - - -dcrutil->database - - - - -hdkeychain - -hdkeychain/v3 - - -dcrutil->hdkeychain - - - - -dcrutil->txscript - - - - -stake - -blockchain/stake/v2 - - -database->stake - - - - -hdkeychain->dcrd - - - - -txscript->stake - - - - -gcs - -gcs - - -stake->gcs - - + + standalone - -blockchain/standalone + +blockchain/standalone/v2 + + +wire->standalone + + + + +addrmgr->dcrd + + + + +txscript + +txscript/v3 + + +chaincfg->txscript + + + + +connmgr->dcrd + + + + +dcrec + +dcrec + + +dcrutil + +dcrutil/v3 + + +dcrec->dcrutil + + + + +edwards + +dcrec/edwards/v2 + + +edwards->dcrutil + + + + +secp256k1->dcrutil + + + + +database + +database/v2 + + +dcrutil->database + + + + +hdkeychain + +hdkeychain/v3 + + +dcrutil->hdkeychain + + + + +dcrutil->txscript + + + + +stake + +blockchain/stake/v2 + + +database->stake + + + + +hdkeychain->dcrd + + + + +txscript->stake + + + + +gcs + +gcs + + +stake->gcs + + blockchain - -blockchain/v2 + +blockchain/v2 -standalone->blockchain - - +standalone->blockchain + + -gcs->blockchain - - +gcs->blockchain + + -gcs->rpcclient - - +gcs->rpcclient + + peer - -peer/v2 + +peer/v2 -blockchain->peer - - +blockchain->peer + + lru - -lru + +lru -lru->peer - - +lru->peer + + -peer->dcrd - - +peer->dcrd + + -rpcclient->dcrd - - +rpcclient->dcrd + +