New message box model

[LHerskind]

Following the new proposal put forth in #4485 we need to change the current implementation.
As described in the proposal we can do the changes of incoming and outgoing messages independently.

Since it is not changing the apis from inside the network. It don't need to be finished by 18 of Feb where dog-fooding starts again.

Note: Look for "TODO(#4492)" in the codebase.

Outbox

The circuit requirements to match the new outbox is already planned as part of the #3533 task. But some sections have not been finished yet.

Dependent on

Preview Give feedback

1. Update L2 block structure to include Body struct #3868
   +0
   
2. refactor: Update the TxsHash + add TxEffect #3938
   +0
   
3. Re-enable public inputs hash and body hash (originally calldata hash) checks #4031
   +0
   
4. docs: New CrossChain Message model #4250
   +0
   

When we have handled the above our hands are less tied, and we can get properly started.

Tasks

Preview Give feedback

1. feat: update header to match message extension #4560
   0 of 2
   +0
   
2. feat(Outbox): compute out_hash in circuits #4561
   +0
   
3. feat(Outbox): add api for inclusion proof of outgoing message in block #4562
   +0
   
4. feat(Outbox): build ethereum contract that stores roots and allow consumption #4768
   +0
   
5. feat!(Outbox): plug-in new outbox and update examples to use api to fetch inclusion proofs #4769
   +0
   

Inbox

The inbox requires quite a lot more changes to replace the existing implementation. However, there are no blocking dependencies before the work can be kicked off.

As the changes are quite large, we should look at targeting it piecemeal without bricking the existing system. Essentially, allow us to run the old, or the new where a few new E2E tests should be usable to check the new flow. Essentially running the uniswap example when we have a few pieces in place.

Circuits

Preview Give feedback

1. discussion: align on divide and conquer or a new circuit then write stuff here
2. docs: Document the new circuits for in_hash #4558
   +0
   
3. Unify naming of msgKey and entryKey #4678
   +0
   
4. feat(Inbox): build parity circuits and put down plumbing to construct the block #4633
   +0
   
5. refactor(Inbox): remove fee and deadline #4833
   +0
   
6. refactor(Inbox): indexed message tree #4829
   S-needs-discussion +1

Contracts

Preview Give feedback

1. feat: Implement the new inbox that build trees #4825
   +0
   
2. feat(Inbox): Update archiver to fetch the messages from inbox and put in sequence #4828
   +0
   
3. feat(Inbox): Update block builder to construct tree from the message sequence #5071
   +0
   
4. feat(Inbox): Replace the old inbox in the state transitioner #5072
   +0
   

Misc

Preview Give feedback

1. refactor(Inbox): getL1ToL2MessageAndIndex should return the first non-nullified message, not the first message #3976
   +0
   
2. refactor(Inbox): purge old inbox #5263
   +0
   
3. refactor(Inbox): Cleanup inbox (naming etc.) #5264
   +0
   

---

Finale

Preview Give feedback

1. refactor(MessageBoxes): Prune data send in process #5073
   +0
   
2. refactor(Inbox): L1ToL2Message leaf index should be stored with the confirmed message to allow easy lookups #697
   +0
3. refactor(PortalAddress): Purge the portal address and use storage instead #5836
   +0
   

[LHerskind]

Remaining tasks of the message box model is low priority and can be addressed if needed at some point, but left to die off for now.

[LHerskind]

All issues semes to have been resolved. Will be closing this.