fix about lost blockchain state: first pr: add debug prover and debug chain module for testing #174
Conversation
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
added 2 commits
August 22, 2025 15:19
…n state Signed-off-by: Daisuke Kanda <daisuke.kanda@datachain.jp>
Signed-off-by: Daisuke Kanda <daisuke.kanda@datachain.jp>
There was a problem hiding this comment.
Pull Request Overview
This PR introduces debug chain and prover modules to enable testing of blockchain state synchronization issues in optimism-bsc relay scenarios. The purpose is to simulate state pruning scenarios where nodes drop old state, causing query failures that lead to lost blockchain state.
Key changes:
- Adds debug wrapper modules for both chains and provers with configurable fake state loss simulation
- Modifies test configurations to use debug wrappers around existing tendermint configurations
- Integrates debug modules into the main application for testing support
Reviewed Changes
Copilot reviewed 17 out of 17 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/cases/tm2tm/configs/demo/ibc-*.json | Updated test configs to wrap tendermint chain/prover with debug variants |
| provers/debug/* | New debug prover module that wraps origin prover with fake state loss simulation |
| chains/debug/* | New debug chain module that wraps origin chain with query-time state loss simulation |
| main.go | Registers new debug modules in the application |
| coreutil/unwrap.go | Adds unwrapping support for debug chain and prover types |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
siburu
reviewed
Aug 26, 2025
chains/debug/module/module.go
Outdated
|
|
||
| // Name returns the name of the module | ||
| func (Module) Name() string { | ||
| return "debug" |
There was a problem hiding this comment.
There is no convention to name relayer modules, but I think "debug" is too simple and "debug-client" is a bit confusing because the debug prover does not define any light client.
I suggest "debug.chain" and "debug.prover", which is the same naming style as ethereum-ibc-relay-chain.
chains/debug/chain.go
Outdated
Comment on lines
25
to
27
| func (c *Chain) Config() ChainConfig { | ||
| return c.config | ||
| } |
There was a problem hiding this comment.
We can remove this, right?
If so we should do it now because removing dead code becomes more difficult as time passes.
chains/debug/query.go
Outdated
| logger := log.GetLogger() | ||
| env := fmt.Sprintf("DEBUG_RELAYER_PRUNE_AFTER_BLOCKS_CHAIN_%s", chain.ChainID()) | ||
| if val, ok := os.LookupEnv(env); ok { | ||
| logger.Debug(env, "chain", chain.ChainID(), "value", val) |
There was a problem hiding this comment.
Suggested change
| logger.Debug(env, "chain", chain.ChainID(), "value", val) | |
| logger.DebugContext(ctx, env, "chain", chain.ChainID(), "value", val) |
provers/debug/prover.go
Outdated
| logger := log.GetLogger() | ||
| env := fmt.Sprintf("DEBUG_RELAYER_PRUNE_AFTER_BLOCKS_PROVER_%s", chain.ChainID()) | ||
| if val, ok := os.LookupEnv(env); ok { | ||
| logger.Info(fmt.Sprintf(">%s: chain=%s: '%v'", env, chain.ChainID(), val)) |
There was a problem hiding this comment.
Suggested change
| logger.Info(fmt.Sprintf(">%s: chain=%s: '%v'", env, chain.ChainID(), val)) | |
| logger.DebugContext(ctx, fmt.Sprintf(">%s: chain=%s: '%v'", env, chain.ChainID(), val)) |
provers/debug/prover.go
Outdated
| env := fmt.Sprintf("DEBUG_RELAYER_SHFU_WAIT_%s", pr.chain.ChainID()) | ||
|
|
||
| if val, ok := os.LookupEnv(env); ok { | ||
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "value", val) |
There was a problem hiding this comment.
Suggested change
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "value", val) | |
| logger.DebugContext(ctx, env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "value", val) |
provers/debug/prover.go
Outdated
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", (i+1)*intervalSeconds, t)) | ||
| time.Sleep(time.Duration(intervalSeconds) * time.Second) | ||
| } | ||
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", t-n*intervalSeconds, t)) |
There was a problem hiding this comment.
Suggested change
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", t-n*intervalSeconds, t)) | |
| logger.DebugContext(ctx, env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", t-n*intervalSeconds, t)) |
provers/debug/prover.go
Outdated
| intervalSeconds := 60 | ||
| n := t / intervalSeconds | ||
| for i := 0; i < n; i++ { | ||
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", (i+1)*intervalSeconds, t)) |
There was a problem hiding this comment.
Suggested change
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", (i+1)*intervalSeconds, t)) | |
| logger.DebugContext(ctx, env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", (i+1)*intervalSeconds, t)) |
provers/debug/prover.go
Outdated
| } | ||
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "lap", fmt.Sprintf("%v/%v", t-n*intervalSeconds, t)) | ||
| time.Sleep(time.Duration(t-n*intervalSeconds) * time.Second) | ||
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "done", t) |
There was a problem hiding this comment.
Suggested change
| logger.Debug(env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "done", t) | |
| logger.DebugContext(ctx, env, "chain", pr.chain.ChainID(), "cp", counterparty.ChainID(), "done", t) |
|
|
||
| func (pr *Prover) Init(homePath string, timeout time.Duration, codec codec.ProtoCodecMarshaler, debug bool) error { | ||
| logger := log.GetLogger() | ||
| logger.Info("debug prover is initialized.") |
There was a problem hiding this comment.
Suggested change
| logger.Info("debug prover is initialized.") | |
| logger.Debug("debug prover is initialized.") |
dai1975
force-pushed
the
lo7181b-0-debug
branch
from
2adc10d to
ab00d8e
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
In case of optimism-bsc relay, at optimism it takes long time to update headers and then failed in querying to bsc node because it drops old state.
This series of pull-req changes current logic to:
I plan this series of pull-req constructs below and this is first part of it.