feat(ibc-testkit): revamp `MockContext` with chain capabilities #1135

rnbguy · 2024-03-19T12:42:21Z

Closes: #1045

Description

takes account of new ClientStateValidation and ClientContextValidation
introduces block production using Merkle root
begin_block and end_block methods for MockContext
removes clippy lints in ibc-testkit

PR author checklist:

Added changelog entry, using unclog.
Added tests.
Linked to GitHub issue.
Updated code comments and documentation (e.g., docs/).
Tagged one reviewer who will be the one responsible for shepherding this PR.

Reviewer checklist:

Reviewed Files changed in the GitHub PR explorer.
Manually tested (in case integration/unit/mock tests are absent).

rnbguy · 2024-03-20T17:14:17Z

I managed to write a minimal proof verification test with Tendermint light client. For now, it uses the ProofSpecs of basecoin_store.

To keep the proof retrieval minimal, I had to modify the ProvableContext::get_proof of MockIbcStore. Before it returned the encoded bytes of a singleCommitmentProof. Now it returns the encoded bytes of MerkleProofs, which is essentially a list of CommitmentProofs corresponding to a MerklePath.

Two shortcomings of basecoin_store:

No support for cosmos-sdk specs feat(store): support cosmos-sdk proof specs informalsystems/basecoin-rs#171
No support for non-membership proofs feat(store): support non membership proof informalsystems/basecoin-rs#158

Ignore this comment - as the changes related to this will be processed in a separated PR.

Farhad-Shabani

I've made a small simplification by adding a history() method to the TestHost trait.
I hope this change works well for you!
Regarding the HostParams and BlockParams, I think we can merge them into one to streamline things. Apart from this, everything else looks good. Let's proceed with the next PR!

rnbguy · 2024-03-29T11:07:52Z

That was a good suggestion. While doing that, I realized that the chain ID (and revision number) are not that relevant for our test cases. We can actually totally remove the chain_ids and use fixed zero as a default revision number. It is only needed to test client upgrades.

I still kept it as some of the tests are using Height::new(1, <height>). Let's refactor the following in future PR:

Add TestHost::revision_number that is only necessary for producing blocks (for a host with no concept of chain ID - this would just return zero)
Make latest_height in MockContextConfig to be just revision height i.e. u64 (as the Context does not need to deal with revision_number - this should be dealt via TestHost implementation)

* imp(testkit): Mock IBC context with `basecoin-store` types (#1068) * non empty default CommitmentPrefix * update ibc mock client types * fix tests for updated mock types * generalize MockContextConfig::into * rm clone from MockContext * add with_{client,consensus}_state * add blocks_since in utils.rs * client takes host timestamp by default * refactor relayer context test * fix few tests * add ibc-query and basecoin-store deps * add basecoin-store in mock ibc context * refactor for updated mock ibc context * imp timeout test * public git commit as dep source * fix spelling * update MockClient types * fix failing tests * rm unused utils and deps * fix cargo doc lint * use ibc host paths in mock context * rm redundant curly brackets --------- Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com> * imp(ibc-testkit): generalize `Host` for `MockContext` (#1107) * fix semantic conflict * happy clippy * fix next_consensus_state impl * update prev_consensus_state impl * use self.block_time over const * use constant timestamp over dynamic now * add new host impls * changes to ibc-testkit * rm deprecated methods * refactor tests * public fields for tm block params * forged client header update test * add todo comment * minor refactor * refactor tests * builder type for light client state * minor refactor * refactor tests * code opt * rename host structs * renamings * refactor tendermint host * mv year_2023 to utils * refactor the new tests * test malicious adjacent header update * fix tests * add changelog * rm unused chain_revision_number * add doc string for year_2023 * rename to query_latest_block * feat(ibc-testkit): revamp `MockContext` with chain capabilities (#1135) * imp: impl ctxs on MockIbcStore * fix: set update_meta whenever build light client * imp: generate_client_state should take latest_height * imp: remove unnecessary latest_client_states method * refactor: migrate host relevant fields/methods * fix: get back validate_self_client * imp: bring context types up under src * rm default for CommitmentPrefix * rm default height and timestamp impl for TestBlock * default MockStore * AnyClient and AnyConsensus state in MockIbcStore * at least one consensus state when bootstrapping light client * revision number in MockIbcStore * advance height in MockIbcStore * sync host and ibc store advance in conext * add host params to build host * update host trait * convenient type generics for host associated types * update MockHost * return existing block header with correct timestamp * update TendermintHost * update MockGenericContext impl * update mock context building * add implied trait bounds * refactor method * rm redundant imports and impl * call advance_block on context * update MockContext tests * rm ClientStateCommon * use HostParams to build a host * rm using max_history_size * update few tests * ignore failing tests * clippy::use_self * clippy::flat_map_option * clippy::cloned_instead_of_copied * clippy::redundant_clone * clippy::redundant_type_annotations * clippy::as_underscore * disable slow testcase * prune old host consensus state * prune host consensus history in fixture * enable ignored test * return client_id in fixture * fix and enable failing test * avoid Arc and Mutex * fix doc build * refactor host trait and impls * into over Self::from * fix msrv * explicit relative or global path for pub use * clippy::map_identity * clippy::inconsistent_struct_constructor * clippy::std_instead_of_core * use commitment_root for block generation * rename consensus_states to host_consensus_states * use basecoin proof specs * update tests * imp: add history() under TestHost * chore: add docstring for some of methods under TestHost * update TestHost trait * update MockHost and TendermintHost * add MockGenericContext::generate_genesis_block * update MockContextConfig * update tests * update remaining tests * rm comments and rename test * rm HostParams --------- Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com> * imp(ibc-testkit): Tendermint proof verifications via integration test (#1146) * test tmclient proof verification * use ClientStateConfig directly * rm MockClientConfig * use basecoin store proofspec as default * update tests * use merkle storage in MockContext * fix ProofSpecs size * refactor MockIbcStore to perform begin_block and end_block * simpler proof verification test * use ValidationContext::commitment_prefix() * nits * refactor host related trait method * tendermint host client integration test with proof verification * rm raw test * use typed relayer * add todo for channel integration test * core over std * be semantically correct * add comment for TypedRelayer * integration test for all pairs * fix semantic bug * renames * add channel management * channel creation in RelayerContext * add channel creation in integration test * add test for channel close * query client_id from connection and channel * ibc_store_mut * utils functions for packet relay * add packet relay integration test * add comments * optimize integration utils functions * serde feature for integration tests * rm redundant chain_id * sync clock only on a * add comment * imp: place router under MockGenericContext * nit: add docstring for router * nits * rm redundant lint filters * imp: ditch RelayerContext * nit: simplify build_client_update_datagram * refactor integration tests * add doc strings for TypedRelayerOps * doc strings for RelayerContext * mv client_update_ping_pong to tests dir * rename main_store to multi_store * update TestHost trait * update mock and tendermint hosts * update relayer functions * nits * renames and comments * add comments for return values in relayer ops * imp: simplify into_header --------- Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com> * rm prune_block_till * apply suggestions from code review Co-authored-by: Sean Chen <seanchen11235@gmail.com> Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> * rename context structs * add MockContext and TendermintContext * update with MockContext and TendermintContext * MockContextConfig to TestContextConfig * update comments with new namings * add util methods for StoreGenericTestContext * fix failing client recovery tests * increase default trusting period of MockClientState * fallible ProofSpecs conversion * update with new ClientStateConfig * use ExtClientValidationContext * fix links in doc comments * fix import order * fix semantic conflicts * Convertible over ConsensusStateConverter * rm ConsensusStateConverter * ibc-query as workspace deps * update Convertible * fix failing test * update changelog entry * add comments * rm absolute import * use expect over comment for safety * infallible try_into * update method names * add unused variable names * rm redundant TendermintBlock wrapper type * add comments * update docstrings * rm should never fail comment * update adr * fix compilation * fix failing test * docs: ADR-009 to revamp testing framework (#1157) * draft adr 009 * update adr-009 * apply suggestions from pr review Co-authored-by: Sean Chen <seanchen11235@gmail.com> Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> * use numbers list for sub-proposal titles Co-authored-by: Sean Chen <seanchen11235@gmail.com> Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> * links to validation and execute context Co-authored-by: Sean Chen <seanchen11235@gmail.com> Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> * apply suggestion from pr review * add links to impls * update comment * markdown format * update adr * use TestContext * update comment * apply suggestions from code review Co-authored-by: Sean Chen <seanchen11235@gmail.com> Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> * markdown format * update method names * fix cargo doc error --------- Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> Co-authored-by: Sean Chen <seanchen11235@gmail.com> --------- Signed-off-by: Rano | Ranadeep <ranadip.bswas@gmail.com> Signed-off-by: Rano | Ranadeep <ranadeep@informal.systems> Co-authored-by: Farhad Shabani <farhad.shabani@gmail.com> Co-authored-by: Sean Chen <seanchen11235@gmail.com>

Farhad-Shabani and others added 30 commits March 13, 2024 18:23

imp: impl ctxs on MockIbcStore

1d3ac06

fix: set update_meta whenever build light client

d031b5f

imp: generate_client_state should take latest_height

4a50497

imp: remove unnecessary latest_client_states method

ef3ac61

refactor: migrate host relevant fields/methods

617a1df

fix: get back validate_self_client

7d04e68

imp: bring context types up under src

8d6287e

rm default for CommitmentPrefix

6ea540a

rm default height and timestamp impl for TestBlock

d959fac

default MockStore

fa06a08

AnyClient and AnyConsensus state in MockIbcStore

188bde7

at least one consensus state when bootstrapping light client

fb1fbc3

revision number in MockIbcStore

31f2cec

advance height in MockIbcStore

163500d

sync host and ibc store advance in conext

4aab38f

add host params to build host

79d22e5

update host trait

dd88614

convenient type generics for host associated types

a6482b3

update MockHost

2ecbcba

return existing block header with correct timestamp

46f15d8

update TendermintHost

266c35c

update MockGenericContext impl

bd7767e

update mock context building

f9d1a15

add implied trait bounds

820b685

refactor method

999dd65

rm redundant imports and impl

78f0c2b

call advance_block on context

2ab8912

update MockContext tests

dfc8890

rm ClientStateCommon

83641e3

use HostParams to build a host

bd9ad77

rnbguy added 8 commits March 19, 2024 17:37

explicit relative or global path for pub use

d66f9b5

clippy::map_identity

2e467af

clippy::inconsistent_struct_constructor

8d71036

clippy::std_instead_of_core

ac52765

use commitment_root for block generation

73286c8

rename consensus_states to host_consensus_states

9ce5959

use basecoin proof specs

af03258

update tests

03d659f

rnbguy force-pushed the farhad/refactor-mock-context branch 2 times, most recently from 270d7a5 to 03d659f Compare March 26, 2024 15:34

rnbguy changed the title ~~feat(ibc-testkit): revamp MockContext with chain capabilities~~ feat(ibc-testkit): revamp MockContext with chain capabilities Mar 26, 2024

rnbguy requested a review from Farhad-Shabani March 26, 2024 15:44

rnbguy marked this pull request as ready for review March 26, 2024 15:46

Farhad-Shabani added 2 commits March 27, 2024 15:16

imp: add history() under TestHost

9f7494b

chore: add docstring for some of methods under TestHost

599e46d

Farhad-Shabani approved these changes Mar 27, 2024

View reviewed changes

rnbguy added 6 commits March 28, 2024 20:20

update TestHost trait

2c81318

update MockHost and TendermintHost

ccdec60

add MockGenericContext::generate_genesis_block

7c38fda

update MockContextConfig

11269f1

update tests

7e68c27

update remaining tests

8fdb879

rnbguy added 2 commits March 29, 2024 12:31

rm comments and rename test

0b5927a

rm HostParams

72c2a0e

rnbguy merged commit 5bdab7c into feat/refactor-testkit Mar 29, 2024
17 checks passed

rnbguy deleted the farhad/refactor-mock-context branch March 29, 2024 11:46

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(ibc-testkit): revamp `MockContext` with chain capabilities #1135

feat(ibc-testkit): revamp `MockContext` with chain capabilities #1135

rnbguy commented Mar 19, 2024 •

edited

Loading

rnbguy commented Mar 20, 2024 •

edited

Loading

Farhad-Shabani left a comment

rnbguy commented Mar 29, 2024 •

edited

Loading

feat(ibc-testkit): revamp MockContext with chain capabilities #1135

feat(ibc-testkit): revamp MockContext with chain capabilities #1135

Conversation

rnbguy commented Mar 19, 2024 • edited Loading

Description

PR author checklist:

Reviewer checklist:

rnbguy commented Mar 20, 2024 • edited Loading

Farhad-Shabani left a comment

Choose a reason for hiding this comment

rnbguy commented Mar 29, 2024 • edited Loading

feat(ibc-testkit): revamp `MockContext` with chain capabilities #1135

feat(ibc-testkit): revamp `MockContext` with chain capabilities #1135

rnbguy commented Mar 19, 2024 •

edited

Loading

rnbguy commented Mar 20, 2024 •

edited

Loading

rnbguy commented Mar 29, 2024 •

edited

Loading