new docs design #8
Conversation
WalkthroughThe updates primarily focus on refining the orchestrator's role, shifting from handling DA publishing in version 1 to a more flexible flow that can adapt based on external systems and constraints. This involves significant changes in the sequence of job executions and interactions with various components. There are no alterations to the declarations of exported or public entities. Changes
Sequence Diagram(s) (Beta)sequenceDiagram
participant Orchestrator
participant DB
participant Madara
participant CairoVM
participant prover_api
participant AltDA
participant SettlementLayer
participant DALayer
Orchestrator->>DB: get PIE of SNOS/SNAR from db_id
DB-->>Orchestrator: PIE
Orchestrator->>Madara: get SNOS input
Madara-->>Orchestrator: input
Orchestrator->>CairoVM: execute SNOS
Orchestrator->>prover_api: submit PIE for proof creation
prover_api-->>Orchestrator: polling_id
Orchestrator->>prover_api: polls over the polling_id and gets status
prover_api-->>Orchestrator: success
Orchestrator->>DB: store PIE
DB-->>Orchestrator: ok
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (1)
docs/orchestrator_da_sequencer_diagram.pngis excluded by!**/*.png
Files selected for processing (2)
- README.md (1 hunks)
- docs/orchestrator_da_sequencer_diagram.txt (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~8-~8: The preposition ‘of’ seems more likely in this position.
Context: ...obs to the prover 3. updating the state on Cairo core contracts The tentative flo...
[uncategorized] ~10-~10: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...flow of the orchestrator looks like this but this is subject to change as we learn m...
Additional comments not posted (4)
README.md (1)
11-11: The image link to the orchestrator diagram is correctly formatted and points to the updated diagram.docs/orchestrator_da_sequencer_diagram.txt (3)
1-1: The title change to "Orchestrator Flow" accurately reflects the updated content of the diagram.
5-10: The updated interactions in the sequence diagram are clear and accurately represent the orchestrator's enhanced role in managing various jobs.Also applies to: 27-41
1-67: The removal of certain participants and the database reference simplifies the diagram and focuses on the essential components, aligning with the new design strategy.
README.md
Outdated
| @@ -7,7 +7,7 @@ parallel to Madara and handles | |||
| 2. running SNOS and submitting jobs to the prover | |||
| 3. updating the state on Cairo core contracts | |||
|
|
|||
| As a v1, the orchestrator handles the DA publishing. The architecture for the | |||
| same is as follows | |||
| The tentative flow of the orchestrator looks like this but this is subject to change as we | |||
There was a problem hiding this comment.
Consider adding a comma before "but" to improve readability.
- The tentative flow of the orchestrator looks like this but this is subject to change as we
+ The tentative flow of the orchestrator looks like this, but this is subject to change as weCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The tentative flow of the orchestrator looks like this but this is subject to change as we | |
| The tentative flow of the orchestrator looks like this, but this is subject to change as we |
Tools
LanguageTool
[uncategorized] ~10-~10: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...flow of the orchestrator looks like this but this is subject to change as we learn m...
There was a problem hiding this comment.
Actionable comments posted: 1
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- README.md (1 hunks)
Additional context used
LanguageTool
README.md
[uncategorized] ~8-~8: The preposition ‘of’ seems more likely in this position.
Context: ...obs to the prover 3. updating the state on Cairo core contracts The tentative flo...
[uncategorized] ~10-~10: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...flow of the orchestrator looks like this but this is subject to change as we learn m...
| The tentative flow of the orchestrator looks like this but this is subject to | ||
| change as we learn more about external systems and the constratins involved. |
There was a problem hiding this comment.
Consider adding a comma before "but" to improve readability.
- The tentative flow of the orchestrator looks like this but this is subject to
+ The tentative flow of the orchestrator looks like this, but this is subject toCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| The tentative flow of the orchestrator looks like this but this is subject to | |
| change as we learn more about external systems and the constratins involved. | |
| The tentative flow of the orchestrator looks like this, but this is subject to | |
| change as we learn more about external systems and the constratins involved. |
Tools
LanguageTool
[uncategorized] ~10-~10: Use a comma before ‘but’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...flow of the orchestrator looks like this but this is subject to change as we learn m...
Summary by CodeRabbit