refactor!: deprecate soft opt-out (#1964)

* first commit

* Set soft_opt_out_threshold to 0 instead of empty

* added changelog

* Update docs/docs/adrs/adr-009-soft-opt-out.md

Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>

* Update proto/interchain_security/ccv/v1/shared_consumer.proto

Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>

* Update .changelog/unreleased/improvements/consumer/1964-deprecate-soft-opt-out.md

Co-authored-by: Marius Poke <marius.poke@posteo.de>

* fixed changelogs

* added changelogs

* nit fix

* added changelog in ADR

* took into account comments.

* small fix

* fixed small issue

---------

Co-authored-by: Philip Offtermatt <57488781+p-offtermatt@users.noreply.github.com>
Co-authored-by: Marius Poke <marius.poke@posteo.de>

.changelog/unreleased/api-breaking/1964-deprecate-soft-opt-out.md

@@ -0,0 +1,2 @@
+- Remove soft opt-out feature. 
+  ([\#1964](https://github.com/cosmos/interchain-security/pull/1964))

.changelog/unreleased/features/1964-deprecate-soft-opt-out.md

@@ -0,0 +1,2 @@
+- Remove soft opt-out feature. 
+  ([\#1964](https://github.com/cosmos/interchain-security/pull/1964))

.changelog/unreleased/state-breaking/1964-deprecate-soft-opt-out.md

@@ -0,0 +1,2 @@
+- Remove soft opt-out feature. 
+  ([\#1964](https://github.com/cosmos/interchain-security/pull/1964))

app/consumer-democracy/app.go

@@ -551,7 +551,6 @@ func New(
 	// CanWithdrawInvariant invariant.
 	// NOTE: staking module is required if HistoricalEntries param > 0
 	// NOTE: capability module's beginblocker must come before any modules using capabilities (e.g. IBC)
-	// NOTE: the soft opt-out requires that the consumer module's beginblocker comes after the slashing module's beginblocker
 	app.MM.SetOrderBeginBlockers(
 		// upgrades should be run first
 		upgradetypes.ModuleName,

app/consumer/app.go

@@ -481,7 +481,6 @@ func New(
 	// NOTE: Capability module must occur first so that it can initialize any capabilities
 	// so that other modules that want to create or claim capabilities afterwards in InitChain
 	// can do so safely.
-	// NOTE: the soft opt-out requires that the consumer module's beginblocker comes after the slashing module's beginblocker
 	app.MM.SetOrderInitGenesis(
 		capabilitytypes.ModuleName,
 		authtypes.ModuleName,

app/consumer/genesis.go

@@ -81,6 +81,9 @@ func transformToNew(jsonRaw []byte, ctx client.Context) (json.RawMessage, error)
 		oldConsumerGenesis.Params.RetryDelayPeriod = types.DefaultRetryDelayPeriod
 	}
 
+	// `SoftOptOutThreshold` is deprecated in the current consumer implementation, so set to zero
+	oldConsumerGenesis.Params.SoftOptOutThreshold = "0"
+
 	// Versions before v3.3.x of provider genesis data fills up deprecated fields
 	// ProviderClientState, ConsensusState and InitialValSet in type GenesisState
 	newGenesis := types.ConsumerGenesisState{

app/consumer/genesis_test.go

@@ -494,7 +494,9 @@ func TestConsumerGenesisTransformationFromV2ToCurrent(t *testing.T) {
 	require.EqualValues(t, srcGenesis.Params.ConsumerRedistributionFraction, resultGenesis.Params.ConsumerRedistributionFraction)
 	require.EqualValues(t, srcGenesis.Params.HistoricalEntries, resultGenesis.Params.HistoricalEntries)
 	require.EqualValues(t, srcGenesis.Params.UnbondingPeriod, resultGenesis.Params.UnbondingPeriod)
-	require.EqualValues(t, srcGenesis.Params.SoftOptOutThreshold, resultGenesis.Params.SoftOptOutThreshold)
+
+	// `SoftOptOutThreshold` is deprecated, so it should be set to zero the current version
+	require.EqualValues(t, "0", resultGenesis.Params.SoftOptOutThreshold)
 	require.EqualValues(t, srcGenesis.Params.RewardDenoms, resultGenesis.Params.RewardDenoms)
 	require.EqualValues(t, srcGenesis.Params.ProviderRewardDenoms, resultGenesis.Params.ProviderRewardDenoms)
 
@@ -565,7 +567,10 @@ func TestConsumerGenesisTransformationV330ToCurrent(t *testing.T) {
 	require.Equal(t, srcGenesis.Params.ConsumerRedistributionFraction, resultGenesis.Params.ConsumerRedistributionFraction)
 	require.Equal(t, srcGenesis.Params.HistoricalEntries, resultGenesis.Params.HistoricalEntries)
 	require.Equal(t, srcGenesis.Params.UnbondingPeriod, resultGenesis.Params.UnbondingPeriod)
-	require.Equal(t, srcGenesis.Params.SoftOptOutThreshold, resultGenesis.Params.SoftOptOutThreshold)
+
+	// `SoftOptOutThreshold` is deprecated, so it should be set to zero the current version
+	require.Equal(t, "0", resultGenesis.Params.SoftOptOutThreshold)
+
 	require.Equal(t, srcGenesis.Params.RewardDenoms, resultGenesis.Params.RewardDenoms)
 	require.Equal(t, srcGenesis.Params.ProviderRewardDenoms, resultGenesis.Params.ProviderRewardDenoms)
 

app/sovereign/app.go

@@ -79,7 +79,6 @@ import (
 	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
 	govv1beta1 "github.com/cosmos/cosmos-sdk/x/gov/types/v1beta1"
-
 	// add mint
 	mint "github.com/cosmos/cosmos-sdk/x/mint"
 	mintkeeper "github.com/cosmos/cosmos-sdk/x/mint/keeper"

docs/docs/adrs/adr-009-soft-opt-out.md

@@ -7,11 +7,12 @@ title: Soft Opt-Out
 ## Changelog
 
 * 6/13/23: Initial draft of ADR. Feature already implemented and in production.
+* 6/19/24: Change status to deprecated
 
 ## Status
 
-Accepted
-
+Deprecated
+Deprecated by [Partial Set Security](adr-015-partial-set-security.md)
 ## Context
 
 Some small validators may not have the resources needed to validate all consumer chains. Therefore a need exists to allow the bottom `x%` of validators to opt-out of validating a consumer chain. Meaning downtime infractions for these validators are dropped without ever reaching the provider.

docs/docs/adrs/intro.md

@@ -37,7 +37,6 @@ To suggest an ADR, please make use of the [ADR template](./templates/adr-templat
 - [ADR 004: Denom DOS fixes](./adr-004-denom-dos-fixes.md)
 - [ADR 005: Cryptographic verification of equivocation evidence](./adr-005-cryptographic-equivocation-verification.md)
 - [ADR 008: Throttle with retries](./adr-008-throttle-retries.md)
-- [ADR 009: Soft Opt-Out](./adr-009-soft-opt-out.md)
 - [ADR 010: Standalone to Consumer Changeover](./adr-010-standalone-changeover.md)
 - [ADR 013: Slashing on the provider for consumer equivocation](./adr-013-equivocation-slashing.md)
 - [ADR 014: Epochs](./adr-014-epochs.md)
@@ -57,3 +56,4 @@ To suggest an ADR, please make use of the [ADR template](./templates/adr-templat
 ### Deprecated
 
 - [ADR 003: Equivocation governance proposal](./adr-003-equivocation-gov-proposal.md)
+- [ADR 009: Soft Opt-Out](./adr-009-soft-opt-out.md)

docs/docs/features/proposals.md

@@ -77,14 +77,6 @@ Minimal example:
 }
 ```
 
-:::warning
-Before the introduction of Partial Set Security, consumer chains typically included a "soft opt-out mechanism"
-which allows the bottom N% of the provider's validators to not validate the consumer chain, without being jailed for downtime on the provider.
-After the introduction of Partial Set Security, the use of the soft opt-out mechanism is discouraged, and consumer chains are
-encouraged to use the topN parameter to not force validators with little stake to validate the chain.
-:::
-
-
 ## `ConsumerModificationProposal`
 Proposal type used to change the power shaping parameters of a running consumer chain, as well as to change a Top N running
 consumer chain to an Opt-In chain and vice versa.

proto/interchain_security/ccv/consumer/v1/consumer.proto

@@ -27,7 +27,10 @@ message CrossChainValidator {
     (cosmos_proto.accepts_interface) = "cosmos.crypto.PubKey",
     (gogoproto.moretags) = "yaml:\"consensus_pubkey\""
   ];
-  bool opted_out = 4;
+
+  // !!! DEPRECATED !!! opted_out is deprecated because after the introduction of Partial Set Security (PSS)
+  // we removed the soft opt-out feature.
+  bool opted_out = 4 [deprecated = true];
 }
 
 // A record storing the state of a slash packet sent to the provider chain

proto/interchain_security/ccv/v1/shared_consumer.proto

@@ -62,11 +62,8 @@ message ConsumerParams {
     google.protobuf.Duration unbonding_period = 9
         [ (gogoproto.nullable) = false, (gogoproto.stdduration) = true ];
 
-    // The threshold for the percentage of validators at the bottom of the set who
-    // can opt out of running the consumer chain without being punished. For
-    // example, a value of 0.05 means that the validators in the bottom 5% of the
-    // set can opt out
-    string soft_opt_out_threshold = 10;
+    // !!! DEPRECATED !!! soft_opt_out_threshold is deprecated. see docs/docs/adrs/adr-015-partial-set-security.md
+    string soft_opt_out_threshold = 10 [deprecated = true];
 
     // Reward denoms. These are the denominations which are allowed to be sent to
     // the provider as rewards.

tests/e2e/actions.go

@@ -463,7 +463,6 @@ func (tr TestConfig) submitConsumerModificationProposal(
 	}
 
 	bz, err = cmd.CombinedOutput()
-
 	if err != nil {
 		log.Fatal(err, "\n", string(bz))
 	}
@@ -606,10 +605,14 @@ func (tr *TestConfig) startConsumerChain(
 	verbose bool,
 ) {
 	fmt.Println("Starting consumer chain ", action.ConsumerChain)
+
 	consumerGenesis := ".app_state.ccvconsumer = " + tr.getConsumerGenesis(action.ProviderChain, action.ConsumerChain, target)
 	consumerGenesisChanges := tr.chainConfigs[action.ConsumerChain].GenesisChanges
 	if consumerGenesisChanges != "" {
-		consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges + " | " + action.GenesisChanges
+		consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges
+	}
+	if action.GenesisChanges != "" {
+		consumerGenesis = consumerGenesis + " | " + action.GenesisChanges
 	}
 
 	tr.startChain(StartChainAction{
@@ -841,7 +844,10 @@ func (tr TestConfig) changeoverChain(
 	consumerGenesis := ".app_state.ccvconsumer = " + string(bz)
 	consumerGenesisChanges := tr.chainConfigs[action.SovereignChain].GenesisChanges
 	if consumerGenesisChanges != "" {
-		consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges + " | " + action.GenesisChanges
+		consumerGenesis = consumerGenesis + " | " + consumerGenesisChanges
+	}
+	if action.GenesisChanges != "" {
+		consumerGenesis = consumerGenesis + " | " + action.GenesisChanges
 	}
 
 	tr.startChangeover(ChangeoverChainAction{
@@ -2065,7 +2071,7 @@ func (tr TestConfig) invokeDoublesignSlash(
 		if err != nil {
 			log.Fatal(err, "\n", string(bz))
 		}
-		tr.waitBlocks("provi", 10, 2*time.Minute)
+		tr.waitBlocks("provi", 20, 4*time.Minute)
 	} else { // tr.useCometMock
 		validatorPrivateKeyAddress := tr.GetValidatorPrivateKeyAddress(action.Chain, action.Validator)
 

tests/e2e/step_delegation.go

@@ -220,58 +220,6 @@ func stepsCancelUnbond(consumerName string) []Step {
 	}
 }
 
-// stepsRedelegateForOptOut tests redelegation, and sets up voting powers s.t
-// alice will have less than 5% of the total voting power. This is needed to
-// test opt-out functionality.
-func stepsRedelegateForOptOut(consumerName string) []Step {
-	return []Step{
-		{
-			Action: RedelegateTokensAction{
-				Chain:    ChainID("provi"),
-				Src:      ValidatorID("alice"),
-				Dst:      ValidatorID("carol"),
-				TxSender: ValidatorID("alice"),
-				Amount:   450000000,
-			},
-			State: State{
-				ChainID("provi"): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						ValidatorID("alice"): 60,
-						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 950,
-					},
-				},
-				ChainID(consumerName): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						// Voting power changes not seen by consumer yet
-						ValidatorID("alice"): 510,
-						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 500,
-					},
-				},
-			},
-		},
-		{
-			Action: RelayPacketsAction{
-				ChainA:  ChainID("provi"),
-				ChainB:  ChainID(consumerName),
-				Port:    "provider",
-				Channel: 0,
-			},
-			State: State{
-				ChainID(consumerName): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						// Now power changes are seen by consumer
-						ValidatorID("alice"): 60,
-						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 950,
-					},
-				},
-			},
-		},
-	}
-}
-
 // stepsRedelegate tests redelegation and resulting validator power changes.
 func stepsRedelegate(consumerName string) []Step {
 	return []Step{
@@ -283,68 +231,15 @@ func stepsRedelegate(consumerName string) []Step {
 				TxSender: ValidatorID("carol"),
 				// redelegate s.t. alice has majority stake so non-faulty validators maintain more than
 				// 2/3 voting power during downtime tests below, avoiding chain halt
-				Amount: 449000000,
+				Amount: 400000000,
 			},
 			State: State{
 				ChainID("provi"): ChainState{
 					ValPowers: &map[ValidatorID]uint{
-						ValidatorID("alice"): 509,
+						ValidatorID("alice"): 910,
 						ValidatorID("bob"):   500,
 						// carol always uses a consumer assigned key
-						ValidatorID("carol"): 501,
-					},
-				},
-				ChainID(consumerName): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						// Voting power changes not seen by consumer yet
-						ValidatorID("alice"): 60,
-						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 950,
-					},
-				},
-			},
-		},
-		{
-			Action: RelayPacketsAction{
-				ChainA:  ChainID("provi"),
-				ChainB:  ChainID(consumerName),
-				Port:    "provider",
-				Channel: 0,
-			},
-			State: State{
-				ChainID(consumerName): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						// Now power changes are seen by consumer
-						ValidatorID("alice"): 509,
-						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 501,
-					},
-				},
-			},
-		},
-	}
-}
-
-// stepsRedelegate tests redelegation and resulting validator power changes.
-func stepsRedelegateShort(consumerName string) []Step {
-	return []Step{
-		{
-			Action: RedelegateTokensAction{
-				Chain:    ChainID("provi"),
-				Src:      ValidatorID("alice"),
-				Dst:      ValidatorID("carol"),
-				TxSender: ValidatorID("alice"),
-				// Leave alice with majority stake so non-faulty validators maintain more than
-				// 2/3 voting power during downtime tests below, avoiding chain halt
-				Amount: 1000000,
-			},
-			State: State{
-				ChainID("provi"): ChainState{
-					ValPowers: &map[ValidatorID]uint{
-						ValidatorID("alice"): 509,
-						ValidatorID("bob"):   500,
-						// carol always uses a consumer assigned key
-						ValidatorID("carol"): 501,
+						ValidatorID("carol"): 100,
 					},
 				},
 				ChainID(consumerName): ChainState{
@@ -368,9 +263,9 @@ func stepsRedelegateShort(consumerName string) []Step {
 				ChainID(consumerName): ChainState{
 					ValPowers: &map[ValidatorID]uint{
 						// Now power changes are seen by consumer
-						ValidatorID("alice"): 509,
+						ValidatorID("alice"): 910,
 						ValidatorID("bob"):   500,
-						ValidatorID("carol"): 501,
+						ValidatorID("carol"): 100,
 					},
 				},
 			},

tests/e2e/steps.go

@@ -18,7 +18,7 @@ var compatibilitySteps = concatSteps(
 	compstepsStartChains([]string{"consu"}, false),
 	stepsDelegate("consu"),
 	stepsUnbond("consu"),
-	stepsRedelegateShort("consu"),
+	stepsRedelegate("consu"),
 	stepsDowntime("consu"),
 	stepsDoubleSignOnProvider("consu"), // carol double signs on provider
 	stepsStartRelayer(),
@@ -32,8 +32,6 @@ var happyPathSteps = concatSteps(
 	stepsAssignConsumerKeyOnStartedChain("consu", "bob"),
 	stepsUnbond("consu"),
 	stepsCancelUnbond("consu"),
-	stepsRedelegateForOptOut("consu"),
-	stepsDowntimeWithOptOut("consu"),
 	stepsRedelegate("consu"),
 	stepsDowntime("consu"),
 	stepsDoubleSignOnProvider("consu"), // carol double signs on provider
@@ -46,7 +44,7 @@ var shortHappyPathSteps = concatSteps(
 	stepsStartChains([]string{"consu"}, false),
 	stepsDelegate("consu"),
 	stepsUnbond("consu"),
-	stepsRedelegateShort("consu"),
+	stepsRedelegate("consu"),
 	stepsDowntime("consu"),
 	stepsDoubleSignOnProvider("consu"), // carol double signs on provider
 	stepsStartRelayer(),
@@ -58,12 +56,12 @@ var lightClientAttackSteps = concatSteps(
 	stepsStartChains([]string{"consu"}, false),
 	stepsDelegate("consu"),
 	stepsUnbond("consu"),
-	stepsRedelegateShort("consu"),
+	stepsRedelegate("consu"),
 	stepsDowntime("consu"),
 	stepsLightClientAttackOnProviderAndConsumer("consu"), // carol double signs on provider, bob double signs on consumer
 	stepsStartRelayer(),
-	stepsConsumerRemovalPropNotPassing("consu", 3), // submit removal prop but vote no on it - chain should stay
-	stepsStopChain("consu", 4),                     // stop chain
+	stepsConsumerRemovalPropNotPassing("consu", 2), // submit removal prop but vote no on it - chain should stay
+	stepsStopChain("consu", 3),                     // stop chain
 )
 
 var slashThrottleSteps = concatSteps(
@@ -121,7 +119,7 @@ var changeoverSteps = concatSteps(
 
 var consumerMisbehaviourSteps = concatSteps(
 	// start provider and consumer chain
-	stepsStartChainsWithSoftOptOut("consu"),
+	stepsStartChainsForConsumerMisbehaviour("consu"),
 	// make a consumer validator to misbehave and get jailed
 	stepsCauseConsumerMisbehaviour("consu"),
 )
@@ -137,6 +135,6 @@ var consumerDoubleDowntimeSteps = concatSteps(
 	stepsStartChains([]string{"consu"}, false),
 	stepsDelegate("consu"),
 	stepsUnbond("consu"),
-	stepsRedelegateShort("consu"),
+	stepsRedelegate("consu"),
 	stepsDoubleDowntime("consu"),
 )

tests/e2e/steps_active_set_changes.go

@@ -86,12 +86,6 @@ func stepsActiveSetChanges() []Step {
 					{Id: ValidatorID("bob"), Stake: 200000000, Allocation: 10000000000},
 					{Id: ValidatorID("carol"), Stake: 700000000, Allocation: 10000000000},
 				},
-				// For consumers that're launching with the provider being on an earlier version
-				// of ICS before the soft opt-out threshold was introduced, we need to set the
-				// soft opt-out threshold to 0.05 in the consumer genesis to ensure that the
-				// consumer binary doesn't panic. Sdk requires that all params are set to valid
-				// values from the genesis file.
-				GenesisChanges: ".app_state.ccvconsumer.params.soft_opt_out_threshold = \"0.05\"",
 			},
 			State: State{},
 		},