Skip to content

Commit 2d04b54

Browse files
committed
docs(fast-inbox): drop spec references from cleanup-era inbox comments (A-1388)
1 parent 8b522a9 commit 2d04b54

19 files changed

Lines changed: 38 additions & 41 deletions

File tree

l1-contracts/src/core/interfaces/IRollup.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ struct PublicInputArgs {
2727
bytes32 previousArchive;
2828
bytes32 endArchive;
2929
bytes32 outHash;
30-
// Inbox rolling-hash chain segment consumed across the proven epoch (AZIP-22 Fast Inbox). Both boundaries are
30+
// Inbox rolling-hash chain segment consumed across the proven epoch. Both boundaries are
3131
// anchored at proof submission against the rolling hashes recorded at propose for checkpoints start - 1 and end.
3232
bytes32 previousInboxRollingHash;
3333
bytes32 endInboxRollingHash;

l1-contracts/src/core/libraries/rollup/ProposeLib.sol

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -401,8 +401,7 @@ library ProposeLib {
401401

402402
/**
403403
* @notice Validates a checkpoint's Inbox consumption against the streaming inbox buckets and returns how
404-
* far consumption has reached. Called from propose() as the enforced consumption path (AZIP-22 Fast
405-
* Inbox).
404+
* far consumption has reached. Called from propose() as the enforced consumption path.
406405
*
407406
* @dev Read-only; performs no Inbox write. Checks, in order:
408407
* 1. The checkpoint header's `inboxRollingHash` must equal the rolling hash snapshotted in the Inbox

l1-contracts/src/core/messagebridge/Inbox.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ contract Inbox is IInbox {
3838
uint256 public immutable BUCKET_RING_SIZE;
3939

4040
// Ring of rolling-hash buckets, keyed by `bucketSeq % BUCKET_RING_SIZE`. Consumed by the streaming inbox
41-
// checks at `propose` (AZIP-22 Fast Inbox).
41+
// checks at `propose`.
4242
mapping(uint256 ringIndex => InboxBucket bucket) internal buckets;
4343

4444
uint64 internal currentBucketSeq;

l1-contracts/test/fee_portal/depositToAztecPublic.t.sol

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ contract DepositToAztecPublic is Test {
6363
uint256 amount = 100 ether;
6464

6565
Inbox inbox = Inbox(address(Rollup(address(registry.getCanonicalRollup())).getInbox()));
66-
// Compact cumulative index (AZIP-22 Fast Inbox): the first message against a fresh Inbox has index 0.
66+
// Compact cumulative index: the first message against a fresh Inbox has index 0.
6767
uint256 expectedIndex = 0;
6868

6969
// The purpose of including the function selector is to make the message unique to that specific call. Note that

noir-projects/noir-protocol-circuits/crates/rollup-lib/src/checkpoint_root/components/checkpoint_rollup_public_inputs_composer.nr

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ impl<let NumBlobs: u32> CheckpointRollupPublicInputsComposer<NumBlobs> {
145145
last_archive_root: merged_rollup.previous_archive.root,
146146
block_headers_hash: merged_rollup.block_headers_hash,
147147
blobs_hash: self.blobs_hash,
148-
// Sourced from the inbox parity proof: the checkpoint's only inbox commitment (AZIP-22 Fast Inbox).
148+
// Sourced from the inbox parity proof: the checkpoint's only inbox commitment.
149149
inbox_rolling_hash: self.parity.end_rolling_hash,
150150
epoch_out_hash,
151151
slot_number: constants.slot_number,

noir-projects/noir-protocol-circuits/crates/types/src/abis/checkpoint_header.nr

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ pub struct CheckpointHeader {
1414
pub last_archive_root: Field,
1515
pub block_headers_hash: Field,
1616
pub blobs_hash: Field,
17-
// Inbox rolling-hash chain value after consuming all L1-to-L2 messages bundled into this checkpoint (AZIP-22 Fast
18-
// Inbox): the truncated-to-field sha256 chain the L1 Inbox accumulates. This is the checkpoint's only inbox
17+
// Inbox rolling-hash chain value after consuming all L1-to-L2 messages bundled into this checkpoint:
18+
// the truncated-to-field sha256 chain the L1 Inbox accumulates. This is the checkpoint's only inbox
1919
// commitment.
2020
pub inbox_rolling_hash: Field,
2121
// The root of the epoch out hash balanced tree. The out hash of the first checkpoint in the epoch is inserted at

yarn-project/archiver/src/modules/l1_synchronizer.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -431,7 +431,7 @@ export class ArchiverL1Synchronizer implements Traceable {
431431
}
432432

433433
// Compare local message store state with the remote. If they match, we just advance the match pointer. The
434-
// remote state is the Inbox's current bucket (AZIP-22 Fast Inbox): its cumulative total and consensus rolling
434+
// remote state is the Inbox's current bucket: its cumulative total and consensus rolling
435435
// hash are the Inbox's live chain position.
436436
const remoteBucket = await this.inbox.getCurrentBucket({ blockNumber: currentL1BlockNumber });
437437
const localLastMessage = await this.stores.messages.getLastMessage();

yarn-project/archiver/src/store/message_store.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ export class MessageStore {
218218
);
219219
}
220220

221-
// Check the compact-indexed messages arrive contiguously (AZIP-22 Fast Inbox): the global insertion index of
221+
// Check the compact-indexed messages arrive contiguously: the global insertion index of
222222
// each message is exactly one past the previous one.
223223
const expectedIndex = lastMessage === undefined ? 0n : lastMessage.index + 1n;
224224
if (message.index !== expectedIndex) {
@@ -229,7 +229,7 @@ export class MessageStore {
229229
);
230230
}
231231

232-
// Check the consensus rolling-hash chain is valid (AZIP-22 Fast Inbox): each message's rolling hash must
232+
// Check the consensus rolling-hash chain is valid: each message's rolling hash must
233233
// continue the chain from the previously inserted message.
234234
const previousInboxRollingHash = lastMessage?.inboxRollingHash ?? Fr.ZERO;
235235
const expectedInboxRollingHash = updateInboxRollingHash(previousInboxRollingHash, message.leaf);

yarn-project/archiver/src/test/fake_l1_state.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ export class FakeL1State {
172172
addMessages(_checkpointNumber: CheckpointNumber, l1BlockNumber: bigint, messageLeaves: Fr[]): void {
173173
const timestamp = this.getTimestampAtL1Block(l1BlockNumber);
174174
messageLeaves.forEach(leaf => {
175-
// Compact global insertion index (AZIP-22 Fast Inbox): the position in the Inbox's insertion order.
175+
// Compact global insertion index: the position in the Inbox's insertion order.
176176
const index = BigInt(this.messages.length);
177177
const { bucketSeq, inboxRollingHash } = this.absorbIntoBucket(leaf, timestamp);
178178

@@ -507,7 +507,7 @@ export class FakeL1State {
507507
});
508508

509509
// Mirror the on-chain Inbox current bucket: its consensus rolling hash and cumulative total are the live chain
510-
// position the archiver's message sync compares against (AZIP-22 Fast Inbox).
510+
// position the archiver's message sync compares against.
511511
mockInbox.getCurrentBucket.mockImplementation((opts: { blockTag?: string; blockNumber?: bigint } = {}) => {
512512
const blockNumber = opts.blockNumber ?? this.l1BlockNumber;
513513
const visibleMessages = this.messages.filter(m => m.l1BlockNumber <= blockNumber);

yarn-project/archiver/src/test/mock_structs.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export function makeInboxMessage(
4747

4848
/**
4949
* Builds a contiguous run of `totalCount` inbox messages with compact global indices starting at `initialIndex`
50-
* and a chained consensus rolling hash starting from `initialInboxHash` (AZIP-22 Fast Inbox).
50+
* and a chained consensus rolling hash starting from `initialInboxHash`.
5151
*/
5252
export function makeInboxMessages(
5353
totalCount: number,
@@ -79,7 +79,7 @@ export function makeInboxMessages(
7979

8080
/**
8181
* Creates `blockCount` full buckets of `MAX_L1_TO_L2_MSGS_PER_BLOCK` inbox messages each, with compact indices and one
82-
* bucket sequence per block (AZIP-22 Fast Inbox).
82+
* bucket sequence per block.
8383
*/
8484
export function makeInboxMessagesWithFullBlocks(blockCount: number): InboxMessage[] {
8585
return makeInboxMessages(MAX_L1_TO_L2_MSGS_PER_BLOCK * blockCount, {

0 commit comments

Comments
 (0)