feat: close swaps

Author: g-luca

app.go

@@ -476,7 +476,11 @@ func (app *App) RegisterUpgradeHandler() error {
 			app.ModuleManager,
 			app.Configurator(),
 			app.Logger(),
-			app.IBCKeeper.ClientKeeper,
+			app.AccountKeeper.AddressCodec(),
+			app.AuthorityKeeper,
+			app.BankKeeper,
+			app.DollarKeeper,
+			app.SwapKeeper,
 		),
 	)
 

app.yaml

@@ -13,7 +13,6 @@ modules:
           staking,
           ibc,
           authz,
-          swap,
           ratelimit,
           dollar,
         ]

e2e/upgrade_test.go

@@ -27,12 +27,12 @@ func TestChainUpgrade(t *testing.T) {
 		t.Skip("skipping test in short mode.")
 	}
 
-	genesisVersion := "v11.4.0"
+	genesisVersion := "v11.5.0"
 
 	upgrades := []e2e.ChainUpgrade{
 		{
 			Image:       e2e.LocalImages[0],
-			UpgradeName: "v11.5.0",
+			UpgradeName: "v11.6.0",
 		},
 	}
 

go.mod

@@ -392,3 +392,5 @@ replace github.com/cosmos/ibc-apps/middleware/packet-forward-middleware/v8 => gi
 
 // use cosmos compatible syndtr/goleveldb
 replace github.com/syndtr/goleveldb => github.com/syndtr/goleveldb v1.0.1-0.20210819022825-2ae1ddf74ef7
+
+replace swap.noble.xyz => ../swap

go.sum

@@ -2197,5 +2197,3 @@ sigs.k8s.io/yaml v1.1.0/go.mod h1:UJmg0vDUVViEyp3mgSv9WPwZCDxu4rQW1olrI1uml+o=
 sigs.k8s.io/yaml v1.4.0 h1:Mk1wCc2gy/F0THH0TAp1QYyJNzRm2KCLy3o5ASXVI5E=
 sigs.k8s.io/yaml v1.4.0/go.mod h1:Ejl7/uTz7PSA4eKMyQCUTnhZYNmLIl+5c2lQPGR2BPY=
 sourcegraph.com/sourcegraph/appdash v0.0.0-20190731080439-ebfcffb1b5c0/go.mod h1:hI742Nqp5OhwiqlzhgfbWU4mW4yO10fP+LoT9WOswdU=
-swap.noble.xyz v1.0.2 h1:ICgXPnXT1ztxE3OzbforQkc0wBjPZ3rbfRllo0GMkpk=
-swap.noble.xyz v1.0.2/go.mod h1:MGzb9tYS7tKYGGGQ0OmUR46cKoCdDpcYR50cvj3Jzms=

upgrade/constants.go

@@ -17,7 +17,7 @@
 package upgrade
 
 // UpgradeName is the name of this specific software upgrade used on-chain.
-const UpgradeName = "v11.5.0"
+const UpgradeName = "v11.6.0"
 
 // TestnetChainID is the Chain ID of the Noble testnet.
 const TestnetChainID = "grand-1"

upgrade/upgrade.go

@@ -18,19 +18,36 @@ package upgrade
 
 import (
 	"context"
+	"errors"
+	"fmt"
+	"time"
 
+	"cosmossdk.io/core/address"
 	"cosmossdk.io/log"
+	"cosmossdk.io/math"
 	upgradetypes "cosmossdk.io/x/upgrade/types"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/module"
-	clientkeeper "github.com/cosmos/ibc-go/v8/modules/core/02-client/keeper"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	bankkeeper "github.com/cosmos/cosmos-sdk/x/bank/keeper"
+	swaptypes "swap.noble.xyz/types"
+
+	dollarkeeper "dollar.noble.xyz/v2/keeper"
+	dollartypes "dollar.noble.xyz/v2/types"
+	authoritykeeper "github.com/noble-assets/authority/keeper"
+	swapkeeper "swap.noble.xyz/keeper"
+	stableswaptypes "swap.noble.xyz/types/stableswap"
 )
 
 func CreateUpgradeHandler(
 	mm *module.Manager,
 	cfg module.Configurator,
 	logger log.Logger,
-	clientKeeper clientkeeper.Keeper,
+	addressCodec address.Codec,
+	authorityKeeper *authoritykeeper.Keeper,
+	bankKeeper bankkeeper.Keeper,
+	dollarKeeper *dollarkeeper.Keeper,
+	swapKeeper *swapkeeper.Keeper,
 ) upgradetypes.UpgradeHandler {
 	return func(ctx context.Context, _ upgradetypes.Plan, vm module.VersionMap) (module.VersionMap, error) {
 		vm, err := mm.RunMigrations(ctx, cfg, vm)
@@ -40,18 +57,164 @@ func CreateUpgradeHandler(
 
 		sdkCtx := sdk.UnwrapSDKContext(ctx)
 
-		// In IBC-Go v8.7.0, the MsgRecoverClient message does not support the
-		// LegacyAminoJSON signing mode, preventing recovery via the Noble
-		// Maintenance Multisig. As a result, expired clients on mainnet must
-		// be manually recovered as part of a software upgrade.
 		if sdkCtx.ChainID() == MainnetChainID {
-			// Substitute the IBC light client for the coreum-mainnet-1 chain.
-			err = clientKeeper.RecoverClient(sdkCtx, "07-tendermint-71", "07-tendermint-226")
-			if err != nil {
-				logger.Error("failed to recover coreum-mainnet-1 client", "error", err)
+			if err = claimSwapPoolsYield(
+				ctx,
+				logger,
+				addressCodec,
+				authorityKeeper,
+				bankKeeper,
+				dollarKeeper,
+				swapKeeper,
+			); err != nil {
+				return vm, err
+			}
+
+			if err = claimSwapPoolsProtocolFees(
+				ctx,
+				logger,
+				swapKeeper,
+				"noble1c3chgrgr3xcktkpvezxz7g9kl7h64x8tdyd8ng",
+			); err != nil {
+				return vm, err
+			}
+
+			if err = closeSwapPools(ctx, logger, swapKeeper); err != nil {
+				return vm, err
 			}
 		}
 
 		return vm, nil
 	}
 }
+
+// claimSwapPoolsYield claims the $USDN yield accrued inside the Noble Swap
+// pools and sends it to the authority address.
+func claimSwapPoolsYield(
+	ctx context.Context,
+	logger log.Logger,
+	addressCodec address.Codec,
+	authorityKeeper *authoritykeeper.Keeper,
+	bankKeeper bankkeeper.Keeper,
+	dollarKeeper *dollarkeeper.Keeper,
+	swapKeeper *swapkeeper.Keeper,
+) error {
+	authority, err := authorityKeeper.Owner.Get(ctx)
+	if err != nil {
+		return errors.New("unable to get underlying authority address from state")
+	}
+	authorityBz, err := addressCodec.StringToBytes(authority)
+	if err != nil {
+		return errors.New("unable to decode underlying authority address")
+	}
+
+	dollarServer := dollarkeeper.NewMsgServer(dollarKeeper)
+
+	pools := swapKeeper.GetPools(ctx)
+	for _, pool := range pools {
+		yield, address, err := dollarKeeper.GetYield(ctx, pool.Address)
+		if err != nil {
+			return fmt.Errorf("unable to get yield for pool %d", pool.Id)
+		}
+
+		_, err = dollarServer.ClaimYield(ctx, &dollartypes.MsgClaimYield{Signer: pool.Address})
+		if err != nil {
+			return fmt.Errorf("unable to claim yield for pool %d", pool.Id)
+		}
+
+		err = bankKeeper.SendCoins(ctx, address, authorityBz, sdk.NewCoins(sdk.NewCoin(dollarKeeper.GetDenom(), yield)))
+		if err != nil {
+			return fmt.Errorf("unable to transfer yield for pool %d", pool.Id)
+		}
+
+		logger.Info("claimed swap pool yield", "pool", pool.Id, "yield", yield)
+	}
+
+	return nil
+}
+
+// claimSwapPoolsProtocolFees claims the protocol fees accrued inside the Noble Swap
+// pools.
+func claimSwapPoolsProtocolFees(
+	ctx context.Context,
+	logger log.Logger,
+	swapKeeper *swapkeeper.Keeper,
+	protocolFeesReceiver string,
+) error {
+	swapServer := swapkeeper.NewMsgServer(swapKeeper)
+
+	_, err := swapServer.WithdrawProtocolFees(ctx, &swaptypes.MsgWithdrawProtocolFees{
+		Signer: authtypes.NewModuleAddressOrBech32Address("authority").String(),
+		To:     protocolFeesReceiver,
+	})
+	if err != nil {
+		logger.Error(err.Error())
+	}
+
+	logger.Info("claimed swap protocol fees")
+
+	return nil
+}
+
+func closeSwapPools(ctx context.Context, logger log.Logger, swapKeeper *swapkeeper.Keeper) error {
+	swapServer := swapkeeper.NewStableSwapMsgServer(swapKeeper)
+
+	// Iterate all the users that currently have bonded shares, which reflects all the liquidity providers.
+	itr, err := swapKeeper.Stableswap.UsersTotalBondedShares.Iterate(ctx, nil)
+	if err != nil {
+		return err
+	}
+	for ; itr.Valid(); itr.Next() {
+		key, _ := itr.Key()
+		poolId := key.K1()
+		userAddress := key.K2()
+
+		amount, amountErr := itr.Value()
+		if amountErr != nil {
+			return amountErr
+		}
+
+		// Skip users that have already removed all liquidity.
+		if !amount.IsPositive() {
+			continue
+		}
+
+		if _, err = swapServer.RemoveLiquidity(ctx, &stableswaptypes.MsgRemoveLiquidity{
+			Signer:     userAddress,
+			PoolId:     poolId,
+			Percentage: math.LegacyNewDec(100), // 100%
+		}); err != nil {
+			return err
+		}
+
+		// In order to trigger an immediate execution we need to update all the unbonding with an EndTime in the past.
+		unbondEndTime := sdk.UnwrapSDKContext(ctx).HeaderInfo().Time.Add(-24 * 3 * time.Hour)
+		userTotalAmount := sdk.NewCoins()
+		for _, position := range swapKeeper.Stableswap.GetUnbondingPositionsByProvider(ctx, userAddress) {
+			if err = swapKeeper.Stableswap.RemoveUnbondingPosition(ctx, position.Timestamp, position.Address, position.PoolId); err != nil {
+				return err
+			}
+			if err = swapKeeper.Stableswap.SetUnbondingPosition(ctx, unbondEndTime.Unix(), position.Address, position.PoolId, stableswaptypes.UnbondingPosition{
+				Shares:  position.UnbondingPosition.Shares,
+				Amount:  position.UnbondingPosition.Amount,
+				EndTime: unbondEndTime,
+			}); err != nil {
+				return err
+			}
+			userTotalAmount = userTotalAmount.Add(position.UnbondingPosition.Amount...)
+		}
+		logger.Info("removing liquidy", "pool", poolId, "address", userAddress, "shares", amount.String(), "amount", userTotalAmount.String())
+	}
+
+	// Execute the BeginBlocker.
+	if err = swapKeeper.BeginBlocker(ctx); err != nil {
+		return err
+	}
+
+	// As last step, set the pool paused, no further interactions are allowed.
+	if err = swapKeeper.SetPaused(ctx, 0, true); err != nil {
+		return err
+	}
+
+	return nil
+}