Skip to content

Commit 2b91492

Browse files
committed
fix(fast-inbox): drop removed consume/getRoot/getInProgress from inbox docs (A-1386)
The legacy-inbox cleanup removed IInbox.consume(), getRoot(), getInProgress() and InboxState.inProgress, but inbox.md still documented them — the #include_code for consume broke the docs build (identifier not found) once the lint gate stopped masking it. Drop the stale view-function rows, the internal consume() section, and the in-progress mention in getState; the surviving send_l1_to_l2_message include still resolves.
1 parent 0d29518 commit 2b91492

1 file changed

Lines changed: 1 addition & 25 deletions

File tree

  • docs/docs-developers/docs/foundational-topics/ethereum-aztec-messaging

docs/docs-developers/docs/foundational-topics/ethereum-aztec-messaging/inbox.md

Lines changed: 1 addition & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -35,34 +35,10 @@ These functions allow you to query the current state of the Inbox.
3535

3636
| Function | Returns | Description |
3737
| -------------------------- | ----------------- | ------------------------------------------------ |
38-
| `getRoot(uint256)` | `bytes32` | Returns the root of a message tree for a given checkpoint number. |
39-
| `getState()` | `InboxState` | Returns the current inbox state (rolling hash, total messages inserted, in-progress checkpoint). |
38+
| `getState()` | `InboxState` | Returns the current inbox state (rolling hash, total messages inserted). |
4039
| `getTotalMessagesInserted()` | `uint64` | Returns the total number of messages inserted into the inbox. |
41-
| `getInProgress()` | `uint64` | Returns the checkpoint number currently being filled. |
4240
| `getFeeAssetPortal()` | `address` | Returns the address of the Fee Juice portal. |
4341

44-
## Internal functions
45-
46-
:::note
47-
The following functions are only callable by the Rollup contract and are documented here for completeness.
48-
:::
49-
50-
### `consume()`
51-
52-
Consumes a message tree for a given checkpoint number.
53-
54-
#include_code consume l1-contracts/src/core/interfaces/messagebridge/IInbox.sol solidity
55-
56-
| Name | Type | Description |
57-
| ----------- | --------- | ---------------------------------------- |
58-
| _toConsume | `uint256` | The checkpoint number to consume. |
59-
| ReturnValue | `bytes32` | The root of the consumed message tree. |
60-
61-
#### Edge cases
62-
63-
- Will revert with `Inbox__Unauthorized()` if `msg.sender != ROLLUP`.
64-
- Will revert with `Inbox__MustBuildBeforeConsume()` if trying to consume a checkpoint that hasn't been built yet.
65-
6642
## Related pages
6743

6844
- [Outbox](./outbox.md) - L2 to L1 message passing

0 commit comments

Comments
 (0)