ibctesting: custom voting power reduction for testing

CHANGELOG.md

@@ -43,7 +43,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (core) [\#709](https://github.com/cosmos/ibc-go/pull/709) Replace github.com/pkg/errors with stdlib errors
 
 ### API Breaking
-
+
+* (testing) [\#939](https://github.com/cosmos/ibc-go/pull/939) Support custom power reduction for testing.
 * (channel) [\#848](https://github.com/cosmos/ibc-go/pull/848) Added `ChannelId` to MsgChannelOpenInitResponse
 * (testing) [\#813](https://github.com/cosmos/ibc-go/pull/813) The `ack` argument to the testing function `RelayPacket` has been removed as it is no longer needed.
 * (testing) [\#774](https://github.com/cosmos/ibc-go/pull/774) Added `ChainID` arg to `SetupWithGenesisValSet` on the testing app. `Coordinator` generated ChainIDs now starts at index 1

testing/app.go

@@ -58,16 +58,20 @@ func SetupTestingApp() (TestingApp, map[string]json.RawMessage) {
 // that also act as delegators. For simplicity, each validator is bonded with a delegation
 // of one consensus engine unit (10^6) in the default token of the simapp from first genesis
 // account. A Nop logger is set in SimApp.
-func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, chainID string, balances ...banktypes.Balance) TestingApp {
+func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs []authtypes.GenesisAccount, chainID string, powerReduction sdk.Int, balances ...banktypes.Balance) TestingApp {
 	app, genesisState := DefaultTestingAppInit()
+
 	// set genesis accounts
-	authGenesis := authtypes.NewGenesisState(authtypes.DefaultParams(), genAccs)
+	var authGenesis *authtypes.GenesisState
+	app.AppCodec().MustUnmarshalJSON(genesisState[authtypes.ModuleName], authGenesis)
+
+	authGenesis = authtypes.NewGenesisState(authGenesis.Params, genAccs)
 	genesisState[authtypes.ModuleName] = app.AppCodec().MustMarshalJSON(authGenesis)
 
 	validators := make([]stakingtypes.Validator, 0, len(valSet.Validators))
 	delegations := make([]stakingtypes.Delegation, 0, len(valSet.Validators))
 
-	bondAmt := sdk.NewInt(1000000)
+	bondAmt := sdk.TokensFromConsensusPower(1, powerReduction)
 
 	for _, val := range valSet.Validators {
 		pk, err := cryptocodec.FromTmPubKeyInterface(val.PubKey)
@@ -87,24 +91,36 @@ func SetupWithGenesisValSet(t *testing.T, valSet *tmtypes.ValidatorSet, genAccs
 			Commission:        stakingtypes.NewCommission(sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec()),
 			MinSelfDelegation: sdk.ZeroInt(),
 		}
+
 		validators = append(validators, validator)
 		delegations = append(delegations, stakingtypes.NewDelegation(genAccs[0].GetAddress(), val.Address.Bytes(), sdk.OneDec()))
 	}
 
+	// set validators and delegations
+	var stakingGenesis stakingtypes.GenesisState
+	app.AppCodec().MustUnmarshalJSON(genesisState[stakingtypes.ModuleName], &stakingGenesis)
+
+	stakingGenesis.Validators = validators
+	stakingGenesis.Delegations = delegations
+
+	bondDenom := stakingGenesis.Params.BondDenom
+
+	// set validators and delegations
+	genesisState[stakingtypes.ModuleName] = app.AppCodec().MustMarshalJSON(&stakingGenesis)
+
 	totalSupply := sdk.NewCoins()
 
 	// add bonded amount to bonded pool module account
 	balances = append(balances, banktypes.Balance{
 		Address: authtypes.NewModuleAddress(stakingtypes.BondedPoolName).String(),
-		Coins:   sdk.Coins{sdk.NewCoin(sdk.DefaultBondDenom, bondAmt.Mul(sdk.NewInt(int64(len(valSet.Validators)))))},
+		Coins:   sdk.Coins{sdk.NewCoin(bondDenom, bondAmt.Mul(sdk.NewInt(int64(len(valSet.Validators)))))},
 	})
 
-	// set validators and delegations
-	stakingGenesis := stakingtypes.NewGenesisState(stakingtypes.DefaultParams(), validators, delegations)
-	genesisState[stakingtypes.ModuleName] = app.AppCodec().MustMarshalJSON(stakingGenesis)
-
 	// update total supply
-	bankGenesis := banktypes.NewGenesisState(banktypes.DefaultGenesisState().Params, balances, totalSupply, []banktypes.Metadata{})
+	var bankGenesis *banktypes.GenesisState
+	app.AppCodec().MustUnmarshalJSON(genesisState[banktypes.ModuleName], bankGenesis)
+
+	bankGenesis = banktypes.NewGenesisState(bankGenesis.Params, balances, totalSupply, []banktypes.Metadata{})
 	genesisState[banktypes.ModuleName] = app.AppCodec().MustMarshalJSON(bankGenesis)
 
 	stateBytes, err := json.MarshalIndent(genesisState, "", " ")

testing/chain.go

@@ -36,9 +36,7 @@ import (
 	"github.com/cosmos/ibc-go/v3/testing/simapp"
 )
 
-var (
-	MaxAccounts = 10
-)
+var MaxAccounts = 10
 
 type SenderAccount struct {
 	SenderPrivKey cryptotypes.PrivKey
@@ -51,7 +49,7 @@ type SenderAccount struct {
 // is used for delivering transactions through the application state.
 // NOTE: the actual application uses an empty chain-id for ease of testing.
 type TestChain struct {
-	t *testing.T
+	*testing.T
 
 	Coordinator   *Coordinator
 	App           TestingApp
@@ -88,7 +86,6 @@ type TestChain struct {
 // CONTRACT: Validator and signer array must be provided in the order expected by Tendermint.
 // i.e. sorted first by power and then lexicographically by address.
 func NewTestChainWithValSet(t *testing.T, coord *Coordinator, chainID string, valSet *tmtypes.ValidatorSet, signers []tmtypes.PrivValidator) *TestChain {
-
 	genAccs := []authtypes.GenesisAccount{}
 	genBals := []banktypes.Balance{}
 	senderAccs := []SenderAccount{}
@@ -116,7 +113,7 @@ func NewTestChainWithValSet(t *testing.T, coord *Coordinator, chainID string, va
 		senderAccs = append(senderAccs, senderAcc)
 	}
 
-	app := SetupWithGenesisValSet(t, valSet, genAccs, chainID, genBals...)
+	app := SetupWithGenesisValSet(t, valSet, genAccs, chainID, sdk.DefaultPowerReduction, genBals...)
 
 	// create current header and call begin block
 	header := tmproto.Header{
@@ -129,7 +126,7 @@ func NewTestChainWithValSet(t *testing.T, coord *Coordinator, chainID string, va
 
 	// create an account to send transactions from
 	chain := &TestChain{
-		t:              t,
+		T:              t,
 		Coordinator:    coord,
 		ChainID:        chainID,
 		App:            app,
@@ -191,7 +188,7 @@ func (chain *TestChain) GetContext() sdk.Context {
 // their own SimApp.
 func (chain *TestChain) GetSimApp() *simapp.SimApp {
 	app, ok := chain.App.(*simapp.SimApp)
-	require.True(chain.t, ok)
+	require.True(chain.T, ok)
 
 	return app
 }
@@ -213,10 +210,10 @@ func (chain *TestChain) QueryProofAtHeight(key []byte, height int64) ([]byte, cl
 	})
 
 	merkleProof, err := commitmenttypes.ConvertProofs(res.ProofOps)
-	require.NoError(chain.t, err)
+	require.NoError(chain.T, err)
 
 	proof, err := chain.App.AppCodec().Marshal(&merkleProof)
-	require.NoError(chain.t, err)
+	require.NoError(chain.T, err)
 
 	revision := clienttypes.ParseChainID(chain.ChainID)
 
@@ -237,10 +234,10 @@ func (chain *TestChain) QueryUpgradeProof(key []byte, height uint64) ([]byte, cl
 	})
 
 	merkleProof, err := commitmenttypes.ConvertProofs(res.ProofOps)
-	require.NoError(chain.t, err)
+	require.NoError(chain.T, err)
 
 	proof, err := chain.App.AppCodec().Marshal(&merkleProof)
-	require.NoError(chain.t, err)
+	require.NoError(chain.T, err)
 
 	revision := clienttypes.ParseChainID(chain.ChainID)
 
@@ -300,7 +297,7 @@ func (chain *TestChain) SendMsgs(msgs ...sdk.Msg) (*sdk.Result, error) {
 	chain.Coordinator.UpdateTimeForChain(chain)
 
 	_, r, err := simapp.SignAndDeliver(
-		chain.t,
+		chain.T,
 		chain.TxConfig,
 		chain.App.GetBaseApp(),
 		chain.GetContext().BlockHeader(),
@@ -329,7 +326,7 @@ func (chain *TestChain) SendMsgs(msgs ...sdk.Msg) (*sdk.Result, error) {
 // expected to exist otherwise testing will fail.
 func (chain *TestChain) GetClientState(clientID string) exported.ClientState {
 	clientState, found := chain.App.GetIBCKeeper().ClientKeeper.GetClientState(chain.GetContext(), clientID)
-	require.True(chain.t, found)
+	require.True(chain.T, found)
 
 	return clientState
 }
@@ -361,7 +358,7 @@ func (chain *TestChain) GetValsAtHeight(height int64) (*tmtypes.ValidatorSet, bo
 // acknowledgement does not exist then testing will fail.
 func (chain *TestChain) GetAcknowledgement(packet exported.PacketI) []byte {
 	ack, found := chain.App.GetIBCKeeper().ChannelKeeper.GetPacketAcknowledgement(chain.GetContext(), packet.GetDestPort(), packet.GetDestChannel(), packet.GetSequence())
-	require.True(chain.t, found)
+	require.True(chain.T, found)
 
 	return ack
 }
@@ -436,7 +433,8 @@ func (chain *TestChain) CreateTMClientHeader(chainID string, blockHeight int64,
 		valSet      *tmproto.ValidatorSet
 		trustedVals *tmproto.ValidatorSet
 	)
-	require.NotNil(chain.t, tmValSet)
+	require.NotNil(chain.T, tmValSet)
+	require.NotNil(chain.T, tmTrustedVals)
 
 	vsetHash := tmValSet.Hash()
 
@@ -461,25 +459,21 @@ func (chain *TestChain) CreateTMClientHeader(chainID string, blockHeight int64,
 	voteSet := tmtypes.NewVoteSet(chainID, blockHeight, 1, tmproto.PrecommitType, tmValSet)
 
 	commit, err := tmtypes.MakeCommit(blockID, blockHeight, 1, voteSet, signers, timestamp)
-	require.NoError(chain.t, err)
+	require.NoError(chain.T, err)
 
 	signedHeader := &tmproto.SignedHeader{
 		Header: tmHeader.ToProto(),
 		Commit: commit.ToProto(),
 	}
 
-	if tmValSet != nil {
-		valSet, err = tmValSet.ToProto()
-		if err != nil {
-			panic(err)
-		}
+	valSet, err = tmValSet.ToProto()
+	if err != nil {
+		panic(err)
 	}
 
-	if tmTrustedVals != nil {
-		trustedVals, err = tmTrustedVals.ToProto()
-		if err != nil {
-			panic(err)
-		}
+	trustedVals, err = tmTrustedVals.ToProto()
+	if err != nil {
+		panic(err)
 	}
 
 	// The trusted fields may be nil. They may be filled before relaying messages to a client.
@@ -533,11 +527,11 @@ func (chain *TestChain) CreatePortCapability(scopedKeeper capabilitykeeper.Scope
 	if !ok {
 		// create capability using the IBC capability keeper
 		cap, err := chain.App.GetScopedIBCKeeper().NewCapability(chain.GetContext(), host.PortPath(portID))
-		require.NoError(chain.t, err)
+		require.NoError(chain.T, err)
 
 		// claim capability using the scopedKeeper
 		err = scopedKeeper.ClaimCapability(chain.GetContext(), cap, host.PortPath(portID))
-		require.NoError(chain.t, err)
+		require.NoError(chain.T, err)
 	}
 
 	chain.App.Commit()
@@ -549,7 +543,7 @@ func (chain *TestChain) CreatePortCapability(scopedKeeper capabilitykeeper.Scope
 // exist, otherwise testing will fail.
 func (chain *TestChain) GetPortCapability(portID string) *capabilitytypes.Capability {
 	cap, ok := chain.App.GetScopedIBCKeeper().GetCapability(chain.GetContext(), host.PortPath(portID))
-	require.True(chain.t, ok)
+	require.True(chain.T, ok)
 
 	return cap
 }
@@ -563,9 +557,9 @@ func (chain *TestChain) CreateChannelCapability(scopedKeeper capabilitykeeper.Sc
 	_, ok := chain.App.GetScopedIBCKeeper().GetCapability(chain.GetContext(), capName)
 	if !ok {
 		cap, err := chain.App.GetScopedIBCKeeper().NewCapability(chain.GetContext(), capName)
-		require.NoError(chain.t, err)
+		require.NoError(chain.T, err)
 		err = scopedKeeper.ClaimCapability(chain.GetContext(), cap, capName)
-		require.NoError(chain.t, err)
+		require.NoError(chain.T, err)
 	}
 
 	chain.App.Commit()
@@ -577,7 +571,7 @@ func (chain *TestChain) CreateChannelCapability(scopedKeeper capabilitykeeper.Sc
 // The capability must exist, otherwise testing will fail.
 func (chain *TestChain) GetChannelCapability(portID, channelID string) *capabilitytypes.Capability {
 	cap, ok := chain.App.GetScopedIBCKeeper().GetCapability(chain.GetContext(), host.ChannelCapabilityPath(portID, channelID))
-	require.True(chain.t, ok)
+	require.True(chain.T, ok)
 
 	return cap
 }

testing/coordinator.go

@@ -19,7 +19,7 @@ var (
 // Coordinator is a testing struct which contains N TestChain's. It handles keeping all chains
 // in sync with regards to time.
 type Coordinator struct {
-	t *testing.T
+	*testing.T
 
 	CurrentTime time.Time
 	Chains      map[string]*TestChain
@@ -29,7 +29,7 @@ type Coordinator struct {
 func NewCoordinator(t *testing.T, n int) *Coordinator {
 	chains := make(map[string]*TestChain)
 	coord := &Coordinator{
-		t:           t,
+		T:           t,
 		CurrentTime: globalStartTime,
 	}
 
@@ -84,10 +84,10 @@ func (coord *Coordinator) Setup(path *Path) {
 // caller does not anticipate any errors.
 func (coord *Coordinator) SetupClients(path *Path) {
 	err := path.EndpointA.CreateClient()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointB.CreateClient()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 }
 
 // SetupClientConnections is a helper function to create clients and the appropriate
@@ -105,19 +105,20 @@ func (coord *Coordinator) SetupConnections(path *Path) {
 // successfully opened otherwise testing will fail.
 func (coord *Coordinator) CreateConnections(path *Path) {
 	err := path.EndpointA.ConnOpenInit()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointB.ConnOpenTry()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointA.ConnOpenAck()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointB.ConnOpenConfirm()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	// ensure counterparty is up to date
-	path.EndpointA.UpdateClient()
+	err = path.EndpointA.UpdateClient()
+	require.NoError(coord.T, err)
 }
 
 // CreateMockChannels constructs and executes channel handshake messages to create OPEN
@@ -146,26 +147,27 @@ func (coord *Coordinator) CreateTransferChannels(path *Path) {
 // opened otherwise testing will fail.
 func (coord *Coordinator) CreateChannels(path *Path) {
 	err := path.EndpointA.ChanOpenInit()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointB.ChanOpenTry()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointA.ChanOpenAck()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	err = path.EndpointB.ChanOpenConfirm()
-	require.NoError(coord.t, err)
+	require.NoError(coord.T, err)
 
 	// ensure counterparty is up to date
-	path.EndpointA.UpdateClient()
+	err = path.EndpointA.UpdateClient()
+	require.NoError(coord.T, err)
 }
 
 // GetChain returns the TestChain using the given chainID and returns an error if it does
 // not exist.
 func (coord *Coordinator) GetChain(chainID string) *TestChain {
 	chain, found := coord.Chains[chainID]
-	require.True(coord.t, found, fmt.Sprintf("%s chain does not exist", chainID))
+	require.True(coord.T, found, fmt.Sprintf("%s chain does not exist", chainID))
 	return chain
 }
 
@@ -210,11 +212,7 @@ func (coord *Coordinator) ConnOpenInitOnBothChains(path *Path) error {
 		return err
 	}
 
-	if err := path.EndpointB.UpdateClient(); err != nil {
-		return err
-	}
-
-	return nil
+	return path.EndpointB.UpdateClient()
 }
 
 // ChanOpenInitOnBothChains initializes a channel on the source chain and counterparty chain
@@ -235,9 +233,5 @@ func (coord *Coordinator) ChanOpenInitOnBothChains(path *Path) error {
 		return err
 	}
 
-	if err := path.EndpointB.UpdateClient(); err != nil {
-		return err
-	}
-
-	return nil
+	return path.EndpointB.UpdateClient()
 }