Skip to content

Commit

Permalink
Errors package C4 diagram (#323)
Browse files Browse the repository at this point in the history
* feat: add errors c4

* fix: update errors c4
  • Loading branch information
fabiorigam authored Dec 1, 2023
1 parent f222463 commit c264b13
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 2 deletions.
35 changes: 35 additions & 0 deletions docs/architecture-diagrams/errors-package.md
Original file line number Diff line number Diff line change
@@ -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.")
}
}
```
4 changes: 2 additions & 2 deletions docs/architecture-diagrams/network-package.md
Original file line number Diff line number Diff line change
@@ -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")
Expand Down

1 comment on commit c264b13

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Test Coverage

Summary

Lines Statements Branches Functions
Coverage: 100%
100% (1244/1244) 100% (273/273) 100% (263/263)
Title Tests Skipped Failures Errors Time
core 347 0 💤 0 ❌ 0 🔥 1m 10s ⏱️
network 90 0 💤 0 ❌ 0 🔥 1m 36s ⏱️
errors 30 0 💤 0 ❌ 0 🔥 8.161s ⏱️

Please sign in to comment.