From c264b13726fd346133d7938449bcefb4b965a8d0 Mon Sep 17 00:00:00 2001 From: Fabio Rigamonti <73019897+fabiorigam@users.noreply.github.com> Date: Fri, 1 Dec 2023 09:46:29 +0100 Subject: [PATCH] Errors package C4 diagram (#323) * feat: add errors c4 * fix: update errors c4 --- docs/architecture-diagrams/errors-package.md | 35 +++++++++++++++++++ docs/architecture-diagrams/network-package.md | 4 +-- 2 files changed, 37 insertions(+), 2 deletions(-) create mode 100644 docs/architecture-diagrams/errors-package.md diff --git a/docs/architecture-diagrams/errors-package.md b/docs/architecture-diagrams/errors-package.md new file mode 100644 index 000000000..1e5ae9a93 --- /dev/null +++ b/docs/architecture-diagrams/errors-package.md @@ -0,0 +1,35 @@ +```mermaid +C4Context + title "vechain-SDK Architecture Overview - Errors Package" + + Boundary(b0, "vechain-SDK Errors Package") { + Boundary(b1, "Model") { + Boundary(b2, "Core") { + System(abi, "Abi", "Abi related errors") + System(address, "Address", "Address related errors") + System(bloom, "Bloom", "Bloom related errors") + System(certificate, "Certificate", "Certificate related errors") + System(data, "Data", "Data related errors") + System(hdnode, "HDNode", "HDNode related errors") + System(keystore, "Keystore", "Keystore related errors") + System(rlp, "RLP", "RLP related errors") + System(secp256k1, "Secp256k1", "Secp256k1 related errors") + System(transaction, "Transaction", "Transaction related errors") + } + + Boundary(b3, "Network") { + System(http-client, "HTTPClient", "HTTPClient related errors") + System(poll, "Poll", "Poll related errors") + } + } + + Boundary(b4, "Types") { + System(error-type, "ErrorType", "The error type from the error code") + } + + Boundary(b5, "Utils") { + System(asserts, "Asserts", "Assert that the condition is true, otherwise throw an error.") + System(error-builder, "ErrorBuilder", "Build error object according to the error code provided.") + } + } +``` \ No newline at end of file diff --git a/docs/architecture-diagrams/network-package.md b/docs/architecture-diagrams/network-package.md index 89e9e52ce..0b86f179d 100644 --- a/docs/architecture-diagrams/network-package.md +++ b/docs/architecture-diagrams/network-package.md @@ -1,8 +1,8 @@ ```mermaid C4Context - title "Vechain-SDK Architecture Overview" + title "vechain-SDK Architecture Overview - Network Package" - Boundary(b0, "Vechain-SDK Network Package") { + Boundary(b0, "vechain-SDK Network Package") { Boundary(b1, "Thor Client") { System(nodes_module, "Nodes Module", "Manages node operations such as health checks and network status") System(contracts_module, "Contracts Module", "Handles smart contract interactions including deployment and execution")