From cc33b719bca49c8e9e8a048b8c6bef9418dd9e9d Mon Sep 17 00:00:00 2001 From: Dave Collins Date: Sat, 17 Jun 2023 23:00:36 -0500 Subject: [PATCH] docs: Update for blockchain v5 module. This updates the module hierarchy graphviz and module hierarchy diagram to accurately reflect the latest blockchain module dependencies. In particular, blockchain/v5 no longer relies on the gcs, stake, or database modules. It also rearranges the definitions a bit in the graphviz to produce a more balanced diagram. --- docs/assets/module_hierarchy.gv | 21 +- docs/assets/module_hierarchy.svg | 358 +++++++++++++++---------------- 2 files changed, 190 insertions(+), 189 deletions(-) diff --git a/docs/assets/module_hierarchy.gv b/docs/assets/module_hierarchy.gv index 5c97ece935..7afcdd611c 100644 --- a/docs/assets/module_hierarchy.gv +++ b/docs/assets/module_hierarchy.gv @@ -1,6 +1,6 @@ digraph { graph [splines=ortho colorscheme=svg label=<Module Hierarchy> labelloc=t fontsize=18.0] - node [shape=box style="filled, rounded"] + node [shape=box style="filled, rounded" margin=0.1] blake256 [label="crypto/blake256" fillcolor=cornflowerblue] ripemd160 [label="crypto/ripemd160" fillcolor=darkturquoise] @@ -10,9 +10,7 @@ digraph { dcrjson [label="dcrjson/v4" fillcolor=indianred] types [label="rpc/jsonrpc/types/v4" fillcolor=tomato] wire [label="wire" fillcolor=coral] - addrmgr [label="addrmgr/v2" fillcolor=lightsalmon] chaincfg [label="chaincfg/v3" fillcolor=cadetblue] - connmgr [label="connmgr/v3" fillcolor=mistyrose] dcrec [label="dcrec" fillcolor=mediumpurple] edwards [label="dcrec/edwards/v2" fillcolor=lightseagreen] secp256k1 [label="dcrec/secp256k1/v4" fillcolor=mediumvioletred] @@ -21,19 +19,22 @@ digraph { hdkeychain [label="hdkeychain/v3" fillcolor=deepskyblue] txscript [label="txscript/v4" fillcolor=mediumspringgreen] stake [label="blockchain/stake/v5" fillcolor=bisque] - standalone [label="blockchain/standalone/v2" fillcolor=firebrick4] gcs [label="gcs/v4" fillcolor=gold] - blockchain [label="blockchain/v5" fillcolor=orchid] + standalone [label="blockchain/standalone/v2" fillcolor=firebrick4] lru [label="lru" fillcolor=royalblue3] peer [label="peer/v3" fillcolor=khaki] rpcclient [label="rpcclient/v8" fillcolor=mediumseagreen] + addrmgr [label="addrmgr/v2" fillcolor=lightsalmon] + connmgr [label="connmgr/v3" fillcolor=mistyrose] + blockchain [label="blockchain/v5" fillcolor=orchid] apbf [label="container/apbf" fillcolor=goldenrod] uint256 [label="math/uint256" fillcolor=lightgreen] dcrd [label="dcrd" fillcolor=chocolate] {rank=same blake256 chainhash} {rank=same dcrec secp256k1} - {rank=same connmgr addrmgr hdkeychain peer blockchain rpcclient} + {rank=same certgen bech32 apbf uint256} + {rank=same addrmgr connmgr hdkeychain peer blockchain standalone rpcclient} certgen bech32 @@ -53,18 +54,18 @@ digraph { txscript -> dcrutil [dir=back color=mediumspringgreen] txscript -> hdkeychain [dir=back color=mediumspringgreen] txscript -> peer [dir=back color=mediumspringgreen] + dcrutil -> blockchain [dir=back color=burlywood] dcrutil -> database [dir=back color=burlywood] database -> stake [dir=back color=dodgerblue] stake -> gcs [dir=back color=bisque] - standalone -> blockchain [dir=back color=firebrick4] - gcs -> blockchain [dir=back color=gold] gcs -> rpcclient [dir=back color=gold] lru -> peer [dir=back color=royalblue3] - dcrjson -> types [dir=back color=tomato] - types -> rpcclient [dir=back color=indianred] + dcrjson -> types [dir=back color=indianred] + types -> rpcclient [dir=back color=tomato] blockchain -> dcrd [dir=back color=orchid] + standalone -> dcrd [dir=back color=firebrick] certgen -> dcrd [dir=back color=darkkhaki] bech32 -> dcrd [dir=back color=antiquewhite3] addrmgr -> dcrd [dir=back color=lightsalmon] diff --git a/docs/assets/module_hierarchy.svg b/docs/assets/module_hierarchy.svg index cdfca6224a..d423bc942a 100644 --- a/docs/assets/module_hierarchy.svg +++ b/docs/assets/module_hierarchy.svg @@ -4,326 +4,326 @@ - + %3 - -Module Hierarchy + +Module Hierarchy blake256 - -crypto/blake256 + +crypto/blake256 chainhash - -chaincfg/chainhash + +chaincfg/chainhash blake256->chainhash - - + + -secp256k1 - -dcrec/secp256k1/v4 +secp256k1 + +dcrec/secp256k1/v4 blake256->secp256k1 - - + + ripemd160 - -crypto/ripemd160 + +crypto/ripemd160 -txscript - -txscript/v4 +txscript + +txscript/v4 ripemd160->txscript - - + + certgen - -certgen + +certgen dcrd - -dcrd + +dcrd certgen->dcrd - - + + bech32 - -bech32 + +bech32 bech32->dcrd - - + + dcrjson - -dcrjson/v4 + +dcrjson/v4 chainhash->dcrjson - - + + wire - -wire + +wire chainhash->wire - - + + types - -rpc/jsonrpc/types/v4 + +rpc/jsonrpc/types/v4 -dcrjson->types - - +dcrjson->types + + -rpcclient - -rpcclient/v8 +rpcclient + +rpcclient/v8 -types->rpcclient - - - - -addrmgr - -addrmgr/v2 - - -wire->addrmgr - - +types->rpcclient + + -chaincfg - -chaincfg/v3 +chaincfg + +chaincfg/v3 wire->chaincfg - - - - -connmgr - -connmgr/v3 - - -wire->connmgr - - + + -standalone - -blockchain/standalone/v2 +standalone + +blockchain/standalone/v2 wire->standalone - - + + - -addrmgr->dcrd - - + +addrmgr + +addrmgr/v2 + + +wire->addrmgr + + + + +connmgr + +connmgr/v3 + + +wire->connmgr + + chaincfg->txscript - - - - -connmgr->dcrd - - + + -dcrec - -dcrec +dcrec + +dcrec dcrec->txscript - - + + -edwards - -dcrec/edwards/v2 +edwards + +dcrec/edwards/v2 edwards->txscript - - + + secp256k1->txscript - - + + -dcrutil - -dcrutil/v4 +dcrutil + +dcrutil/v4 -database - -database/v3 +database + +database/v3 -dcrutil->database - - +dcrutil->database + + + + +blockchain + +blockchain/v5 + + +dcrutil->blockchain + + -stake - -blockchain/stake/v5 +stake + +blockchain/stake/v5 -database->stake - - +database->stake + + -hdkeychain - -hdkeychain/v3 +hdkeychain + +hdkeychain/v3 hdkeychain->dcrd - - + + txscript->dcrutil - - + + txscript->hdkeychain - - + + -peer - -peer/v3 +peer + +peer/v3 txscript->peer - - + + -gcs - -gcs/v4 +gcs + +gcs/v4 -stake->gcs - - - - -blockchain - -blockchain/v5 - - -standalone->blockchain - - - - -gcs->blockchain - - +stake->gcs + + -gcs->rpcclient - - +gcs->rpcclient + + - -blockchain->dcrd - - + +standalone->dcrd + + -lru - -lru +lru + +lru -lru->peer - - +lru->peer + + peer->dcrd - - + + rpcclient->dcrd - - + + + + +addrmgr->dcrd + + + + +connmgr->dcrd + + + + +blockchain->dcrd + + apbf - -container/apbf + +container/apbf apbf->dcrd - - + + uint256 - -math/uint256 + +math/uint256 uint256->dcrd - - + +