add docs for high level views

0xPolygon · Oct 1, 2024 · 1dda997 · 1dda997
1 parent 115a109
commit 1dda997
Show file tree

Hide file tree

Showing 4 changed files with 41 additions and 0 deletions.
diff --git a/docs/cdk/architecture/high-level-views.md b/docs/cdk/architecture/high-level-views.md
@@ -0,0 +1,40 @@
+## CDK stack layout
+
+The following diagram depicts the full CDK stack layout and details some of the high level communication between components.
+
+![High level view of CDK stack](../../img/cdk/cdk-stack.png)
+
+### Communication steps
+
+- External applications interact with the CDK Erigon RPC node via the transaction pool manager.
+- Engineers use a CLI tool to manage the backend components, installing and initializing various modes of operation, such as validium versus rollup for example.
+- The CDK Erigon RPC sends transactions to the CDK Erigon sequencer which sequences transactions batches.
+- The CDK Erigon sequencer puts the transaction batches into the data streamer.
+- The data streamer streams data to the sequencer sender (validium mode) and the aggregator.
+- The sequencer sender sequences batches into the L1 smart contract domain and persists data into DAC nodes for validium mode operations.
+- The aggregator sends batches to the prover and receives proofs in return. It then aggregates the proofs into batches before submitting them to the L1 domain.
+- Users interact with the bridge service via the bridge UI.
+- The AggLayer also utilizes the bridge service and interacts with the L1 smart contracts.
+
+## User data flow
+
+The following diagram is a sequential depiction of the user data flow in validium mode using a mock prover and having an AggLayer connection.
+
+![High level view of CDK user data flow](../../img/cdk/user-data-flow.png)
+
+### Sequential steps
+
+1. User sends a transaction to the CDK Erigon RPC node.
+2. The Erigon RPC node proxies the data to the CDK Erigon sequencer node.
+3. The sequencer sequences the transaction batches.
+4. The sequencer puts the batches into the data streamer component.
+5. The data streamer component streams the data into the sequence sender for validium mode stacks. It streams data into the aggregator and AggLayer for rollup and validium mode stacks. 
+6. In validium mode, the sequencer sender persists transaction data into the DAC nodes.
+7. In validium mode, the sequencer sender sequences the batches into the L1 smart contracts.
+8. In both modes, the aggregator sends the batches to the prover and the prover returns the proofs.
+9. The aggregator batches the proofs.
+10. The aggregator submits the final proof to the AggLayer.
+11. The AggLayer submits the final proof to the L1 smart contract domain.
+
+!!! tip
+    Detailed AggLayer flows will be published soon.
diff --git a/docs/img/cdk/cdk-stack.png b/docs/img/cdk/cdk-stack.png
diff --git a/docs/img/cdk/user-data-flow.png b/docs/img/cdk/user-data-flow.png
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -78,6 +78,7 @@ nav:
         - Quickly test a running stack: cdk/how-to/quick-test-stack.md
         - Connect to CDK testnets: cdk/how-to/connect-testnet.md
       - Architecture:
+        - High level views: cdk/architecture/high-level-views.md
         - CDK rollup: cdk/architecture/cdk-zkevm.md
         - CDK validium: cdk/architecture/cdk-validium.md
         - Unified bridge - STB: cdk/architecture/staking-the-bridge.md