Improve Executor README #1398
Improve Executor README #1398
Conversation
CryptoMaxPlanck
requested review from
trajan0x and
ChiTimesChi
as code owners
WalkthroughThis change provides a comprehensive update to the Executor's README, enhancing its description and introducing a detailed explanation of the message lifecycle. The Changes
TipsChat with CodeRabbit Bot (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| * `OptimisticSeconds`: How many seconds should be allocated for fraud catching before the message is able to be executed on the `Destination` | ||
|
|
||
| Once a message is constructed with all of these fields and is dispatched via the `SendBaseMessage` function on the `Origin`'s Origin.sol contract, the message starts its lifecycle in the SIN. Let's say this message has nonce `N`. | ||
| 1. A <a href="../guard/README.md">Guard</a> captures a State of the Origin with a nonce of `N`. So messages from 1 to N are all included in this State. |
There was a problem hiding this comment.
This will be a valid link once #1375 gets merged.
Codecov ReportPatch coverage has no change and project coverage change:
Additional details and impacted files@@ Coverage Diff @@
## master #1398 +/- ##
===================================================
- Coverage 50.89321% 50.46648% -0.42674%
===================================================
Files 353 343 -10
Lines 24966 24117 -849
Branches 277 277
===================================================
- Hits 12706 12171 -535
+ Misses 10989 10734 -255
+ Partials 1271 1212 -59
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Description
Improve executor README.
Summary by CodeRabbit
agents/agents/executor/README.md, providing a more comprehensive understanding of its role and components.executeExecutableas the key executor of messages. This update offers users a clearer insight into the workings of the system.