Improve docs #239
Open
Improve docs #239
+182
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ZanCorDX
requested review from
dvush,
metachris,
jakubhruby7 and
ferranbt
as code owners
Benchmark results for
|
| Date (UTC) | 2024-11-20T17:09:04+00:00 |
| Commit | cc35a81b090ef9df54c3f55f12d887f705c659f2 |
| Base SHA | 70579d128cda94081f1335e3cd3499ff94a7899a |
Significant changes
None
jakubhruby7
reviewed
Nov 13, 2024
| @@ -0,0 +1,179 @@ | |||
| # rbuilder Classes and Dataflow | |||
There was a problem hiding this comment.
I'd change this to something like LiveBuilder Dataflow and change the file name too.
|
|
||
| ## Core Components | ||
|
|
||
| To create a `LiveBuilder`, you need the following core components: |
There was a problem hiding this comment.
a LiveBuilder instance, ...
| - Receives block-building opportunities | ||
| - Each received `MevBoostSlotData` triggers a new block-building task via `BlockBuildingPool` | ||
| - Sources slots from `LiveBuilder::blocks_source` | ||
|
|
There was a problem hiding this comment.
we can add a section Dataflow Diagram as this diagram refers to two previous sections
|
|
||
| To create a `LiveBuilder`, you need the following core components: | ||
|
|
||
| 1. `blocks_source`: The source of slots to build. Implements the [`SlotSource`](../crates/rbuilder/src/live_builder/mod.rs) trait. This abstraction enables rbuilder to handle block building in various contexts: |
There was a problem hiding this comment.
let's link block_source
| - L1: Consensus client generating slots with potential forks | ||
| - L2: Sequencer generating slots | ||
|
|
||
| 2. `builders`: A vector of objects implementing the [`BlockBuildingAlgorithm`](../crates/rbuilder/src/building/builders/mod.rs) trait. Each builder: |
| - Continuously generates new blocks | ||
| - Optimizes to maximize the true block value | ||
|
|
||
| 3. `sink_factory`: A factory for the destination of built blocks. Implements [`UnfinishedBlockBuildingSinkFactory`](../crates/rbuilder/src/building/builders/mod.rs). This abstraction supports different contexts: |
There was a problem hiding this comment.
let's link sink_factory
|
|
||
| The main entrypoint `LiveBuilder::run()` initializes several long-lived components: | ||
|
|
||
| - **RPC Module**: |
There was a problem hiding this comment.
can we link to the RPC Module here?
ferranbt
approved these changes
Nov 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Summary
High-level doc about LiveBuilder.
💡 Motivation and Context
✅ I have completed the following steps:
make lintmake test