fix: make the consumer and provider genesis round-trips restart-safe - #68
Open
giunatale wants to merge 1 commit into
Open
fix: make the consumer and provider genesis round-trips restart-safe#68giunatale wants to merge 1 commit into
giunatale wants to merge 1 commit into
Conversation
giunatale
requested review from
clockworkgr,
julienrbrt and
tbruyelle
as code owners
July 30, 2026 16:01
Contributor
Author
|
Branched from |
giunatale
force-pushed
the
giunatale/docs/refresh
branch
from
July 31, 2026 18:40
c6f2086 to
cf9e63f
Compare
giunatale
force-pushed
the
giunatale/fix/genesis-roundtrip
branch
from
July 31, 2026 18:41
e594c11 to
dda585e
Compare
- consumer: add highest_valset_update_id to the genesis proto and export/restore it, so a restarted consumer keeps deduplicating VSC packets by their update id instead of re-applying stale ones. - provider: treat an empty stored ConsumerValSet for a LAUNCHED consumer as must-snapshot, so the next epoch re-establishes the set after a restart rather than sending an empty diff. - consumer app export: set PubKey on each exported GenesisValidator so the set round-trips through genesis. - consumer: add consumer_in_debt to the genesis proto and export/restore it, mirroring last_vsc_recv_time. Both are arms of the same tx-admission gate and IsConsumerInDebt reads an unset flag as "not in debt", so a debt-gated consumer used to come back admitting ordinary transactions until the next VSC packet re-asserted the flag. - provider: add in_debt to ConsumerState and export/restore it too. Only the per-epoch fee distribution rewrites the flag, and only for LAUNCHED consumers, so it is not re-derivable at import the way the code comment and the runbook claimed: a PAUSED consumer resumed before its first post-restart distribution would be sent an immediate snapshot clearing a debt it still owes. - provider: validate the withheld-fee genesis amount (nil, negative, bad denom) like every sibling validator does. A genesis omitting the amount subfield used to pass Validate and panic later on a nil big.Int the first time the record was read for payment or escrow accounting. - drop the two vestigial per-block maps (ValsetUpdateBlockHeight, HeightValsetUpdateIDs) now that nothing reads them; their proto fields stay reserved. - add docs/genesis-restart-runbook.md describing the export/import round-trip. - e2e: restart the consumer from its exported genesis in TestVAAS, checking the exported valset pubkeys and dedup watermark and that VSC flow resumes. - test: cover the consumer's new-chain provider-chain-id pin, which nothing exercised -- the existing test covers only the restart branch.
giunatale
force-pushed
the
giunatale/fix/genesis-roundtrip
branch
from
July 31, 2026 19:01
dda585e to
1c22145
Compare
julienrbrt
reviewed
Aug 6, 2026
| // HeightToValsetUpdateId nil on new chain, filled in on restart. | ||
| repeated HeightToValsetUpdateID height_to_valset_update_id = 4 | ||
| [ (gogoproto.nullable) = false ]; | ||
| reserved 4; |
Member
There was a problem hiding this comment.
why not breaking the proto? backward compat isn't necessary
| // empty for a new chain | ||
| repeated ValsetUpdateIdToHeight valset_update_id_to_height = 3 | ||
| [ (gogoproto.nullable) = false ]; | ||
| reserved 3; |
| consumertypes "github.com/allinbits/vaas/x/vaas/consumer/types" | ||
| ) | ||
|
|
||
| // TestGetValidatorSetCarriesPubKeysAndReloads is the M6 property: the exported |
Member
There was a problem hiding this comment.
let's simplify this. what is M6 (except a tv channel).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes three export/restart correctness bugs, removes two vestigial per-block
maps, adds the missing restart runbook, and proves the consumer round-trip end
to end.
The bugs
out of order and deduplicated via
HighestValsetUpdateID; a restartedconsumer came back with the watermark at zero and would re-apply stale
updates. The watermark is now a genesis field, exported and restored.
a provider restart the stored set was empty, and diffing the live bonded set
against an empty set emits only additions — a validator that unbonded during
the outage would never get its power-0 removal and would keep consensus power
on the consumer indefinitely. Instead of exporting the set,
QueueVSCPacketsnow treats an empty stored set for a launched consumer asmust-snapshot: the first post-restart epoch sends a full snapshot, which
reconciles the consumer regardless of what it held. (The same path covers a
consumer's very first epoch.)
consumer exportemitted null validator pubkeys. CometBFT's genesisvalidation dereferences each pubkey on reload, so export-then-start was a
broken round-trip. The export now carries every validator's consensus
pubkey.
Also removed: two write-only per-block maps (provider
ValsetUpdateBlockHeightand consumer
HeightValsetUpdateIDs) whose proto fields are kept reserved.The consumer's in-debt flag survives a restart too
The consumer's in-debt flag gates its own transaction admission alongside the
VSC-staleness clock, but only the clock was round-tripped: a debt-gated consumer
that restarted from a state export came back ungated. Both arms are now
exported. The provider's copy of the flag is exported as well, rather than
relying on it being recomputed after import — the recomputation only runs at an
epoch boundary and only for launched consumers, so a provider restart while a
consumer was paused-and-in-debt, followed by a resume, would stamp "not in debt"
into the forced snapshot and clear the gate the consumer had just correctly
restored.
Genesis validation of withheld-fee records now checks the amount like every
sibling validator does: an omitted amount produced a nil big integer that
validated cleanly and then panicked during fee distribution, and a negative one
inflated the funds the pool believed it had.
Runbook
docs/genesis-restart-runbook.mddocuments the export/import contract of bothmodules, what is deliberately re-derived after restart, and the halt/upgrade
procedure — including one operational constraint discovered while testing this
PR end to end: advancing an IBC client past a restart requires the relayer to
fetch validator sets at pre-restart heights from the restarted chain, so an
export-based restart with a fresh data dir stalls packet flow from the
restarted chain (after a consumer restart the ack-driven liveness clock on the
provider is affected too). The runbook documents the two escape hatches (keep
the pre-restart block store queryable, or governance client recovery).
Testing
empty stored set, exported pubkeys survive CometBFT's reload validation.
quiesces the relayer, stops the container, asserts the exported genesis
carries non-null pubkeys and the exact committed watermark, restarts a fresh
container from the export on the same network identity, and asserts blocks
resume, the consumer stays LAUNCHED on the provider, and validator-set
updates converge with every post-restart update id strictly above the
restored watermark. Full main e2e suite green with it.