add DEPENDENCIES.md

Author: plebhash

CONTRIBUTING.md

@@ -129,6 +129,8 @@ Public API exposure includes, but is not limited to:
 
 For crates that are already `1.0.0` or above, an incompatible version bump means a MAJOR bump. For `0.x.y` crates, an incompatible version bump usually means a MINOR bump, for example `0.2.3 -> 0.3.0`. A PATCH bump on a `0.x.y` crate is still treated as compatible within the same minor line, for example `0.2.3 -> 0.2.4`.
 
+For a visual representation of the dependency hierarchy of the different Rust crates, see the [DEPENDENCIES.md](DEPENDENCIES.md) file.
+
 ### Your First Code Contribution
 >In order to contribute, a basic learning about git and github is needed. If you're not familiar with them, have a look at https://docs.github.com/en/get-started/start-your-journey/git-and-github-learning-resources to dig into and learn how to use them.
 

DEPENDENCIES.md

@@ -0,0 +1,119 @@
+# Dependencies
+
+The main Rust SRI stack is split across two monorepos:
+- [`stratum`](https://github.com/stratum-rust/stratum): low-level foundational crates
+- [`sv2-apps`](https://github.com/stratum-rust/sv2-apps): high-level application crates
+
+All crates across these two repositories follow a well-defined dependency hierarchy:
+
+```mermaid
+flowchart TB
+  subgraph STR["stratum repo (low-level crates)"]
+    direction TB
+    derive["derive_codec_sv2"]
+    buffer["buffer_sv2"]
+    noise["noise_sv2"]
+    binary["binary_sv2"]
+    framing["framing_sv2"]
+    codec["codec_sv2"]
+    common["common_messages_sv2"]
+    job["job_declaration_sv2"]
+    mining["mining_sv2"]
+    template["template_distribution_sv2"]
+    ext["extensions_sv2"]
+    channels["channels_sv2"]
+    parsers["parsers_sv2"]
+    handlers["handlers_sv2"]
+    sv1["sv1_api"]
+    translation["stratum_translation"]
+    core["stratum-core"]
+  end
+
+  subgraph APPS["sv2-apps repo (application crates)"]
+    direction TB
+    sapps["stratum-apps"]
+    bcsv2["bitcoin_core_sv2"]
+    jdc["jd_client_sv2"]
+    tr["translator_sv2"]
+    jds["jd_server_sv2"]
+    pool["pool_sv2"]
+    it["integration_tests_sv2"]
+  end
+
+  derive --> binary
+  buffer -. "with_buffer_pool" .-> binary
+  noise --> framing
+  binary --> framing
+  buffer -. "with_buffer_pool" .-> framing
+  binary --> codec
+  framing --> codec
+  buffer --> codec
+  noise -. "noise_sv2 feature" .-> codec
+
+  binary --> common
+  binary --> job
+  binary --> mining
+  binary --> template
+  binary --> ext
+  binary --> sv1
+
+  binary --> channels
+  mining --> channels
+  template --> channels
+
+  binary --> parsers
+  framing --> parsers
+  common --> parsers
+  job --> parsers
+  mining --> parsers
+  template --> parsers
+  ext --> parsers
+
+  parsers --> handlers
+  framing --> handlers
+  common --> handlers
+  job --> handlers
+  mining --> handlers
+  template --> handlers
+  ext --> handlers
+  binary --> handlers
+
+  sv1 --> translation
+  mining --> translation
+  channels --> translation
+  binary --> translation
+
+  binary --> core
+  buffer --> core
+  noise --> core
+  framing --> core
+  codec --> core
+  common --> core
+  job --> core
+  mining --> core
+  template --> core
+  ext --> core
+  channels --> core
+  parsers --> core
+  handlers --> core
+  sv1 -. "sv1 feature" .-> core
+  translation -. "translation feature" .-> core
+
+  core -. "git/cargo dep" .-> sapps
+  core -. "git/cargo dep" .-> bcsv2
+
+  sapps --> jdc
+  sapps --> tr
+  sapps --> jds
+  sapps --> pool
+  sapps --> it
+
+  bcsv2 --> jdc
+  bcsv2 --> jds
+  bcsv2 --> pool
+
+  jds --> pool
+  jdc --> it
+  tr --> it
+  pool --> it
+```

README.md

@@ -36,6 +36,8 @@ If you’re looking to run Sv2 applications at the most recent changes, check ou
 - `stratum-core/` - Entrypoint for all the low-level crates in `sv2/` and `sv1/`implementations
   - `stratum-translation` - Stratum V1 ↔ Stratum V2 translation utilities
 
+For a visual representation of the dependency hierarchy of the different Rust crates, see the [DEPENDENCIES.md](DEPENDENCIES.md) file.
+
 ## Local Integration Testing
 
 To run integration tests locally: