Merge branch 'main' into adam/e2e-upgrade

.gitignore

@@ -197,6 +197,7 @@ $RECYCLE.BIN/
 /.idea/
 /artifacts/
 /.vscode/
+/.VSCodeCounter/
 /scripts/local/
 /x/incentives/keeper/osmosis_testing/
 tools-stamp

README.md

@@ -1,13 +1,39 @@
 # Osmosis
-_(Note: This repository is under active development)_
 
-Osmosis is a fair-launched, customizable automated market maker for interchain assets that allows the creation and management of non-custodial, self-balancing, interchain token index similar to one of Balancer.
-
-Inspired by [Balancer](http://balancer.finance/whitepaper) and Sunny Aggarwal's '[DAOfying Uniswap Automated Market Maker Pools](https://www.sunnya97.com/blog/daoifying-uniswap-automated-market-maker-pools)', the goal for Osmosis is to provide the best-in-class tools that extend the use of AMMs within the Cosmos ecosystem beyond traditional token swap-type use cases. Bonding curves, while have found its primary use case in decentralized exchange mechanisms, its potential use case can be further extended through the customizability that Osmosis offers. Through the customizability offered by Osmosis such custom-curve AMMs, dynamic adjustments of swap fees, multi-token liquidity pools–the AMM can offer decentralized formation of token fundraisers, interchain staking, options market, and more for the Cosmos ecosystem.
-
-Whereas most Cosmos zones have focused the  ir incentive scheme on the delegators, Osmosis attempts to align the interests of multiple stakeholders of the ecosystem such as LPs, DAO members, as well as delegators. One mechanism that is introduced is how staked liquidity providers have sovereign ownership over their pools, and through the pool governance process allow them to adjust the parameters depending on the pool’s competition and market conditions. Osmosis is a sovereign Cosmos zone that derives its sovereignty not only from its application-specific blockchain architecture but also the collective sovereignty of the LPs that has aligned interest to different tokens that they are providing liquidity for.
+[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://img.shields.io/badge/repo%20status-Active-green.svg?style=flat-square)](https://www.repostatus.org/#active)
+[![GoDoc](https://img.shields.io/badge/godoc-reference-blue?style=flat-square&logo=go)](https://godoc.org/github.com/osmosis-labs/osmosis)
+[![Go Report Card](https://goreportcard.com/badge/github.com/osmosis-labs/osmosis?style=flat-square)](https://goreportcard.com/report/github.com/osmosis-labs/osmosis)
+[![Version](https://img.shields.io/github/tag/osmosis-labs/osmosis.svg?style=flat-square)](https://github.com/osmosis-labs/osmosis/releases/latest)
+[![License: Apache-2.0](https://img.shields.io/github/license/osmosis-labs/osmosis.svg?style=flat-square)](https://github.com/osmosis-labs/osmosis/blob/main/LICENSE)
+[![Lines Of Code](https://img.shields.io/tokei/lines/github/osmosis-labs/osmosis?style=flat-square)](https://github.com/osmosis-labs/osmosis)
+[![GitHub Super-Linter](https://img.shields.io/github/workflow/status/osmosis-labs/osmosis/Lint?style=flat-square&label=Lint)](https://github.com/marketplace/actions/super-linter)
+
+Osmosis is a fair-launched, customizable automated market maker for interchain
+assets that allows the creation and management of non-custodial, self-balancing,
+interchain token index similar to one of Balancer.
+
+Inspired by [Balancer](http://balancer.finance/whitepaper) and Sunny Aggarwal's '[DAOfying Uniswap Automated Market Maker Pools](https://www.sunnya97.com/blog/daoifying-uniswap-automated-market-maker-pools)', the goal for Osmosis is to
+provide the best-in-class tools that extend the use of AMMs within the Cosmos
+ecosystem beyond traditional token swap-type use cases. Bonding curves, while
+have found its primary use case in decentralized exchange mechanisms, its potential
+use case can be further extended through the customizability that Osmosis offers.
+Through the customizability offered by Osmosis such custom-curve AMMs, dynamic
+adjustments of swap fees, multi-token liquidity pools–the AMM can offer decentralized
+formation of token fundraisers, interchain staking, options market, and more for
+the Cosmos ecosystem.
+
+Whereas most Cosmos zones have focused the  ir incentive scheme on the delegators,
+Osmosis attempts to align the interests of multiple stakeholders of the ecosystem
+such as LPs, DAO members, as well as delegators. One mechanism that is introduced
+is how staked liquidity providers have sovereign ownership over their pools, and
+through the pool governance process allow them to adjust the parameters depending
+on the pool’s competition and market conditions. Osmosis is a sovereign Cosmos
+zone that derives its sovereignty not only from its application-specific blockchain
+architecture but also the collective sovereignty of the LPs that has aligned
+interest to different tokens that they are providing liquidity for.
 
 ## System Requirements
+
 This system spec has been tested by many users and validators and found to be comfortable:
 
 * Quad Core or larger AMD or Intel (amd64) CPU
@@ -19,6 +45,7 @@ This system spec has been tested by many users and validators and found to be co
 You can run Osmosis on lower-spec hardware for each component, but you may find that it is not highly performant or prone to crashing.
 
 ## Documentation
+
 For the most up to date documentation please visit [docs.osmosis.zone](https://docs.osmosis.zone/)
 
 ## Joining the Mainnet
@@ -28,26 +55,75 @@ For the most up to date documentation please visit [docs.osmosis.zone](https://d
 Thank you for supporting a healthy blockchain network and community by running an Osmosis node!
 
 ## Why Osmosis?
-### On customizability of liquidity pools
-Most major AMMs limit the changeable parameters of liquidity pools. For example, Uniswap only allows the creation of a two-token pool of equal ratio with the swap fee of 0.3%. The simplicity of Uniswap protocol allowed quick onboarding of the average user that previously had little to no experience in market making.
 
-However, as the DeFi market size grows and market participants such as arbitrageurs and liquidity providers mature, the need for liquidity pools to react to market conditions becomes apparent. The optimal swap fee for a AMM trade may depend on various factors such as block times, slippage, transaction fee, market volatility and more. There is no one-size-fits-all solution as the mix of characteristics of blockchain protocol, tokens in the liquidity pool, market conditions, and others can change the optimal strategy for the liquidity providers and the market makers to carry out.
+### On customizability of liquidity pools
 
-The tools Osmosis provides allow the market participants to self-identify opportunities and allow them to react by adjusting the various parameters. An optimal equilibrium between fee and liquidity can be reached through autonomous experiments and iterations, rather than a setting a centrally planned 'most acceptable compromise' value. This extends the addressable market for AMMs and bonding curves to beyond simple token swaps, as limitation on the customizability of liquidity pools may have been the inhibiting factor for more experimental use-cases of AMMs.
+Most major AMMs limit the changeable parameters of liquidity pools. For example,
+Uniswap only allows the creation of a two-token pool of equal ratio with the swap
+fee of 0.3%. The simplicity of Uniswap protocol allowed quick onboarding of the
+average user that previously had little to no experience in market making.
+
+However, as the DeFi market size grows and market participants such as arbitrageurs
+and liquidity providers mature, the need for liquidity pools to react to market
+conditions becomes apparent. The optimal swap fee for a AMM trade may depend on
+various factors such as block times, slippage, transaction fee, market volatility
+and more. There is no one-size-fits-all solution as the mix of characteristics of
+blockchain protocol, tokens in the liquidity pool, market conditions, and others
+can change the optimal strategy for the liquidity providers and the market makers
+to carry out.
+
+The tools Osmosis provides allow the market participants to self-identify opportunities
+and allow them to react by adjusting the various parameters. An optimal equilibrium
+between fee and liquidity can be reached through autonomous experiments and iterations,
+rather than a setting a centrally planned 'most acceptable compromise' value. This
+extends the addressable market for AMMs and bonding curves to beyond simple token
+swaps, as limitation on the customizability of liquidity pools may have been the
+inhibiting factor for more experimental use-cases of AMMs.
 
 ### Self-governing liquidity pools
-As important as the ability to change the parameters of a liquidity pool is, the feature would mean very little without a method to coordinate a decision amongst the stakeholders. The pool governance feature of Osmosis allows a diverse spectrum of liquidity pools with risk tolerance and strategies to not only exist, but evolve.
-
-In Osmosis, the liquidity pool shares are not only used to calculate the fractional ownership of a liquidity pool, but also the right to participate in the strategic decision making of the liquidity pool as well. To incentivize long-term liquidity commitment, shares must be locked up for an extended period. Longer term commitments are awarded by additional voting power / additional liquidity mining revenue. The long-term liquidity commitment by the liquidity providers prevent the impact of potential vampire attacks, where ownership of the shares are delegated and potentially used to migrate liquidity to an external AMM. This provides equity of power amongst liquidity providers, where those with greater skin-in-the-game are given their rightful power to steer the strategic direction of its pool in proportion to the risk they are taking with their assets.
 
-As AMMs mostly guarantee a level of constant total value output, those who may disagree with the changes made to the pool are able to withdraw their funds with little to no loss of their principals. As Osmosis expects the market to self-discover the optimal value of each adjustable parameter, if a significant dissenting opinion exists–they are able to start a competing liquidity pool with their own strategy.
+As important as the ability to change the parameters of a liquidity pool is, the
+feature would mean very little without a method to coordinate a decision amongst
+the stakeholders. The pool governance feature of Osmosis allows a diverse spectrum
+of liquidity pools with risk tolerance and strategies to not only exist, but evolve.
+
+In Osmosis, the liquidity pool shares are not only used to calculate the fractional
+ownership of a liquidity pool, but also the right to participate in the strategic
+decision making of the liquidity pool as well. To incentivize long-term liquidity
+commitment, shares must be locked up for an extended period. Longer term commitments
+are awarded by additional voting power / additional liquidity mining revenue. The
+long-term liquidity commitment by the liquidity providers prevent the impact of
+potential vampire attacks, where ownership of the shares are delegated and potentially
+used to migrate liquidity to an external AMM. This provides equity of power amongst
+liquidity providers, where those with greater skin-in-the-game are given their
+rightful power to steer the strategic direction of its pool in proportion to the
+risk they are taking with their assets.
+
+As AMMs mostly guarantee a level of constant total value output, those who may
+disagree with the changes made to the pool are able to withdraw their funds with
+little to no loss of their principals. As Osmosis expects the market to self-discover
+the optimal value of each adjustable parameter, if a significant dissenting opinion
+exists–they are able to start a competing liquidity pool with their own strategy.
 
 ### AMM as serviced infrastructure
-The number and complexity of decentralized financial products are consistently increasing. Instruments such as pegged assets, derivatives, options, and tokenized leveraged positions each have their own characteristics that produce optimal market efficiency when paired with the correct bonding curve. That being said, the traditional notion of AMMs have evolved around putting the AMM first, and the financial product being traded second.
 
-As AMMs substantially increase the market accessibility for these instruments, assets with diverse characteristics either had to:
+The number and complexity of decentralized financial products are consistently
+increasing. Instruments such as pegged assets, derivatives, options, and tokenized
+leveraged positions each have their own characteristics that produce optimal market
+efficiency when paired with the correct bonding curve. That being said, the traditional
+notion of AMMs have evolved around putting the AMM first, and the financial product
+being traded second.
+
+As AMMs substantially increase the market accessibility for these instruments,
+assets with diverse characteristics either had to:
+
 1. Compromise efficiency and trade on existing AMMs with non-optimal bonding curves or
 2. Take on the massive task of building one's own AMM that is able to maximize efficiency
 
-To solve this issue, Osmosis introduces the idea of an 'AMM as a serviced infrastructure'. Fairly often, adjustment of the value function and a few additional parameters are all that's needed to provide a highly-efficient, highly-accessible AMM for the majority of decentralized financial instruments. By providing the ability for the creator of the pool to simply define the bonding curve value function and reuse the majority of the key AMM infrastructure, the barrier to creating a tailor-made and efficient automated market maker can be reduced.
-
+To solve this issue, Osmosis introduces the idea of an 'AMM as a serviced infrastructure'.
+Fairly often, adjustment of the value function and a few additional parameters are
+all that's needed to provide a highly-efficient, highly-accessible AMM for the
+majority of decentralized financial instruments. By providing the ability for the
+creator of the pool to simply define the bonding curve value function and reuse
+the majority of the key AMM infrastructure, the barrier to creating a tailor-made
+and efficient automated market maker can be reduced.

app/apptesting/test_suite.go

@@ -86,6 +86,10 @@ func (s *KeeperTestHelper) SetupValidator(bondStatus stakingtypes.BondStatus) sd
 	return valAddr
 }
 
+func (s *KeeperTestHelper) SetupTokenFactory() {
+	s.App.TokenFactoryKeeper.CreateModuleAccount(s.Ctx)
+}
+
 func (s *KeeperTestHelper) BeginNewBlock(executeNextEpoch bool) {
 	var valAddr []byte
 

app/keepers/keepers.go

@@ -63,6 +63,8 @@ import (
 	"github.com/osmosis-labs/osmosis/v7/x/superfluid"
 	superfluidkeeper "github.com/osmosis-labs/osmosis/v7/x/superfluid/keeper"
 	superfluidtypes "github.com/osmosis-labs/osmosis/v7/x/superfluid/types"
+	tokenfactorykeeper "github.com/osmosis-labs/osmosis/v7/x/tokenfactory/keeper"
+	tokenfactorytypes "github.com/osmosis-labs/osmosis/v7/x/tokenfactory/types"
 	"github.com/osmosis-labs/osmosis/v7/x/txfees"
 	txfeeskeeper "github.com/osmosis-labs/osmosis/v7/x/txfees/keeper"
 	txfeestypes "github.com/osmosis-labs/osmosis/v7/x/txfees/types"
@@ -103,6 +105,7 @@ type AppKeepers struct {
 	SuperfluidKeeper     *superfluidkeeper.Keeper
 	GovKeeper            *govkeeper.Keeper
 	WasmKeeper           *wasm.Keeper
+	TokenFactoryKeeper   *tokenfactorykeeper.Keeper
 	// transfer module
 	TransferModule transfer.AppModule
 
@@ -307,6 +310,14 @@ func (appKeepers *AppKeepers) InitNormalKeepers(
 	)
 	appKeepers.TxFeesKeeper = &txFeesKeeper
 
+	tokenFactoryKeeper := tokenfactorykeeper.NewKeeper(
+		appCodec,
+		appKeepers.keys[tokenfactorytypes.StoreKey],
+		appKeepers.AccountKeeper,
+		appKeepers.BankKeeper.WithMintCoinsRestriction(tokenfactorytypes.NewTokenFactoryDenomMintCoinsRestriction()),
+	)
+	appKeepers.TokenFactoryKeeper = &tokenFactoryKeeper
+
 	// The last arguments can contain custom message handlers, and custom query handlers,
 	// if we want to allow any custom callbacks
 	supportedFeatures := "iterator,staking,stargate,osmosis"
@@ -422,6 +433,7 @@ func (appKeepers *AppKeepers) initParamsKeeper(appCodec codec.BinaryCodec, legac
 	paramsKeeper.Subspace(superfluidtypes.ModuleName)
 	paramsKeeper.Subspace(gammtypes.ModuleName)
 	paramsKeeper.Subspace(wasm.ModuleName)
+	paramsKeeper.Subspace(tokenfactorytypes.ModuleName)
 
 	return paramsKeeper
 }
@@ -509,5 +521,6 @@ func KVStoreKeys() []string {
 		superfluidtypes.StoreKey,
 		bech32ibctypes.StoreKey,
 		wasm.StoreKey,
+		tokenfactorytypes.StoreKey,
 	}
 }

app/keepers/modules.go

@@ -37,6 +37,7 @@ import (
 	poolincentivesclient "github.com/osmosis-labs/osmosis/v7/x/pool-incentives/client"
 	superfluid "github.com/osmosis-labs/osmosis/v7/x/superfluid"
 	superfluidclient "github.com/osmosis-labs/osmosis/v7/x/superfluid/client"
+	"github.com/osmosis-labs/osmosis/v7/x/tokenfactory"
 	"github.com/osmosis-labs/osmosis/v7/x/txfees"
 )
 
@@ -79,6 +80,7 @@ var AppModuleBasics = []module.AppModuleBasic{
 	poolincentives.AppModuleBasic{},
 	epochs.AppModuleBasic{},
 	superfluid.AppModuleBasic{},
+	tokenfactory.AppModuleBasic{},
 	bech32ibc.AppModuleBasic{},
 	wasm.AppModuleBasic{},
 }

app/modules.go

@@ -57,6 +57,8 @@ import (
 	poolincentivestypes "github.com/osmosis-labs/osmosis/v7/x/pool-incentives/types"
 	superfluid "github.com/osmosis-labs/osmosis/v7/x/superfluid"
 	superfluidtypes "github.com/osmosis-labs/osmosis/v7/x/superfluid/types"
+	"github.com/osmosis-labs/osmosis/v7/x/tokenfactory"
+	tokenfactorytypes "github.com/osmosis-labs/osmosis/v7/x/tokenfactory/types"
 	"github.com/osmosis-labs/osmosis/v7/x/txfees"
 	txfeestypes "github.com/osmosis-labs/osmosis/v7/x/txfees/types"
 )
@@ -79,6 +81,7 @@ var moduleAccountPermissions = map[string][]string{
 	txfeestypes.ModuleName:                   nil,
 	txfeestypes.NonNativeFeeCollectorName:    nil,
 	wasm.ModuleName:                          {authtypes.Burner},
+	tokenfactorytypes.ModuleName:             {authtypes.Minter, authtypes.Burner},
 }
 
 // appModules return modules to initialize module manager.
@@ -129,6 +132,7 @@ func appModules(
 			app.GAMMKeeper,
 			app.EpochsKeeper,
 		),
+		tokenfactory.NewAppModule(appCodec, *app.TokenFactoryKeeper, app.AccountKeeper, app.BankKeeper),
 		bech32ibc.NewAppModule(appCodec, *app.Bech32IBCKeeper),
 	}
 }
@@ -162,6 +166,7 @@ func orderBeginBlockers() []string {
 		incentivestypes.ModuleName,
 		lockuptypes.ModuleName,
 		poolincentivestypes.ModuleName,
+		tokenfactorytypes.ModuleName,
 		// superfluid must come after distribution and epochs
 		superfluidtypes.ModuleName,
 		bech32ibctypes.ModuleName,
@@ -205,6 +210,7 @@ var modulesOrderInitGenesis = []string{
 	bech32ibctypes.ModuleName, // comes after ibctransfertypes
 	poolincentivestypes.ModuleName,
 	superfluidtypes.ModuleName,
+	tokenfactorytypes.ModuleName,
 	incentivestypes.ModuleName,
 	epochstypes.ModuleName,
 	lockuptypes.ModuleName,
@@ -251,6 +257,7 @@ func simulationModules(
 			app.GAMMKeeper,
 			app.EpochsKeeper,
 		),
+		tokenfactory.NewAppModule(appCodec, *app.TokenFactoryKeeper, app.AccountKeeper, app.BankKeeper),
 		app.TransferModule,
 	}
 }

app/upgrades/v8/constants.go

@@ -4,6 +4,8 @@ import (
 	"github.com/osmosis-labs/osmosis/v7/app/upgrades"
 
 	store "github.com/cosmos/cosmos-sdk/store/types"
+
+	tokenfactorytypes "github.com/osmosis-labs/osmosis/v7/x/tokenfactory/types"
 )
 
 // UpgradeName defines the on-chain upgrade name for the Osmosis v7 upgrade.
@@ -17,6 +19,7 @@ var Upgrade = upgrades.Upgrade{
 	UpgradeName:          UpgradeName,
 	CreateUpgradeHandler: CreateUpgradeHandler,
 	StoreUpgrades: store.StoreUpgrades{
+		Added:   []string{tokenfactorytypes.ModuleName},
 		Deleted: []string{ClaimsModuleName},
 	},
 }