chore: remove AllowUpdateAfterProposal

CHANGELOG.md

@@ -72,6 +72,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (07-tendermint) [\#1097](https://github.com/cosmos/ibc-go/pull/1097) Remove `GetClientID` function from 07-tendermint `Misbehaviour` type.
 * (07-tendermint) [\#1097](https://github.com/cosmos/ibc-go/pull/1097) Deprecate `ClientId` field in 07-tendermint `Misbehaviour` type.
 * (modules/core/exported) [\#1107](https://github.com/cosmos/ibc-go/pull/1107) Merging the `Header` and `Misbehaviour` interfaces into a single `ClientMessage` type.
+* (06-solomachine)[\#1906](https://github.com/cosmos/ibc-go/pull/1906/files) Removed `AllowUpdateAfterProposal` boolean as it has been deprecated (see 01_concepts of the solo machine spec for more details).
 * (07-tendermint) [\#1896](https://github.com/cosmos/ibc-go/pull/1896) Remove error return from `IterateConsensusStateAscending` in `07-tendermint`.
 
 ### State Machine Breaking

modules/core/02-client/keeper/client_test.go

@@ -23,7 +23,7 @@ func (suite *KeeperTestSuite) TestCreateClient() {
 		expPass     bool
 	}{
 		{"success", ibctm.NewClientState(testChainID, ibctm.DefaultTrustLevel, trustingPeriod, ubdPeriod, maxClockDrift, testClientHeight, commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath, false, false), true},
-		{"client type not supported", solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time}, false), false},
+		{"client type not supported", solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time}), false},
 	}
 
 	for i, tc := range cases {

modules/core/02-client/keeper/keeper_test.go

@@ -190,7 +190,7 @@ func (suite *KeeperTestSuite) TestValidateSelfClient() {
 		},
 		{
 			"invalid client type",
-			solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time}, false),
+			solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time}),
 			false,
 		},
 		{

modules/core/02-client/legacy/v100/genesis_test.go

@@ -59,7 +59,6 @@ func (suite *LegacyTestSuite) TestMigrateGenesisSolomachine() {
 				Diversifier: clientState.ConsensusState.Diversifier,
 				Timestamp:   clientState.ConsensusState.Timestamp,
 			},
-			AllowUpdateAfterProposal: clientState.AllowUpdateAfterProposal,
 		}
 
 		// set client state

modules/core/02-client/legacy/v100/store.go

@@ -118,7 +118,6 @@ func migrateSolomachine(clientState *ClientState) *smtypes.ClientState {
 		Sequence:                 clientState.Sequence,
 		IsFrozen:                 isFrozen,
 		ConsensusState:           consensusState,
-		AllowUpdateAfterProposal: clientState.AllowUpdateAfterProposal,
 	}
 }
 

modules/core/02-client/legacy/v100/store_test.go

@@ -71,7 +71,6 @@ func (suite *LegacyTestSuite) TestMigrateStoreSolomachine() {
 				Diversifier: clientState.ConsensusState.Diversifier,
 				Timestamp:   clientState.ConsensusState.Timestamp,
 			},
-			AllowUpdateAfterProposal: clientState.AllowUpdateAfterProposal,
 		}
 
 		// set client state

modules/core/02-client/types/genesis_test.go

@@ -114,7 +114,7 @@ func (suite *TypesTestSuite) TestValidateGenesis() {
 					types.NewIdentifiedClientState(
 						soloMachineClientID, ibctm.NewClientState(suite.chainA.ChainID, ibctm.DefaultTrustLevel, ibctesting.TrustingPeriod, ibctesting.UnbondingPeriod, ibctesting.MaxClockDrift, clientHeight, commitmenttypes.GetSDKSpecs(), ibctesting.UpgradePath, false, false),
 					),
-					types.NewIdentifiedClientState(tmClientID0, solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time}, false)),
+					types.NewIdentifiedClientState(tmClientID0, solomachinetypes.NewClientState(0, &solomachinetypes.ConsensusState{suite.solomachine.ConsensusState().PublicKey, suite.solomachine.Diversifier, suite.solomachine.Time})),
 				},
 				nil,
 				nil,

modules/core/legacy/v100/genesis_test.go

@@ -86,7 +86,6 @@ func (suite *LegacyTestSuite) TestMigrateGenesisSolomachine() {
 				Diversifier: clientState.ConsensusState.Diversifier,
 				Timestamp:   clientState.ConsensusState.Timestamp,
 			},
-			AllowUpdateAfterProposal: clientState.AllowUpdateAfterProposal,
 		}
 
 		// set client state

modules/light-clients/06-solomachine/client_state.go

@@ -18,12 +18,12 @@ import (
 var _ exported.ClientState = (*ClientState)(nil)
 
 // NewClientState creates a new ClientState instance.
-func NewClientState(latestSequence uint64, consensusState *ConsensusState, allowUpdateAfterProposal bool) *ClientState {
+func NewClientState(latestSequence uint64, consensusState *ConsensusState) *ClientState {
 	return &ClientState{
-		Sequence:                 latestSequence,
-		IsFrozen:                 false,
-		ConsensusState:           consensusState,
-		AllowUpdateAfterProposal: allowUpdateAfterProposal,
+		Sequence:       latestSequence,
+		IsFrozen:       false,
+		ConsensusState: consensusState,
+		// AllowUpdateAfterProposal has been DEPRECATED. See 01_concepts in the solo machine spec repo for more details.
 	}
 }
 
@@ -75,11 +75,10 @@ func (cs ClientState) Validate() error {
 	return cs.ConsensusState.ValidateBasic()
 }
 
-// ZeroCustomFields returns solomachine client state with client-specific fields FrozenSequence,
-// and AllowUpdateAfterProposal zeroed out
+// ZeroCustomFields returns solomachine client state with client-specific field FrozenSequence zeroed out
 func (cs ClientState) ZeroCustomFields() exported.ClientState {
 	return NewClientState(
-		cs.Sequence, cs.ConsensusState, false,
+		cs.Sequence, cs.ConsensusState,
 	)
 }
 

modules/light-clients/06-solomachine/client_state_test.go

@@ -52,22 +52,22 @@ func (suite *SoloMachineTestSuite) TestClientStateValidateBasic() {
 			},
 			{
 				"sequence is zero",
-				solomachine.NewClientState(0, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, sm.Diversifier, sm.Time}, false),
+				solomachine.NewClientState(0, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, sm.Diversifier, sm.Time}),
 				false,
 			},
 			{
 				"timestamp is zero",
-				solomachine.NewClientState(1, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, sm.Diversifier, 0}, false),
+				solomachine.NewClientState(1, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, sm.Diversifier, 0}),
 				false,
 			},
 			{
 				"diversifier is blank",
-				solomachine.NewClientState(1, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, "  ", 1}, false),
+				solomachine.NewClientState(1, &solomachine.ConsensusState{sm.ConsensusState().PublicKey, "  ", 1}),
 				false,
 			},
 			{
 				"pubkey is empty",
-				solomachine.NewClientState(1, &solomachine.ConsensusState{nil, sm.Diversifier, sm.Time}, false),
+				solomachine.NewClientState(1, &solomachine.ConsensusState{nil, sm.Diversifier, sm.Time}),
 				false,
 			},
 		}
@@ -447,6 +447,13 @@ func (suite *SoloMachineTestSuite) TestVerifyMembership() {
 				},
 				true,
 			},
+			{
+				"consensus state in client state is nil",
+				func() {
+					clientState = solomachine.NewClientState(1, nil)
+				},
+				false,
+			},
 			{
 				"client state latest height is less than sequence",
 				func() {
@@ -455,7 +462,7 @@ func (suite *SoloMachineTestSuite) TestVerifyMembership() {
 						PublicKey: sm.ConsensusState().PublicKey,
 					}
 
-					clientState = solomachine.NewClientState(sm.Sequence-1, consensusState, false)
+					clientState = solomachine.NewClientState(sm.Sequence-1, consensusState)
 				},
 				false,
 			},
@@ -492,7 +499,7 @@ func (suite *SoloMachineTestSuite) TestVerifyMembership() {
 						PublicKey: sm.ConsensusState().PublicKey,
 					}
 
-					clientState = solomachine.NewClientState(sm.Sequence, consensusState, false)
+					clientState = solomachine.NewClientState(sm.Sequence, consensusState)
 				},
 				false,
 			},
@@ -658,6 +665,13 @@ func (suite *SoloMachineTestSuite) TestVerifyNonMembership() {
 				},
 				true,
 			},
+			{
+				"consensus state in client state is nil",
+				func() {
+					clientState = solomachine.NewClientState(1, nil)
+				},
+				false,
+			},
 			{
 				"client state latest height is less than sequence",
 				func() {
@@ -666,7 +680,7 @@ func (suite *SoloMachineTestSuite) TestVerifyNonMembership() {
 						PublicKey: sm.ConsensusState().PublicKey,
 					}
 
-					clientState = solomachine.NewClientState(sm.Sequence-1, consensusState, false)
+					clientState = solomachine.NewClientState(sm.Sequence-1, consensusState)
 				},
 				false,
 			},
@@ -703,7 +717,7 @@ func (suite *SoloMachineTestSuite) TestVerifyNonMembership() {
 						PublicKey: sm.ConsensusState().PublicKey,
 					}
 
-					clientState = solomachine.NewClientState(sm.Sequence, consensusState, false)
+					clientState = solomachine.NewClientState(sm.Sequence, consensusState)
 				},
 				false,
 			},

modules/light-clients/06-solomachine/proposal_handle.go

@@ -22,10 +22,6 @@ func (cs ClientState) CheckSubstituteAndUpdateState(
 	ctx sdk.Context, cdc codec.BinaryCodec, subjectClientStore,
 	_ sdk.KVStore, substituteClient exported.ClientState,
 ) error {
-	if !cs.AllowUpdateAfterProposal {
-		return sdkerrors.Wrapf(clienttypes.ErrUpdateClientFailed, "solo machine client is not allowed to updated with a proposal")
-	}
-
 	substituteClientState, ok := substituteClient.(*ClientState)
 	if !ok {
 		return sdkerrors.Wrapf(clienttypes.ErrInvalidClientType, "substitute client state type %T, expected  %T", substituteClient, &ClientState{})

modules/light-clients/06-solomachine/spec/01_concepts.md

@@ -133,7 +133,6 @@ If the update is successful:
 An update by a governance proposal will only succeed if:
 
 - the substitute provided is parseable to solo machine client state
-- the `AllowUpdateAfterProposal` client parameter is set to `true`
 - the new consensus state public key does not equal the current consensus state public key
 
 If the update is successful:
@@ -142,6 +141,8 @@ If the update is successful:
 - the subject consensus state is updated to the substitute consensus state
 - the client is unfrozen (if it was previously frozen)
 
+NOTE: Previously, `AllowUpdateAfterProposal` was used to signal the update/recovery options for the solo machine client.  However, this has now been deprecated because a code migration can overwrite the client and consensus states regardless of the value of this parameter. If governance would vote to overwrite a client or consensus state, it is likely that governance would also be willing to perform a code migration to do the same.
+
 ## Misbehaviour
 
 Misbehaviour handling will only succeed if:

testing/solomachine.go

@@ -82,10 +82,9 @@ func GenerateKeys(t *testing.T, n uint64) ([]cryptotypes.PrivKey, []cryptotypes.
 	return privKeys, pubKeys, pk
 }
 
-// ClientState returns a new solo machine ClientState instance. Default usage does not allow update
-// after governance proposal
+// ClientState returns a new solo machine ClientState instance.
 func (solo *Solomachine) ClientState() *solomachinetypes.ClientState {
-	return solomachinetypes.NewClientState(solo.Sequence, solo.ConsensusState(), false)
+	return solomachinetypes.NewClientState(solo.Sequence, solo.ConsensusState())
 }
 
 // ConsensusState returns a new solo machine ConsensusState instance