From 5fc2f2e61744233bfa9624034d9b59b614869ac1 Mon Sep 17 00:00:00 2001 From: MSalopek Date: Tue, 17 Oct 2023 14:34:19 +0200 Subject: [PATCH] partial: update democ tests (use Param collections) --- app/consumer-democracy/app.go | 24 ++-- app/consumer/app.go | 5 + app/sovereign/app.go | 18 +-- tests/integration/democracy.go | 32 +++-- tests/integration/setup.go | 3 +- testutil/ibc_testing/specific_setup.go | 2 +- testutil/integration/interfaces.go | 29 +--- testutil/simibc/README.md | 19 --- testutil/simibc/ordered_outbox.go | 114 ---------------- testutil/simibc/relay_util.go | 179 ------------------------- testutil/simibc/relayed_path.go | 153 --------------------- 11 files changed, 59 insertions(+), 519 deletions(-) delete mode 100644 testutil/simibc/README.md delete mode 100644 testutil/simibc/ordered_outbox.go delete mode 100644 testutil/simibc/relay_util.go delete mode 100644 testutil/simibc/relayed_path.go diff --git a/app/consumer-democracy/app.go b/app/consumer-democracy/app.go index f954ddd03a..ed4e8d81fa 100644 --- a/app/consumer-democracy/app.go +++ b/app/consumer-democracy/app.go @@ -877,10 +877,10 @@ func (app *App) GetTestSlashingKeeper() testutil.TestSlashingKeeper { return app.SlashingKeeper } -// // GetTestEvidenceKeeper implements the ConsumerApp interface. -// func (app *App) GetTestEvidenceKeeper() testutil.TestEvidenceKeeper { -// return app.EvidenceKeeper -// } +// GetTestEvidenceKeeper implements the ConsumerApp interface. +func (app *App) GetTestEvidenceKeeper() evidencekeeper.Keeper { + return app.EvidenceKeeper +} // GetTestStakingKeeper implements the ConsumerApp interface. func (app *App) GetTestStakingKeeper() testutil.TestStakingKeeper { @@ -892,15 +892,15 @@ func (app *App) GetTestDistributionKeeper() testutil.TestDistributionKeeper { return app.DistrKeeper } -// // GetTestMintKeeper implements the ConsumerApp interface. -// func (app *App) GetTestMintKeeper() testutil.TestMintKeeper { -// return app.MintKeeper -// } +// GetTestMintKeeper implements the ConsumerApp interface. +func (app *App) GetTestMintKeeper() mintkeeper.Keeper { + return app.MintKeeper +} -// // GetTestGovKeeper implements the ConsumerApp interface. -// func (app *App) GetTestGovKeeper() testutil.TestGovKeeper { -// return app.GovKeeper -// } +// GetTestGovKeeper implements the ConsumerApp interface. +func (app *App) GetTestGovKeeper() govkeeper.Keeper { + return app.GovKeeper +} // TestingApp functions diff --git a/app/consumer/app.go b/app/consumer/app.go index cdfcf17867..4e2601626a 100644 --- a/app/consumer/app.go +++ b/app/consumer/app.go @@ -746,6 +746,11 @@ func (app *App) GetTestSlashingKeeper() testutil.TestSlashingKeeper { return app.SlashingKeeper } +// GetTestEvidenceKeeper implements the ConsumerApp interface. +func (app *App) GetTestEvidenceKeeper() evidencekeeper.Keeper { + return app.EvidenceKeeper +} + // TestingApp functions // GetBaseApp implements the TestingApp interface. diff --git a/app/sovereign/app.go b/app/sovereign/app.go index 33744b3ba7..f8d52fae5b 100644 --- a/app/sovereign/app.go +++ b/app/sovereign/app.go @@ -757,9 +757,9 @@ func (app *App) GetTestSlashingKeeper() testutil.TestSlashingKeeper { return app.SlashingKeeper } -// func (app *App) GetTestEvidenceKeeper() testutil.TestEvidenceKeeper { -// return app.EvidenceKeeper -// } +func (app *App) GetTestEvidenceKeeper() evidencekeeper.Keeper { + return app.EvidenceKeeper +} func (app *App) GetTestStakingKeeper() testutil.TestStakingKeeper { return app.StakingKeeper @@ -769,13 +769,13 @@ func (app *App) GetTestDistributionKeeper() testutil.TestDistributionKeeper { return app.DistrKeeper } -// func (app *App) GetTestMintKeeper() testutil.TestMintKeeper { -// return app.MintKeeper -// } +func (app *App) GetTestMintKeeper() mintkeeper.Keeper { + return app.MintKeeper +} -// func (app *App) GetTestGovKeeper() testutil.TestGovKeeper { -// return app.GovKeeper -// } +func (app *App) GetTestGovKeeper() govkeeper.Keeper { + return app.GovKeeper +} // TestingApp functions diff --git a/tests/integration/democracy.go b/tests/integration/democracy.go index edcbce532a..8b98e97dbe 100644 --- a/tests/integration/democracy.go +++ b/tests/integration/democracy.go @@ -10,6 +10,7 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" authtypes "github.com/cosmos/cosmos-sdk/x/auth/types" + govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper" govtypes "github.com/cosmos/cosmos-sdk/x/gov/types" govv1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1" minttypes "github.com/cosmos/cosmos-sdk/x/mint/types" @@ -159,9 +160,12 @@ func (s *ConsumerDemocracyTestSuite) TestDemocracyRewardsDistribution() { } } +// @MSalopek -> this is broken for v50 func (s *ConsumerDemocracyTestSuite) TestDemocracyGovernanceWhitelisting() { govKeeper := s.consumerApp.GetTestGovKeeper() - params := govKeeper.GetParams(s.consumerCtx()) + params, err := govKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) + stakingKeeper := s.consumerApp.GetTestStakingKeeper() bankKeeper := s.consumerApp.GetTestBankKeeper() accountKeeper := s.consumerApp.GetTestAccountKeeper() @@ -174,14 +178,15 @@ func (s *ConsumerDemocracyTestSuite) TestDemocracyGovernanceWhitelisting() { depositAmount := params.MinDeposit duration := (3 * time.Second) params.VotingPeriod = &duration - err = govKeeper.SetParams(s.consumerCtx(), params) + err = govKeeper.Params.Set(s.consumerCtx(), params) s.Assert().NoError(err) proposer := s.consumerChain.SenderAccount s.consumerChain.NextBlock() votersOldBalances := getAccountsBalances(s.consumerCtx(), bankKeeper, bondDenom, votingAccounts) // submit proposal with forbidden and allowed changes - mintParams := mintKeeper.GetParams(s.consumerCtx()) + mintParams, err := mintKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) mintParams.InflationMax = newMintParamValue msg_1 := &minttypes.MsgUpdateParams{ Authority: authtypes.NewModuleAddress(govtypes.ModuleName).String(), @@ -201,11 +206,15 @@ func (s *ConsumerDemocracyTestSuite) TestDemocracyGovernanceWhitelisting() { s.consumerChain.NextBlock() // at this moment, proposal is added, but not yet executed. we are saving old param values for comparison oldAuthParamValue := accountKeeper.GetParams(s.consumerCtx()).MaxMemoCharacters - oldMintParamValue := mintKeeper.GetParams(s.consumerCtx()).InflationMax + oldMintParams, err := mintKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) + oldMintParamValue := oldMintParams.InflationMax s.consumerChain.NextBlock() // at this moment, proposal is executed or deleted if forbidden currentAuthParamValue := accountKeeper.GetParams(s.consumerCtx()).MaxMemoCharacters - currentMintParamValue := mintKeeper.GetParams(s.consumerCtx()).InflationMax + currentMintParam, err := mintKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) + currentMintParamValue := currentMintParam.InflationMax // check that parameters are not changed, since the proposal contained both forbidden and allowed changes s.Assert().Equal(oldAuthParamValue, currentAuthParamValue) s.Assert().NotEqual(newAuthParamValue, currentAuthParamValue) @@ -219,9 +228,14 @@ func (s *ConsumerDemocracyTestSuite) TestDemocracyGovernanceWhitelisting() { s.Assert().NoError(err) s.consumerChain.CurrentHeader.Time = s.consumerChain.CurrentHeader.Time.Add(*params.VotingPeriod) s.consumerChain.NextBlock() - oldMintParamValue = mintKeeper.GetParams(s.consumerCtx()).InflationMax + oldMintParam, err := mintKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) + oldMintParamValue = oldMintParam.InflationMax s.consumerChain.NextBlock() - currentMintParamValue = mintKeeper.GetParams(s.consumerCtx()).InflationMax + currentMintParam, err = mintKeeper.Params.Get(s.consumerCtx()) + s.Require().NoError(err) + + currentMintParamValue = currentMintParam.InflationMax // check that parameters are changed, since the proposal contained only allowed changes s.Assert().Equal(newMintParamValue, currentMintParamValue) s.Assert().NotEqual(oldMintParamValue, currentMintParamValue) @@ -244,10 +258,10 @@ func (s *ConsumerDemocracyTestSuite) TestDemocracyGovernanceWhitelisting() { s.Assert().Equal(votersOldBalances, getAccountsBalances(s.consumerCtx(), bankKeeper, bondDenom, votingAccounts)) } -func submitProposalWithDepositAndVote(govKeeper testutil.TestGovKeeper, ctx sdk.Context, msgs []sdk.Msg, +func submitProposalWithDepositAndVote(govKeeper govkeeper.Keeper, ctx sdk.Context, msgs []sdk.Msg, accounts []ibctesting.SenderAccount, proposer sdk.AccAddress, depositAmount sdk.Coins, ) error { - proposal, err := govKeeper.SubmitProposal(ctx, msgs, "", "title", "summary", proposer) + proposal, err := govKeeper.SubmitProposal(ctx, msgs, "", "title", "summary", proposer, false) if err != nil { return err } diff --git a/tests/integration/setup.go b/tests/integration/setup.go index 351fd7148a..f3cc6ae7f7 100644 --- a/tests/integration/setup.go +++ b/tests/integration/setup.go @@ -334,7 +334,8 @@ func (s CCVTestSuite) validateEndpointsClientConfig(consumerBundle icstestinguti "unexpected unbonding period in consumer client state", ) - providerUnbondingPeriod := providerStakingKeeper.UnbondingTime(s.providerCtx()) + providerUnbondingPeriod, err := providerStakingKeeper.UnbondingTime(s.providerCtx()) + s.Require().NoError(err) cs, ok = consumerBundle.App.GetIBCKeeper().ClientKeeper.GetClientState( consumerBundle.GetCtx(), consumerBundle.Path.EndpointA.ClientID) s.Require().True(ok) diff --git a/testutil/ibc_testing/specific_setup.go b/testutil/ibc_testing/specific_setup.go index f1352c9cc8..f128f3c2fb 100644 --- a/testutil/ibc_testing/specific_setup.go +++ b/testutil/ibc_testing/specific_setup.go @@ -65,7 +65,7 @@ func ConsumerAppIniter(initValPowers []types.ValidatorUpdate) AppIniter { func DemocracyConsumerAppIniter(initValPowers []types.ValidatorUpdate) AppIniter { return func() (ibctesting.TestingApp, map[string]json.RawMessage) { encoding := appConsumerDemocracy.MakeTestEncodingConfig() - testApp := appConsumerDemocracy.New(log.NewNopLogger(), tmdb.NewMemDB(), nil, true, simtestutil.EmptyAppOptions{}) + testApp := appConsumerDemocracy.New(log.NewNopLogger(), db.NewMemDB(), nil, true, simtestutil.EmptyAppOptions{}) genesisState := appConsumerDemocracy.NewDefaultGenesisState(encoding.Codec) // Feed consumer genesis with provider validators // TODO See if useful for democracy diff --git a/testutil/integration/interfaces.go b/testutil/integration/interfaces.go index b3c51d09ca..13ef4b1d19 100644 --- a/testutil/integration/interfaces.go +++ b/testutil/integration/interfaces.go @@ -15,8 +15,8 @@ import ( sdk "github.com/cosmos/cosmos-sdk/types" authtypes "github.com/cosmos/cosmos-sdk/x/auth/types" distributiontypes "github.com/cosmos/cosmos-sdk/x/distribution/types" - govv1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1" - minttypes "github.com/cosmos/cosmos-sdk/x/mint/types" + govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper" + mintkeeper "github.com/cosmos/cosmos-sdk/x/mint/keeper" paramstypes "github.com/cosmos/cosmos-sdk/x/params/types" slashingtypes "github.com/cosmos/cosmos-sdk/x/slashing/types" stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types" @@ -79,9 +79,10 @@ type DemocConsumerApp interface { // Tests a staking keeper interface with more capabilities than the expected_keepers interface GetTestStakingKeeper() TestStakingKeeper // Tests a mint keeper interface with more capabilities than the expected_keepers interface - GetTestMintKeeper() TestMintKeeper - // Tests a gov keeper interface with more capabilities than the expected_keepers interface - GetTestGovKeeper() TestGovKeeper + GetTestMintKeeper() mintkeeper.Keeper + + // @MSalopek -> on v50 we need to access the Params collection which does not have a getter + GetTestGovKeeper() govkeeper.Keeper } // @@ -124,7 +125,6 @@ type TestAccountKeeper interface { type TestSlashingKeeper interface { ccvtypes.SlashingKeeper - IterateMissedBlockBitmap(ctx context.Context, addr sdk.ConsAddress, cb func(index int64, missed bool) (stop bool)) error SetValidatorSigningInfo(ctx context.Context, address sdk.ConsAddress, info slashingtypes.ValidatorSigningInfo) error SignedBlocksWindow(ctx context.Context) (int64, error) HandleValidatorSignature(ctx context.Context, addr cryptotypes.Address, power int64, signed comet.BlockIDFlag) error @@ -132,10 +132,7 @@ type TestSlashingKeeper interface { // NOTE: @MSalopek deprecated in v50 // IterateValidatorMissedBlockBitArray(ctx sdk.Context, // address sdk.ConsAddress, handler func(index int64, missed bool) (stop bool)) -} - -type TestEvidenceKeeper interface { - // HandleEquivocationEvidence(ctx sdk.Context, evidence *evidencetypes.Equivocation) + IterateMissedBlockBitmap(ctx context.Context, addr sdk.ConsAddress, cb func(index int64, missed bool) (stop bool)) error } type TestDistributionKeeper interface { @@ -145,15 +142,3 @@ type TestDistributionKeeper interface { GetValidatorOutstandingRewards(ctx context.Context, val sdk.ValAddress) (rewards distributiontypes.ValidatorOutstandingRewards, err error) GetCommunityTax(ctx context.Context) (math.LegacyDec, error) } - -type TestMintKeeper interface { - GetParams(ctx sdk.Context) (params minttypes.Params) -} - -type TestGovKeeper interface { - GetParams(ctx sdk.Context) govv1.Params - SetParams(ctx sdk.Context, params govv1.Params) error - SubmitProposal(ctx sdk.Context, messages []sdk.Msg, metadata, title, summary string, proposer sdk.AccAddress) (govv1.Proposal, error) - AddDeposit(ctx sdk.Context, proposalID uint64, depositorAddr sdk.AccAddress, depositAmount sdk.Coins) (bool, error) - AddVote(ctx sdk.Context, proposalID uint64, voterAddr sdk.AccAddress, options govv1.WeightedVoteOptions, metadata string) error -} diff --git a/testutil/simibc/README.md b/testutil/simibc/README.md deleted file mode 100644 index 14d342ebd9..0000000000 --- a/testutil/simibc/README.md +++ /dev/null @@ -1,19 +0,0 @@ -# simibc - -## What is this? - -A collection of utilities based on [ibc-go/testing](https://github.com/cosmos/ibc-go/tree/main/testing) which make it easier to write test scenarios involving precise orderings of - -- BeginBlock, EndBlock on each IBC connected chain -- Packet delivery -- Updating the client - -## Why is this useful? - -It is very hard to reason about tests written using vanilla [ibc-go/testing](https://github.com/cosmos/ibc-go/tree/main/testing) because the methods included in that library have many side effects. For example, that library has a notion of global time, so calling EndBlock on one chain will influence the future block times of another chain. As another example, sending a packet from chain A to B will automatically progress the block height on chain A. These behaviors make it very hard to understand, especially if your applications have business logic in BeginBlock or EndBlock. - -The utilities in simibc do not have any side effects, making it very easy to understand what is happening. It also makes it very easy to write data driven tests (like table tests, model based tests or property based tests). - -## How do I use this? - -Please see the function docstrings to get an idea of how you could use this package. This README is intentionally short because it is easier to maintain code and docstrings instead of markdown. diff --git a/testutil/simibc/ordered_outbox.go b/testutil/simibc/ordered_outbox.go deleted file mode 100644 index 2e2d9a9520..0000000000 --- a/testutil/simibc/ordered_outbox.go +++ /dev/null @@ -1,114 +0,0 @@ -package simibc - -import channeltypes "github.com/cosmos/ibc-go/v8/modules/core/04-channel/types" - -// Ack represents a (sent) ack committed to block state -type Ack struct { - Ack []byte - // The packet to which this ack is a response - Packet channeltypes.Packet - // The number of App.Commits that have occurred since this ack was sent - // For example, if the ack was sent at height h, and the blockchain - // has headers ..., h, h+1, h+2 then Commits = 3 - Commits int -} - -// Packet represents a (sent) packet committed to block state -type Packet struct { - Packet channeltypes.Packet - // The number of App.Commits that have occurred since this packet was sent - // For example, if the ack was sent at height h, and the blockchain - // has headers ..., h, h+1, h+2 then Commits = 3 - Commits int -} - -// OrderedOutbox is a collection of ORDERED packets and acks that have been sent -// by different chains, but have not yet been delivered to their target. -// The methods take care of bookkeeping, making it easier to simulate -// a real relayed IBC connection. -// -// Each sent packet or ack can be added here. When a sufficient number of -// block commits have followed each sent packet or ack, they can be consumed: -// delivered to their target. Since the sequences are ordered, this is useful -// for testing ORDERED ibc channels. -// -// NOTE: OrderedOutbox MAY be used independently of the rest of simibc. -type OrderedOutbox struct { - // An ordered sequence of packets from each sender - OutboxPackets map[string][]Packet - // An ordered sequence of acks from each sender - OutboxAcks map[string][]Ack -} - -// MakeOrderedOutbox creates a new empty OrderedOutbox. -func MakeOrderedOutbox() OrderedOutbox { - return OrderedOutbox{ - OutboxPackets: map[string][]Packet{}, - OutboxAcks: map[string][]Ack{}, - } -} - -// AddPacket adds an outbound packet from the sender. -func (n OrderedOutbox) AddPacket(sender string, packet channeltypes.Packet) { - n.OutboxPackets[sender] = append(n.OutboxPackets[sender], Packet{packet, 0}) -} - -// AddAck adds an outbound ack from the sender. The ack is a response to the packet. -func (n OrderedOutbox) AddAck(sender string, ack []byte, packet channeltypes.Packet) { - n.OutboxAcks[sender] = append(n.OutboxAcks[sender], Ack{ack, packet, 0}) -} - -// ConsumePackets returns the first num packets with 2 or more commits. Returned -// packets are removed from the outbox and will not be returned again (consumed). -func (n OrderedOutbox) ConsumePackets(sender string, num int) []Packet { - ret := []Packet{} - sz := len(n.OutboxPackets[sender]) - if sz < num { - num = sz - } - for _, p := range n.OutboxPackets[sender][:num] { - if 1 < p.Commits { - ret = append(ret, p) - } else { - break - } - } - n.OutboxPackets[sender] = n.OutboxPackets[sender][len(ret):] - return ret -} - -// ConsumerAcks returns the first num packets with 2 or more commits. Returned -// acks are removed from the outbox and will not be returned again (consumed). -func (n OrderedOutbox) ConsumeAcks(sender string, num int) []Ack { - ret := []Ack{} - sz := len(n.OutboxAcks[sender]) - if sz < num { - num = sz - } - for _, a := range n.OutboxAcks[sender][:num] { - if 1 < a.Commits { - ret = append(ret, a) - } else { - break - } - } - n.OutboxAcks[sender] = n.OutboxAcks[sender][len(ret):] - return ret -} - -// Commit marks a block commit, increasing the commit count for all -// packets and acks in the sender's outbox. -// When a packet or ack has 2 or more commits, it is available for -// delivery to the counterparty chain. -// Note that 2 commits are necessary instead of 1: -// - 1st commit is necessary for the packet to included in the block -// - 2nd commit is necessary because in practice the ibc light client -// needs to have block h + 1 to be able to verify the packet in block h. -func (n OrderedOutbox) Commit(sender string) { - for i := range n.OutboxPackets[sender] { - n.OutboxPackets[sender][i].Commits += 1 - } - for i := range n.OutboxAcks[sender] { - n.OutboxAcks[sender][i].Commits += 1 - } -} diff --git a/testutil/simibc/relay_util.go b/testutil/simibc/relay_util.go deleted file mode 100644 index 072a80e501..0000000000 --- a/testutil/simibc/relay_util.go +++ /dev/null @@ -1,179 +0,0 @@ -package simibc - -import ( - clienttypes "github.com/cosmos/ibc-go/v8/modules/core/02-client/types" - channeltypes "github.com/cosmos/ibc-go/v8/modules/core/04-channel/types" - host "github.com/cosmos/ibc-go/v8/modules/core/24-host" - ibctmtypes "github.com/cosmos/ibc-go/v8/modules/light-clients/07-tendermint" - ibctesting "github.com/cosmos/ibc-go/v8/testing" - simapp "github.com/cosmos/ibc-go/v8/testing/simapp" - "github.com/stretchr/testify/require" - - errorsmod "cosmossdk.io/errors" - - sdk "github.com/cosmos/cosmos-sdk/types" - - tmtypes "github.com/cometbft/cometbft/types" -) - -// UpdateReceiverClient DELIVERs a header to the receiving endpoint -// and update the respective client of the receiving chain. -// -// The header is a header of the sender chain. The receiver chain -// must have a client of the sender chain that it can update. -// -// NOTE: this function MAY be used independently of the rest of simibc. -func UpdateReceiverClient(sender, receiver *ibctesting.Endpoint, header *ibctmtypes.Header) (err error) { - err = augmentHeader(sender.Chain, receiver.Chain, receiver.ClientID, header) - - if err != nil { - return err - } - - msg, err := clienttypes.NewMsgUpdateClient( - receiver.ClientID, header, - receiver.Chain.SenderAccount.GetAddress().String(), - ) - - require.NoError(receiver.Chain.T, err) - - _, _, err = simapp.SignAndDeliver( - receiver.Chain.T, - receiver.Chain.TxConfig, - receiver.Chain.App.GetBaseApp(), - receiver.Chain.GetContext().BlockHeader(), - []sdk.Msg{msg}, - receiver.Chain.ChainID, - []uint64{receiver.Chain.SenderAccount.GetAccountNumber()}, - []uint64{receiver.Chain.SenderAccount.GetSequence()}, - true, true, receiver.Chain.SenderPrivKey, - ) - - if err != nil { - return err - } - - err = receiver.Chain.SenderAccount.SetSequence(receiver.Chain.SenderAccount.GetSequence() + 1) - - if err != nil { - return err - } - - return nil -} - -// TryRecvPacket will try once to DELIVER a packet from sender to receiver. If successful, -// it will return the acknowledgement bytes. -// -// The packet must be sent from the sender chain to the receiver chain, and the -// receiver chain must have a client for the sender chain which has been updated -// to a recent height of the sender chain so that it can verify the packet. -func TryRecvPacket(sender, receiver *ibctesting.Endpoint, packet channeltypes.Packet) (ack []byte, err error) { - packetKey := host.PacketCommitmentKey(packet.GetSourcePort(), packet.GetSourceChannel(), packet.GetSequence()) - proof, proofHeight := sender.Chain.QueryProof(packetKey) - - RPmsg := channeltypes.NewMsgRecvPacket(packet, proof, proofHeight, receiver.Chain.SenderAccount.GetAddress().String()) - - _, resWithAck, err := simapp.SignAndDeliver( - receiver.Chain.T, - receiver.Chain.TxConfig, - receiver.Chain.App.GetBaseApp(), - receiver.Chain.GetContext().BlockHeader(), - []sdk.Msg{RPmsg}, - receiver.Chain.ChainID, - []uint64{receiver.Chain.SenderAccount.GetAccountNumber()}, - []uint64{receiver.Chain.SenderAccount.GetSequence()}, - true, true, receiver.Chain.SenderPrivKey, - ) - if err != nil { - return nil, err - } - - err = receiver.Chain.SenderAccount.SetSequence(receiver.Chain.SenderAccount.GetSequence() + 1) - - if err != nil { - return nil, err - } - - ack, err = ibctesting.ParseAckFromEvents(resWithAck.GetEvents()) - - if err != nil { - return nil, err - } - - return ack, nil -} - -// TryRecvAck will try once to DELIVER an ack from sender to receiver. -// -// The ack must have been sent from the sender to the receiver, in response -// to packet which was previously delivered from the receiver to the sender. -// The receiver chain must have a client for the sender chain which has been -// updated to a recent height of the sender chain so that it can verify the packet. -func TryRecvAck(sender, receiver *ibctesting.Endpoint, packet channeltypes.Packet, ack []byte) (err error) { - p := packet - packetKey := host.PacketAcknowledgementKey(p.GetDestPort(), p.GetDestChannel(), p.GetSequence()) - proof, proofHeight := sender.Chain.QueryProof(packetKey) - - ackMsg := channeltypes.NewMsgAcknowledgement(p, ack, proof, proofHeight, receiver.Chain.SenderAccount.GetAddress().String()) - - _, _, err = simapp.SignAndDeliver( - receiver.Chain.T, - receiver.Chain.TxConfig, - receiver.Chain.App.GetBaseApp(), - receiver.Chain.GetContext().BlockHeader(), - []sdk.Msg{ackMsg}, - receiver.Chain.ChainID, - []uint64{receiver.Chain.SenderAccount.GetAccountNumber()}, - []uint64{receiver.Chain.SenderAccount.GetSequence()}, - true, true, receiver.Chain.SenderPrivKey, - ) - - if err != nil { - return err - } - - err = receiver.Chain.SenderAccount.SetSequence(receiver.Chain.SenderAccount.GetSequence() + 1) - - if err != nil { - return err - } - - return nil -} - -// augmentHeader is a helper that augments the header with the height and validators that are most recently trusted -// by the receiver chain. If there is an error, the header will not be modified. -func augmentHeader(sender, receiver *ibctesting.TestChain, clientID string, header *ibctmtypes.Header) error { - trustedHeight := receiver.GetClientState(clientID).GetLatestHeight().(clienttypes.Height) - - var ( - tmTrustedVals *tmtypes.ValidatorSet - ok bool - ) - // Once we get TrustedHeight from client, we must query the validators from the counterparty chain - // If the LatestHeight == LastHeader.Height, then TrustedValidators are current validators - // If LatestHeight < LastHeader.Height, we can query the historical validator set from HistoricalInfo - if trustedHeight == sender.LastHeader.GetHeight() { - tmTrustedVals = sender.Vals - } else { - // NOTE: We need to get validators from counterparty at height: trustedHeight+1 - // since the last trusted validators for a header at height h - // is the NextValidators at h+1 committed to in header h by - // NextValidatorsHash - tmTrustedVals, ok = sender.GetValsAtHeight(int64(trustedHeight.RevisionHeight + 1)) - if !ok { - return errorsmod.Wrapf(ibctmtypes.ErrInvalidHeaderHeight, "could not retrieve trusted validators at trustedHeight: %d", trustedHeight) - } - } - trustedVals, err := tmTrustedVals.ToProto() - if err != nil { - return err - } - // inject trusted fields into last header - // for now assume revision number is 0 - header.TrustedHeight = trustedHeight - header.TrustedValidators = trustedVals - - return nil -} diff --git a/testutil/simibc/relayed_path.go b/testutil/simibc/relayed_path.go deleted file mode 100644 index a59c8014ed..0000000000 --- a/testutil/simibc/relayed_path.go +++ /dev/null @@ -1,153 +0,0 @@ -package simibc - -import ( - "testing" - "time" - - ibctmtypes "github.com/cosmos/ibc-go/v8/modules/light-clients/07-tendermint" - ibctesting "github.com/cosmos/ibc-go/v8/testing" -) - -// RelayedPath is a wrapper around ibctesting.Path gives fine-grained -// control over delivery packets and acks, and client updates. Specifically, -// the path represents a bidirectional ORDERED channel between two chains. -// It is possible to control the precise order that packets and acks are -// delivered, and the precise independent and relative order and timing of -// new blocks on each chain. -type RelayedPath struct { - t *testing.T - path *ibctesting.Path - // clientHeaders is a map from chainID to an ordered list of headers that - // have been committed to that chain. The headers are used to update the - // client of the counterparty chain. - clientHeaders map[string][]*ibctmtypes.Header - // TODO: Make this private and expose methods to add packets and acks. - // Currently, packets and acks are added directly to the outboxes, - // but we should hide this implementation detail. - Outboxes OrderedOutbox -} - -// MakeRelayedPath returns an initialized RelayedPath without any -// packets, acks or headers. Requires a fully initialised path where -// the connection and any channel handshakes have been COMPLETED. -func MakeRelayedPath(t *testing.T, path *ibctesting.Path) RelayedPath { - t.Helper() - return RelayedPath{ - t: t, - clientHeaders: map[string][]*ibctmtypes.Header{}, - path: path, - Outboxes: MakeOrderedOutbox(), - } -} - -// Chain returns the chain with chainID -func (f *RelayedPath) Chain(chainID string) *ibctesting.TestChain { - if f.path.EndpointA.Chain.ChainID == chainID { - return f.path.EndpointA.Chain - } - if f.path.EndpointB.Chain.ChainID == chainID { - return f.path.EndpointB.Chain - } - f.t.Fatal("no chain found in relayed path with chainID: ", chainID) - return nil -} - -// UpdateClient updates the chain with the latest sequence -// of available headers committed by the counterparty chain since -// the last call to UpdateClient (or all for the first call). -func (f *RelayedPath) UpdateClient(chainID string) { - for _, header := range f.clientHeaders[f.counterparty(chainID)] { - err := UpdateReceiverClient(f.endpoint(f.counterparty(chainID)), f.endpoint(chainID), header) - if err != nil { - f.t.Fatal("in relayed path could not update client of chain: ", chainID, " with header: ", header, " err: ", err) - } - } - f.clientHeaders[f.counterparty(chainID)] = []*ibctmtypes.Header{} -} - -// DeliverPackets delivers UP TO packets to the chain which have been -// sent to it by the counterparty chain and are ready to be delivered. -// -// A packet is ready to be delivered if the sender chain has progressed -// a sufficient number of blocks since the packet was sent. This is because -// all sent packets must be committed to block state before they can be queried. -// Additionally, in practice, light clients require a header (h+1) to deliver a -// packet sent in header h. -// -// In order to deliver packets, the chain must have an up-to-date client -// of the counterparty chain. Ie. UpdateClient should be called before this. -func (f *RelayedPath) DeliverPackets(chainID string, num int) { - for _, p := range f.Outboxes.ConsumePackets(f.counterparty(chainID), num) { - ack, err := TryRecvPacket(f.endpoint(f.counterparty(chainID)), f.endpoint(chainID), p.Packet) - if err != nil { - f.t.Fatal("deliver") - } - f.Outboxes.AddAck(chainID, ack, p.Packet) - } -} - -// DeliverPackets delivers UP TO acks to the chain which have been -// sent to it by the counterparty chain and are ready to be delivered. -// -// An ack is ready to be delivered if the sender chain has progressed -// a sufficient number of blocks since the ack was sent. This is because -// all sent acks must be committed to block state before they can be queried. -// Additionally, in practice, light clients require a header (h+1) to deliver -// an ack sent in header h. -// -// In order to deliver acks, the chain must have an up-to-date client -// of the counterparty chain. Ie. UpdateClient should be called before this. -func (f *RelayedPath) DeliverAcks(chainID string, num int) { - for _, ack := range f.Outboxes.ConsumeAcks(f.counterparty(chainID), num) { - err := TryRecvAck(f.endpoint(f.counterparty(chainID)), f.endpoint(chainID), ack.Packet, ack.Ack) - if err != nil { - f.t.Fatal("deliverAcks") - } - } -} - -// EndAndBeginBlock calls EndBlock and commits block state, storing the header which can later -// be used to update the client on the counterparty chain. After committing, the chain local -// time progresses by dt, and BeginBlock is called with a header timestamped for the new time. -// -// preCommitCallback is called after EndBlock and before Commit, allowing arbitrary access to -// the sdk.Context after EndBlock. The callback is useful for testing purposes to execute -// arbitrary code before the chain sdk context is cleared in .Commit(). -// For example, app.EndBlock may lead to a new state, which you would like to query -// to check that it is correct. However, the sdk context is cleared after .Commit(), -// so you can query the state inside the callback. -func (f *RelayedPath) EndAndBeginBlock(chainID string, dt time.Duration, preCommitCallback func()) { - c := f.Chain(chainID) - - header, packets := EndBlock(c, preCommitCallback) - f.clientHeaders[chainID] = append(f.clientHeaders[chainID], header) - for _, p := range packets { - f.Outboxes.AddPacket(chainID, p) - } - f.Outboxes.Commit(chainID) - BeginBlock(c, dt) -} - -// counterparty is a helper returning the counterparty chainID -func (f *RelayedPath) counterparty(chainID string) string { - if f.path.EndpointA.Chain.ChainID == chainID { - return f.path.EndpointB.Chain.ChainID - } - if f.path.EndpointB.Chain.ChainID == chainID { - return f.path.EndpointA.Chain.ChainID - } - f.t.Fatal("no chain found in relayed path with chainID: ", chainID) - return "" -} - -// endpoint is a helper returning the endpoint for the chain -func (f *RelayedPath) endpoint(chainID string) *ibctesting.Endpoint { - if chainID == f.path.EndpointA.Chain.ChainID { - return f.path.EndpointA - } - if chainID == f.path.EndpointB.Chain.ChainID { - return f.path.EndpointB - } - f.t.Fatal("no chain found in relayed path with chainID: ", chainID) - return nil -}