Merge branch 'main' into roman/backport-wasmd-upgrade

Author: p0mvn

Dockerfile

@@ -35,4 +35,4 @@ EXPOSE 26657
 EXPOSE 1317
 
 ENTRYPOINT ["osmosisd"]
-CMD [ "start" ]
+CMD [ "start" ]

app/ante.go

@@ -12,6 +12,8 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/auth/signing"
 
 	osmoante "github.com/osmosis-labs/osmosis/v7/ante"
+
+	v8 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v8"
 	txfeeskeeper "github.com/osmosis-labs/osmosis/v7/x/txfees/keeper"
 	txfeestypes "github.com/osmosis-labs/osmosis/v7/x/txfees/types"
 )
@@ -40,6 +42,7 @@ func NewAnteHandler(
 		wasmkeeper.NewLimitSimulationGasDecorator(wasmConfig.SimulationGasLimit),
 		wasmkeeper.NewCountTXDecorator(txCounterStoreKey),
 		ante.NewRejectExtensionOptionsDecorator(),
+		v8.MsgFilterDecorator{},
 		// Use Mempool Fee Decorator from our txfees module instead of default one from auth
 		// https://github.com/cosmos/cosmos-sdk/blob/master/x/auth/middleware/fee.go#L34
 		mempoolFeeDecorator,

app/app.go

@@ -47,6 +47,7 @@ import (
 	v5 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v5"
 	v6 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v6"
 	v7 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v7"
+	v8 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v8"
 	v9 "github.com/osmosis-labs/osmosis/v7/app/upgrades/v9"
 	_ "github.com/osmosis-labs/osmosis/v7/client/docs/statik"
 )
@@ -86,7 +87,7 @@ var (
 	_ App = (*OsmosisApp)(nil)
 
 	Upgrades = []upgrades.Upgrade{v4.Upgrade, v5.Upgrade, v7.Upgrade, v9.Upgrade}
-	Forks    = []upgrades.Fork{v3.Fork, v6.Fork}
+	Forks    = []upgrades.Fork{v3.Fork, v6.Fork, v8.Fork}
 )
 
 // GetWasmEnabledProposals parses the WasmProposalsEnabled and

app/keepers/keepers.go

@@ -262,19 +262,9 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 	)
 
 	appKeepers.SuperfluidKeeper = superfluidkeeper.NewKeeper(
-		appCodec,
-		appKeepers.keys[superfluidtypes.StoreKey],
-		appKeepers.GetSubspace(superfluidtypes.ModuleName),
-		*appKeepers.AccountKeeper,
-		appKeepers.BankKeeper,
-		appKeepers.StakingKeeper,
-		appKeepers.DistrKeeper,
-		appKeepers.EpochsKeeper,
-		appKeepers.LockupKeeper,
-		gammKeeper,
-		appKeepers.IncentivesKeeper,
-		lockupkeeper.NewMsgServerImpl(appKeepers.LockupKeeper),
-	)
+		appCodec, appKeepers.keys[superfluidtypes.StoreKey], appKeepers.GetSubspace(superfluidtypes.ModuleName),
+		*appKeepers.AccountKeeper, appKeepers.BankKeeper, appKeepers.StakingKeeper, appKeepers.DistrKeeper, appKeepers.EpochsKeeper, appKeepers.LockupKeeper, appKeepers.GAMMKeeper, appKeepers.IncentivesKeeper,
+		lockupkeeper.NewMsgServerImpl(appKeepers.LockupKeeper))
 
 	mintKeeper := mintkeeper.NewKeeper(
 		appCodec,

app/upgrades/v8/README.md

@@ -0,0 +1,70 @@
+# V8 Upgrade
+
+The v8 upgrade is an emergency upgrade coordinated according to osmosis governance proposals [225](https://www.mintscan.io/osmosis/proposals/225), [226](https://www.mintscan.io/osmosis/proposals/226).   And thus by implication of 225, incentive proposals [222](https://www.mintscan.io/osmosis/proposals/222), [223](https://www.mintscan.io/osmosis/proposals/223), and [224](https://www.mintscan.io/osmosis/proposals/224).
+
+## Adjusting Incentives for 222, 223, 224
+Like the weekly Gauge Weight updates, the implementations for these proposals simply modify the weights of gauges between pools in the Upgrade:
+
+* `ApplyProp222Change`
+* `ApplyProp223Change`
+* `ApplyProp224Change`
+
+The specification of Minimum and Maximum values will be applied to the spreadsheet that is shared in each Weekly update.
+
+## UnPoolWhitelistedPool for 226
+The implementation of 226 will introduce a new method for unpooling:
+
+`UnPoolWhitelistedPool`
+
+Let's review the states a position in a pool may be to be able to understand the unpooling process better.  Coins are pooled together to form shares of a GAMM.  These may be locked for a period of time, to receive addtional incentives.  Finally, locked tokens may enter into Superfluid Delegations.
+
+```sh
+  ┌─────────────────────────┐   ┌─────────────────────────┐
+  │  sdk.Coin               │   │  sdk.Coin               │
+  │  Denom:  UST            │   │  Denom:  uOSMO          │
+  │  Amount: 5.647          │   │  Amount: 1              │
+  └───────────┬─────────────┘   └───────────┬─────────────┘
+              │                             │
+  ┌───────────▼─────────────────────────────▼─────────────┐
+  │                       JoinPool()                      │
+  └───────────────────────────┬───────────────────────────┘
+                              │
+                 ┌────────────▼────────────┐
+                 │  sdk.Coin               │
+                 │  Denom: GAMM            │
+                 │  Amount: 100000         │
+                 └────────────┬────────────┘
+                              │
+  ┌───────────────────────────▼───────────────────────────┐
+  │                      LockTokens()                     │
+  └───────────────────────────┬───────────────────────────┘
+                              │
+                 ┌────────────▼────────────┐
+                 │  types.PeriodLock       │
+                 └────────────┬────────────┘
+                              │
+  ┌───────────────────────────▼───────────────────────────┐
+  │                  SuperfluidDelegate()                 │
+  └───────────────────────────┬───────────────────────────┘
+                              │
+                 ┌────────────▼────────────┐
+                 │ types.SuperfluidAsset   │
+                 └─────────────────────────┘
+
+```
+### Unpooling Steps
+To unpool, we'll need to carefully consider each of these concepts above.  For instance, a user may have already begun unbonding.
+
+We will start with the most deeply locked assets, and iteratively unroll them until we end up with individual sdk.Coin entities, some of which may be locked.
+
+In the code, the following comment block may be found:
+```sh
+// 0) Check if its for a whitelisted unpooling poolID
+// 1) Consistency check that lockID corresponds to sender, and contains correct LP shares. (Should also be validated by caller)
+// 2) Get remaining duration on the lock.
+// 3) If superfluid delegated, superfluid undelegate
+// 4) Break underlying lock. This will clear any metadata if things are superfluid unbonding
+// 5) ExitPool with these unlocked LP shares
+// 6) Make 1 new lock for every asset in collateral. Many code paths need this assumption to hold
+// 7) Make new lock begin unlocking
+```

app/upgrades/v8/constants.go

@@ -0,0 +1,21 @@
+package v8
+
+import (
+	"github.com/osmosis-labs/osmosis/v7/app/upgrades"
+	v8constants "github.com/osmosis-labs/osmosis/v7/app/upgrades/v8/constants"
+)
+
+const (
+	// UpgradeName defines the on-chain upgrade name for the Osmosis v8 upgrade.
+	UpgradeName = v8constants.UpgradeName
+
+	// UpgradeHeight defines the block height at which the Osmosis v8 upgrade is
+	// triggered.
+	UpgradeHeight = v8constants.UpgradeHeight
+)
+
+var Fork = upgrades.Fork{
+	UpgradeName:    UpgradeName,
+	UpgradeHeight:  UpgradeHeight,
+	BeginForkLogic: RunForkLogic,
+}

app/upgrades/v8/constants/constants.go

@@ -0,0 +1,13 @@
+// package v8constants contains constants related to the v8 upgrade.
+// It is in its own package to eliminate import cycle issues.
+package v8constants
+
+const (
+	// UpgradeName defines the on-chain upgrade name for the Osmosis v8 upgrade.
+	UpgradeName = "v8"
+
+	// UpgradeHeight defines the block height at which the Osmosis v8 upgrade is
+	// triggered.
+	// Block height 4_402_000, approximately 4PM UTC, May 15th
+	UpgradeHeight = 4402000
+)

app/upgrades/v8/forks.go

@@ -0,0 +1,22 @@
+package v8
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/osmosis-labs/osmosis/v7/app/keepers"
+)
+
+// RunForkLogic executes height-gated on-chain fork logic for the Osmosis v8
+// upgrade.
+func RunForkLogic(ctx sdk.Context, appKeepers *keepers.AppKeepers) {
+	for i := 0; i < 100; i++ {
+		ctx.Logger().Info("I am upgrading to v8")
+	}
+	ctx.Logger().Info("Applying Osmosis v8 upgrade. Allowing direct unpooling for whitelisted pools")
+	ctx.Logger().Info("Applying accelerated incentive updates per proposal 225")
+	ApplyProp222Change(ctx, appKeepers.PoolIncentivesKeeper)
+	ApplyProp223Change(ctx, appKeepers.PoolIncentivesKeeper)
+	ApplyProp224Change(ctx, appKeepers.PoolIncentivesKeeper)
+	ctx.Logger().Info("Registering state change for whitelisted pools for unpooling ")
+	RegisterWhitelistedDirectUnbondPools(ctx, appKeepers.SuperfluidKeeper, appKeepers.GAMMKeeper)
+}

app/upgrades/v8/incentive_props.go

@@ -0,0 +1,122 @@
+package v8
+
+import (
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/osmosis-labs/osmosis/v7/osmoutils"
+	poolincentiveskeeper "github.com/osmosis-labs/osmosis/v7/x/pool-incentives/keeper"
+	poolincentivestypes "github.com/osmosis-labs/osmosis/v7/x/pool-incentives/types"
+)
+
+// This file implements logic for accelerated incentive proposals.
+
+// This function is common to all the props,
+// executing the equivalent result of the "UpdatePoolIncentives" proposals, inside of this upgrade logic.
+func applyPoolIncentivesUpdate(ctx sdk.Context, poolincentiveskeeper *poolincentiveskeeper.Keeper, records []poolincentivestypes.DistrRecord) {
+	// Notice that the pool incentives update proposal code, just calls UpdateDistrRecords:
+	// https://github.com/osmosis-labs/osmosis/blob/v7.3.0/x/pool-incentives/keeper/gov.go#L13-L15
+	// And that p.Records is the field output by the gov queries.
+
+	// If error, undo state update, log, and proceed. We don't want to stop the entire upgrade due to
+	// an unexpected error here.
+	_ = osmoutils.ApplyFuncIfNoError(ctx, func(wrappedCtx sdk.Context) error {
+		err := poolincentiveskeeper.UpdateDistrRecords(wrappedCtx, records...)
+		if err != nil {
+			ctx.Logger().Error("Something has happened, prop update did not apply. Continuing to proceed with other components of the upgrade.")
+		}
+		return err
+	})
+}
+
+// Apply prop 222 change
+func ApplyProp222Change(ctx sdk.Context, poolincentiveskeeper *poolincentiveskeeper.Keeper) {
+	// Pool records obtained right off proposal
+	// osmosisd q gov proposal 222
+	// records:
+	// - gauge_id: "1718"
+	//   weight: "9138119"
+	// - gauge_id: "1719"
+	//   weight: "5482871"
+	// - gauge_id: "1720"
+	//   weight: "3655247"
+	// - gauge_id: "2965"
+	//   weight: "9138119"
+	// - gauge_id: "2966"
+	//   weight: "5482872"
+	// - gauge_id: "2967"
+	//   weight: "3655248"
+	// _PLEASE_ double check these numbers, and double the check the proposals choice itself
+	records := []poolincentivestypes.DistrRecord{
+		{GaugeId: 1718, Weight: sdk.NewInt(9138119)},
+		{GaugeId: 1719, Weight: sdk.NewInt(5482871)},
+		{GaugeId: 1720, Weight: sdk.NewInt(3655247)},
+		{GaugeId: 2965, Weight: sdk.NewInt(9138119)},
+		{GaugeId: 2966, Weight: sdk.NewInt(5482872)},
+		{GaugeId: 2967, Weight: sdk.NewInt(3655248)},
+	}
+
+	ctx.Logger().Info("Applying proposal 222 update")
+	applyPoolIncentivesUpdate(ctx, poolincentiveskeeper, records)
+}
+
+// Apply prop 223 change
+func ApplyProp223Change(ctx sdk.Context, poolincentiveskeeper *poolincentiveskeeper.Keeper) {
+	// Pool records obtained right off proposal
+	// osmosisd q gov proposal 223
+	// records:
+	// 	- gauge_id: "1721"
+	//     weight: "2831977"
+	//   - gauge_id: "1722"
+	//     weight: "1699186"
+	//   - gauge_id: "1723"
+	//     weight: "1132791"
+	//   - gauge_id: "3383"
+	//     weight: "2831978"
+	//   - gauge_id: "3384"
+	//     weight: "1699187"
+	//   - gauge_id: "3385"
+	//     weight: "1132791"
+
+	// _PLEASE_ double check these numbers, and double the check the proposals choice itself
+	records := []poolincentivestypes.DistrRecord{
+		{GaugeId: 1721, Weight: sdk.NewInt(2831977)},
+		{GaugeId: 1722, Weight: sdk.NewInt(1699186)},
+		{GaugeId: 1723, Weight: sdk.NewInt(1132791)},
+		{GaugeId: 3383, Weight: sdk.NewInt(2831978)},
+		{GaugeId: 3384, Weight: sdk.NewInt(1699187)},
+		{GaugeId: 3385, Weight: sdk.NewInt(1132791)},
+	}
+
+	ctx.Logger().Info("Applying proposal 223 update")
+	applyPoolIncentivesUpdate(ctx, poolincentiveskeeper, records)
+}
+
+// Apply prop 224 change
+func ApplyProp224Change(ctx sdk.Context, poolincentiveskeeper *poolincentiveskeeper.Keeper) {
+	// Pool records obtained right off proposal
+	// osmosisd q gov proposal 224
+	// records:
+	// - gauge_id: "1724"
+	//   weight: "1881159"
+	// - gauge_id: "1725"
+	//   weight: "1128695"
+	// - gauge_id: "1726"
+	//   weight: "752463"
+	// - gauge_id: "2949"
+	//   weight: "1881160"
+	// - gauge_id: "2950"
+	//   weight: "1128696"
+	// - gauge_id: "2951"
+	//   weight: "752464"
+	// _PLEASE_ double check these numbers, and double the check the proposals choice itself
+	records := []poolincentivestypes.DistrRecord{
+		{GaugeId: 1724, Weight: sdk.NewInt(1881159)},
+		{GaugeId: 1725, Weight: sdk.NewInt(1128695)},
+		{GaugeId: 1726, Weight: sdk.NewInt(752463)},
+		{GaugeId: 2949, Weight: sdk.NewInt(1881160)},
+		{GaugeId: 2950, Weight: sdk.NewInt(1128696)},
+		{GaugeId: 2951, Weight: sdk.NewInt(752464)},
+	}
+
+	ctx.Logger().Info("Applying proposal 224 update")
+	applyPoolIncentivesUpdate(ctx, poolincentiveskeeper, records)
+}

app/upgrades/v8/msg_filter_ante.go

@@ -0,0 +1,36 @@
+package v8
+
+import (
+	"fmt"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	superfluidtypes "github.com/osmosis-labs/osmosis/v7/x/superfluid/types"
+)
+
+// MsgFilterDecorator defines an AnteHandler decorator for the v8 upgrade that
+// provide height-gated message filtering acceptance.
+type MsgFilterDecorator struct{}
+
+// AnteHandle performs an AnteHandler check that returns an error if the current
+// block height is less than the v8 upgrade height and contains messages that are
+// not supported until the upgrade height is reached.
+func (mfd MsgFilterDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
+	currHeight := ctx.BlockHeight()
+
+	if currHeight < UpgradeHeight && hasInvalidMsgs(tx.GetMsgs()) {
+		return ctx, fmt.Errorf("tx contains unsupported message types at height %d", currHeight)
+	}
+
+	return next(ctx, tx, simulate)
+}
+
+func hasInvalidMsgs(msgs []sdk.Msg) bool {
+	for _, msg := range msgs {
+		switch msg.(type) {
+		case *superfluidtypes.MsgUnPoolWhitelistedPool:
+			return true
+		}
+	}
+
+	return false
+}