Update #264 - updates genesis and genesis tests #382
There are no files selected for viewing
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,6 +15,11 @@ import ( | |
| ) | ||
|
|
||
| // InitGenesis initializes the CCV consumer state and binds to PortID. | ||
| // The three states in which a consumer chain can start/restart: | ||
| // | ||
| // 1. A client to the provider was never created, i.e. a new consumer chain is started for the first time. | ||
| // 2. A consumer chain restarts after a client to the provider was created, but the CCV channel handshake is still in progress | ||
| // 3. A consumer chain restarts after the CCV channel handshake was completed. | ||
| func (k Keeper) InitGenesis(ctx sdk.Context, state *consumertypes.GenesisState) []abci.ValidatorUpdate { | ||
| k.SetParams(ctx, state.Params) | ||
| // TODO: Remove enabled flag and find a better way to setup e2e tests | ||
|
|
@@ -37,39 +42,51 @@ func (k Keeper) InitGenesis(ctx sdk.Context, state *consumertypes.GenesisState) | |
| } | ||
|
|
||
| // initialValSet is checked in NewChain case by ValidateGenesis | ||
| // start a new chain | ||
| if state.NewChain { | ||
| // create the provider client in InitGenesis for new consumer chain. CCV Handshake must be established with this client id. | ||
| clientID, err := k.clientKeeper.CreateClient(ctx, state.ProviderClientState, state.ProviderConsensusState) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
|
|
||
| // set provider client id. | ||
| k.SetProviderClientID(ctx, clientID) | ||
|
|
||
|
There was a problem hiding this comment. Why the switch? Were they not working in the other order? |
||
| // set default value for valset update ID | ||
| k.SetHeightValsetUpdateID(ctx, uint64(ctx.BlockHeight()), uint64(0)) | ||
| } else { | ||
| // verify genesis initial valset against the latest consensus state | ||
| // IBC genesis MUST run before CCV consumer genesis | ||
| if err := k.verifyGenesisInitValset(ctx, state); err != nil { | ||
| panic(err) | ||
| } | ||
| // chain restarts without the CCV channel established | ||
| if state.ProviderChannelId == "" { | ||
| k.SetPendingSlashRequests(ctx, state.PendingSlashRequests) | ||
|
|
||
| // chain restarts with the CCV channel established | ||
| } else { | ||
|
There was a problem hiding this comment. So i guess you don't even have to deal with the case where the handshake is in progress because it will just take care of itself? There was a problem hiding this comment. This case is detected when the channelID is empty and only these states are getting populated: interchain-security/x/ccv/consumer/keeper/genesis.go Lines 64 to 67 in 26ec9e8 interchain-security/x/ccv/consumer/keeper/genesis.go Lines 92 to 103 in 26ec9e8 Note that the client to the provider is already created and imported by the IBC module genesis in this case. |
||
| // set provider channel ID | ||
| k.SetProviderChannel(ctx, state.ProviderChannelId) | ||
| // set all unbonding sequences | ||
| for _, mp := range state.MaturingPackets { | ||
| k.SetPacketMaturityTime(ctx, mp.VscId, mp.MaturityTime) | ||
| } | ||
| // set outstanding downtime slashing requests | ||
| for _, od := range state.OutstandingDowntimeSlashing { | ||
| consAddr, err := sdk.ConsAddressFromBech32(od.ValidatorConsensusAddress) | ||
| if err != nil { | ||
| panic(err) | ||
| } | ||
| k.SetOutstandingDowntime(ctx, consAddr) | ||
| } | ||
| // set last transmission block height | ||
| err := k.SetLastTransmissionBlockHeight(ctx, state.LastTransmissionBlockHeight) | ||
|
Comment on lines
+82
to
+83
There was a problem hiding this comment. Does this code work for a zero height restart? Does it even need to work for a zero height restart? note sure... |
||
| if err != nil { | ||
| panic(fmt.Sprintf("could not set last transmission block height: %v", err)) | ||
| } | ||
|
|
||
| } | ||
|
|
||
| // set height to valset update id mapping | ||
|
|
@@ -79,12 +96,7 @@ func (k Keeper) InitGenesis(ctx sdk.Context, state *consumertypes.GenesisState) | |
|
|
||
| // set provider client id | ||
| k.SetProviderClientID(ctx, state.ProviderClientId) | ||
|
|
||
| } | ||
|
|
||
| // populate cross chain validators states with initial valset | ||
|
|
@@ -93,16 +105,15 @@ func (k Keeper) InitGenesis(ctx sdk.Context, state *consumertypes.GenesisState) | |
| return state.InitialValSet | ||
| } | ||
|
|
||
| // ExportGenesis returns the CCV consumer module's exported genesis | ||
| func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisState) { | ||
| params := k.GetParams(ctx) | ||
| if !params.Enabled { | ||
| return consumertypes.DefaultGenesisState() | ||
| } | ||
|
|
||
| // export the current validator set | ||
| valset, err := k.GetCurrentValidatorsAsABCIUpdates(ctx) | ||
| if err != nil { | ||
| panic(fmt.Sprintf("fail to retrieve the validator set: %s", err)) | ||
| } | ||
|
|
@@ -124,16 +135,6 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisSt | |
| return false | ||
| }) | ||
|
|
||
| outstandingDowntimes := []types.OutstandingDowntime{} | ||
| k.IterateOutstandingDowntime(ctx, func(addr string) bool { | ||
| od := types.OutstandingDowntime{ | ||
|
|
@@ -148,36 +149,60 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) (genesis *consumertypes.GenesisSt | |
| channelID, | ||
| maturingPackets, | ||
| valset, | ||
| k.GetHeightToValsetUpdateIDs(ctx), | ||
| consumertypes.SlashRequests{}, | ||
| outstandingDowntimes, | ||
| consumertypes.LastTransmissionBlockHeight{}, | ||
| params, | ||
| ) | ||
| } else { | ||
| clientID, ok := k.GetProviderClientID(ctx) | ||
| // if provider clientID and channelID don't exist on the consumer chain, | ||
| // then CCV protocol is disabled for this chain return a default genesis state | ||
| if !ok { | ||
| return consumertypes.DefaultGenesisState() | ||
| } | ||
|
|
||
| // export client states and pending slashing requests into a new chain genesis | ||
| genesis = consumertypes.NewRestartGenesisState( | ||
| clientID, | ||
| "", | ||
| nil, | ||
| valset, | ||
| k.GetHeightToValsetUpdateIDs(ctx), | ||
| k.GetPendingSlashRequests(ctx), | ||
| nil, | ||
| consumertypes.LastTransmissionBlockHeight{}, | ||
| params, | ||
| ) | ||
| } | ||
|
|
||
| return | ||
| } | ||
|
|
||
| // verifyGenesisInitValset verifies the latest consensus state on provider client matches | ||
| // the initial validator set of restarted chain thus | ||
| func (k Keeper) verifyGenesisInitValset(ctx sdk.Context, genState *consumertypes.GenesisState) error { | ||
|
|
||
| consState, ok := k.clientKeeper.GetLatestClientConsensusState(ctx, genState.ProviderClientId) | ||
| if !ok { | ||
| return fmt.Errorf("consensus state for provider client not found. MUST run IBC genesis before CCV consumer genesis") | ||
| } | ||
| tmConsState, ok := consState.(*ibctmtypes.ConsensusState) | ||
| if !ok { | ||
| return fmt.Errorf(fmt.Sprintf("consensus state has wrong type. expected: %T, got: %T", &ibctmtypes.ConsensusState{}, consState)) | ||
| } | ||
|
|
||
| // ensure that initial validator set is same as initial consensus state on provider client. | ||
| // this will be verified by provider module on channel handshake. | ||
| vals, err := tmtypes.PB2TM.ValidatorUpdates(genState.InitialValSet) | ||
| if err != nil { | ||
| return err | ||
| } | ||
| valSet := tmtypes.NewValidatorSet(vals) | ||
|
|
||
| if !bytes.Equal(tmConsState.NextValidatorsHash, valSet.Hash()) { | ||
| return fmt.Errorf("initial validator set does not match last consensus state of the provider client") | ||
| } | ||
| return nil | ||
| } | ||
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this being used for a zero height restart or a restart containing the current block height? Or both?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If this genesis restore was being used on a zero height restart, then that might result in it taking a really long time to send out a distribution... not sure
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You're right. A zero height restart could take a problematic long time to distribute due to this line:
interchain-security/x/ccv/consumer/keeper/distribution.go
Line 58 in b10e132
Actually
LastTransmissionBlockHeightshould never be greater than the current block height.