Skip to content

Commit 77a421f

Browse files
bond00729claude
andcommitted
docs: scrub internal increment numbering from public code comments
Reword doc-comments and test section headers that referenced internal workstream increment numbers to describe the mechanism instead (the channel-register block-event fold, the verification-merge hook). The numbers are private-tracker vocabulary with no meaning to an external reader. Comment-only; no logic change. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent eb3a9ce commit 77a421f

5 files changed

Lines changed: 8 additions & 8 deletions

File tree

src/network/http_server.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4672,7 +4672,7 @@ mod tests {
46724672
fn channel_owner_change_hint_cause_maps_every_variant() {
46734673
// The proto->JSON cause conversion is a hand-written int->variant table; the round-trip
46744674
// test above only exercises TRANSFER. Pin every arm (0..=4) plus the unknown-int
4675-
// fallback: the NEXT increment starts emitting REGISTER/VERIFICATION_* hints, so the
4675+
// fallback: the ownership-hint feature emits REGISTER/VERIFICATION_* hints, so the
46764676
// arms about to go live are otherwise untested, and a transposition or a wrong fallback
46774677
// on this public wire contract would ship silently. The unknown case also freezes the
46784678
// intended forward-compat behavior (a future proto cause degrades to NONE, not a panic).

src/storage/store/account/onchain_event_store.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -452,7 +452,7 @@ fn build_secondary_indices_for_channel_register(
452452
Ok(change)
453453
}
454454

455-
/// Data-shard replica entry point (increment 7): runs ONLY the channel-register
455+
/// Data-shard replica entry point: runs ONLY the channel-register
456456
/// secondary-index fold against `db`/`txn` — it does not write the primary
457457
/// onchain-event record and does not touch the trie (those live in the shard-0
458458
/// merge path). Non-channel events fold to `None`. Returns the ownership change a

src/storage/store/block_engine_tests.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -302,7 +302,7 @@ mod tests {
302302
.is_none());
303303
}
304304

305-
// --- Shard-0 fan-out of channel-register events (increment 7) -----------------------------
305+
// --- Shard-0 fan-out of channel-register events -------------------------------------------
306306

307307
fn single_channel_register(channel_key: &str, owner_byte: u8) -> OnChainEvent {
308308
events_factory::create_channel_register_event(

src/storage/store/engine.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -816,7 +816,7 @@ impl ShardEngine {
816816
/// Emit `ChannelOwnerChangeHint` HubEvents for a just-merged Ethereum
817817
/// verification whose verified address owns one or more channels, by scanning
818818
/// THIS shard's own ByOwnerAddress replica (the trie-free ownership index built
819-
/// by the increment-7 block-event fold). Called only from the user-message
819+
/// by the channel-register block-event fold). Called only from the user-message
820820
/// merge loop's `Ok(merge_events)` arm — the hottest path this feature touches.
821821
///
822822
/// STRUCTURAL SAFETY CONTRACT (the rule this increment lives or dies by): this

src/storage/store/engine_tests.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4489,7 +4489,7 @@ mod tests {
44894489
}
44904490

44914491
// ----------------------------------------------------------------------------------------
4492-
// MergeOnChainEvent BlockEvent replica fold + ownership hints (increment 7).
4492+
// MergeOnChainEvent BlockEvent replica fold + ownership hints.
44934493
//
44944494
// Shard 0 fans channel-register events to every data shard as a MergeOnChainEvent BlockEvent;
44954495
// `handle_block_event` runs the trie-free replica fold against the shard's own
@@ -4950,10 +4950,10 @@ mod tests {
49504950
}
49514951

49524952
// ----------------------------------------------------------------------------------------
4953-
// Verification-merge channel-owner hints (increment 8).
4953+
// Verification-merge channel-owner hints.
49544954
//
49554955
// When an Ethereum verification merges on the user-message path, the engine scans THIS
4956-
// shard's own ByOwnerAddress replica (built by the increment-7 block-event fold) and emits
4956+
// shard's own ByOwnerAddress replica (built by the channel-register block-event fold) and emits
49574957
// one ChannelOwnerChangeHint per channel the verified address owns, cause VERIFICATION_ADD /
49584958
// VERIFICATION_REMOVE. The hook is STRUCTURALLY unable to fail, alter, or panic the merge:
49594959
// every error warns and yields fewer hints, and the merge result + trie are untouched.
@@ -5037,7 +5037,7 @@ mod tests {
50375037
test_helper::commit_block_events(engine, vec![&block_event]).await;
50385038
}
50395039

5040-
// Register `channel_key` to `owner` via the increment-7 block-event fold path (populates
5040+
// Register `channel_key` to `owner` via the channel-register block-event fold path (populates
50415041
// the shard's own ByOwnerAddress replica). REGISTER hint fires as a side effect.
50425042
async fn register_channel(engine: &mut ShardEngine, channel_key: &str, owner: Vec<u8>) {
50435043
let event = events_factory::create_channel_register_event(

0 commit comments

Comments
 (0)