WIP

Commit-Boost · Jul 5, 2024 · c7e3fae · c7e3fae
1 parent 8d93be3
commit c7e3fae
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 1 deletion.
diff --git a/docs/architecture-core-commit-boost.md b/docs/architecture-core-commit-boost.md
@@ -0,0 +1,6 @@
+# Core Commit-Boost
+Below is a schematic of Commit-Boost. This proposed architecture allows proposers to run one sidecar, but still retain the ability to opt into a network of proposer commitment modules. More specifically, with this middleware, the proposer will only need to (in the case of delegation) run one sidecar and limits their responsibilities to only selecting which module / proposer commitment protocol they would like to subscribe to.
+
+It is important to note that the below depiction contains just a few examples of proposer commitment modules that can run on Commit-Boost. The design space for modules is completely open / not gated by the Commit-Boost software. The Commit-Boost software also does not come with modules (these are developed by teams outside of the Commit-Boost software), proposers will be responsible for opting into the commitments they wish to subscribe to (i.e., a proposer is responsible for which modules they will subscribe to).
+![architecture](commit-boost.png)
+Using this as a middleware instead of direct modification to the consensus client or running a sidecar per commitment will allow for each component to be sustained independently and will provide for cross proposer commitment compatibility.
diff --git a/docs/architecture.md b/docs/architecture.md
@@ -0,0 +1,4 @@
+# Architecture
+The following are schematics and details around Commit-Boost.
+1. [Core Commit-Boost](architecture-core-commit-boost.md)
+1. [Terminology](terminology.md)
diff --git a/docs/architecture.png b/docs/architecture.png
diff --git a/docs/commit-boost.png b/docs/commit-boost.png
diff --git a/docs/index.html b/docs/index.html