osmosis-labs · pysel · Jul 9, 2023 · Mar 23, 2023 · Mar 24, 2023 · Mar 25, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,8 +45,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Features
 
 * [#6468](https://github.com/osmosis-labs/osmosis/pull/6468) feat: remove osmo multihop discount
-* [#6420](https://github.com/osmosis-labs/osmosis/pull/6420) feat[CL]: Creates a governance set whitelist of addresses that can bypass the normal pool creation restrictions on concentrated liquidity pools
-* [#6632](https://github.com/osmosis-labs/osmosis/pull/6632) Taker fee bypass whitelist
+* [#6420](https://github.com/osmosis-labs/osmosis/pull/6420) feat[CL]: creates a governance set whitelist of addresses that can bypass the normal pool creation restrictions on concentrated liquidity pools
+* [#4713](https://github.com/osmosis-labs/osmosis/pull/4713) feat: allow rebonding of unbonding tokens
+* [#6632](https://github.com/osmosis-labs/osmosis/pull/6632) feat: taker fee bypass whitelist
 
 ### State Breaking
 

diff --git a/go.sum b/go.sum
@@ -1243,7 +1243,6 @@ github.com/twitchyliquid64/golang-asm v0.15.1 h1:SU5vSMR7hnwNxj24w34ZyCi/FmDZTkS
 github.com/twitchyliquid64/golang-asm v0.15.1/go.mod h1:a1lVb/DtPvCB8fslRZhAngC2+aY1QWCk3Cedj/Gdt08=
 github.com/tyler-smith/go-bip39 v1.0.1-0.20181017060643-dbb3b84ba2ef/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs=
 github.com/tyler-smith/go-bip39 v1.0.2/go.mod h1:sJ5fKU0s6JVwZjjcUEX2zFOnvq0ASQ2K9Zr6cf67kNs=
-github.com/ugorji/go v1.1.7 h1:/68gy2h+1mWMrwZFeD1kQialdSzAb432dtpeJ42ovdo=
 github.com/ugorji/go v1.1.7/go.mod h1:kZn38zHttfInRq0xu/PH0az30d+z6vm202qpg1oXVMw=
 github.com/ugorji/go/codec v0.0.0-20181204163529-d75b2dcb6bc8/go.mod h1:VFNgLljTbGfSG7qAOspJ7OScBnGdDN/yBr0sguwnwf0=
 github.com/ugorji/go/codec v1.1.7/go.mod h1:Ax+UKWsSmolVDwsd+7N3ZtXu+yMGCf907BLYF3GoBXY=

diff --git a/osmoutils/go.mod b/osmoutils/go.mod
@@ -107,6 +107,7 @@ require (
 	github.com/rs/cors v1.8.2 // indirect
 	github.com/rs/zerolog v1.27.0 // indirect
 	github.com/sasha-s/go-deadlock v0.3.1 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/afero v1.9.5 // indirect
 	github.com/spf13/cast v1.5.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect

diff --git a/proto/osmosis/lockup/tx.proto b/proto/osmosis/lockup/tx.proto
@@ -24,6 +24,7 @@ service Msg {
   // SetRewardReceiverAddress edits the reward receiver for the given lock ID
   rpc SetRewardReceiverAddress(MsgSetRewardReceiverAddress)
       returns (MsgSetRewardReceiverAddressResponse);
+  rpc RebondTokens(MsgRebondTokens) returns (MsgRebondTokensResponse);
 }
 
 message MsgLockTokens {
@@ -112,4 +113,10 @@ message MsgSetRewardReceiverAddress {
   string reward_receiver = 3
       [ (gogoproto.moretags) = "yaml:\"reward_receiver\"" ];
 }
-message MsgSetRewardReceiverAddressResponse { bool success = 1; }
+message MsgSetRewardReceiverAddressResponse { bool success = 1; }
+message MsgRebondTokens {
+  string owner = 1 [ (gogoproto.moretags) = "yaml:\"owner\"" ];
+  uint64 ID = 2;
+}
+
+message MsgRebondTokensResponse {}
diff --git a/tests/cl-genesis-positions/go.mod b/tests/cl-genesis-positions/go.mod
@@ -116,6 +116,7 @@ require (
 	github.com/rs/cors v1.8.2 // indirect
 	github.com/rs/zerolog v1.27.0 // indirect
 	github.com/sasha-s/go-deadlock v0.3.1 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/afero v1.9.5 // indirect
 	github.com/spf13/cast v1.5.1 // indirect
 	github.com/spf13/cobra v1.7.0 // indirect

diff --git a/tests/cl-go-client/go.mod b/tests/cl-go-client/go.mod
@@ -104,6 +104,7 @@ require (
 	github.com/rs/cors v1.8.2 // indirect
 	github.com/rs/zerolog v1.27.0 // indirect
 	github.com/sasha-s/go-deadlock v0.3.1 // indirect
+	github.com/sirupsen/logrus v1.9.3 // indirect
 	github.com/spf13/afero v1.9.5 // indirect
 	github.com/spf13/cast v1.5.1 // indirect
 	github.com/spf13/cobra v1.7.0 // indirect

@@ -41,7 +41,6 @@ cloud.google.com/go/storage v1.14.0/go.mod h1:GrKmX003DSIwi9o29oFT7YDnHYwZoctc3f
 collectd.org v0.3.0/go.mod h1:A/8DzQBkF6abtvrT2j/AU/4tiBgJWYyh0y/oB/4MlWE=
 cosmossdk.io/errors v1.0.0 h1:nxF07lmlBbB8NKQhtJ+sJm6ef5uV1XkvPXG2bUntb04=
 cosmossdk.io/math v1.1.3-rc.0 h1:lut7IbQGuqog4vEIHSB7ivtwwIr6rHrt5yoVowmtoDs=
-cosmossdk.io/math v1.1.3-rc.0/go.mod h1:l2Gnda87F0su8a/7FEKJfFdJrM0JZRXQaohlgJeyQh0=
 dmitri.shuralyov.com/gpu/mtl v0.0.0-20190408044501-666a987793e9/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
 filippo.io/edwards25519 v1.0.0-rc.1 h1:m0VOOB23frXZvAOK44usCgLWvtsxIoMCTBGJZlpmGfU=
 filippo.io/edwards25519 v1.0.0-rc.1/go.mod h1:N1IkdkCkiLB6tki+MYJoSx2JTY9NUlxZE7eHn5EwJns=
@@ -165,7 +164,6 @@ github.com/checkpoint-restore/go-criu/v5 v5.3.0/go.mod h1:E/eQpaFtUKGOOSEBZgmKAc
 github.com/chenzhuoyu/base64x v0.0.0-20211019084208-fb5309c8db06/go.mod h1:DH46F32mSOjUmXrMHnKwZdA8wcEefY7UVqBKYGjpdQY=
 github.com/chenzhuoyu/base64x v0.0.0-20221115062448-fe3a3abad311/go.mod h1:b583jCggY9gE99b6G5LEC39OIiVsWj+R97kbl5odCEk=
 github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d h1:77cEq6EriyTZ0g/qfRdp61a3Uu/AWrgIq2s0ClJV1g0=
-github.com/chenzhuoyu/base64x v0.0.0-20230717121745-296ad89f973d/go.mod h1:8EPpVsBuRksnlj1mLy4AWzRNQYxauNi62uWcE3to6eA=
 github.com/chenzhuoyu/iasm v0.9.0 h1:9fhXjVzq5hUy2gkhhgHl95zG2cEAhw9OSGs8toWWAwo=
 github.com/chenzhuoyu/iasm v0.9.0/go.mod h1:Xjy2NpN3h7aUqeqM+woSuuvxmIe6+DDsiNLIrkAmYog=
 github.com/chzyer/logex v1.1.10/go.mod h1:+Ywpsq7O8HXn0nuIou7OrIPyXbp3wmkHB+jjWRnGsAI=
@@ -830,7 +828,6 @@ github.com/sirupsen/logrus v1.6.0/go.mod h1:7uNnSEd1DgxDLC74fIahvMZmmYsHGZGEOFrf
 github.com/sirupsen/logrus v1.7.0/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/sirupsen/logrus v1.8.1/go.mod h1:yWOB1SBYBC5VeMP7gHvWumXLIWorT60ONWic61uBYv0=
 github.com/sirupsen/logrus v1.9.3 h1:dueUQJ1C2q9oE3F7wvmSGAaVtTmUizReu6fjN8uqzbQ=
-github.com/sirupsen/logrus v1.9.3/go.mod h1:naHLuLoDiP4jHNo9R0sCBMtWGeIprob74mVsIT4qYEQ=
 github.com/smartystreets/assertions v0.0.0-20180927180507-b2de0cb4f26d/go.mod h1:OnSkiWE9lh6wB0YB77sQom3nweQdgAjqCqsofrRNTgc=
 github.com/smartystreets/goconvey v1.6.4/go.mod h1:syvi0/a8iFYH4r/RixwvyeAJjdLS9QV7WQ/tjFTllLA=
 github.com/soheilhy/cmux v0.1.4/go.mod h1:IM3LyeVVIOuxMH7sFAkER9+bJ4dT7Ms6E4xg4kGIyLM=
@@ -1184,7 +1181,6 @@ golang.org/x/sys v0.0.0-20210927094055-39ccf1dd6fa6/go.mod h1:oPkhp1MJrh7nUepCBc
 golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211025201205-69cdffdb9359/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20211116061358-0a5406a5449c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.0.0-20220715151400-c0bba94af5f8/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.0.0-20220908164124-27713097b956/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
@@ -1271,7 +1267,6 @@ golang.org/x/tools v0.0.0-20210108195828-e2f9c7f1fc8e/go.mod h1:emZCQorbCU4vsT4f
 golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/tools v0.1.5/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk=
 golang.org/x/tools v0.12.0 h1:YW6HUoUmYBpwSgyaGaZq1fHjrBjX1rlpZ54T6mu2kss=
-golang.org/x/tools v0.12.0/go.mod h1:Sc0INKfu04TlqNoRA1hgpFZbhYXHPr4V5DzpSBTPqQM=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

diff --git a/x/lockup/client/cli/flags.go b/x/lockup/client/cli/flags.go
@@ -18,6 +18,12 @@ func FlagSetLockTokens() *flag.FlagSet {
 	return fs
 }
 
+func FlagSetRebondTokens() *flag.FlagSet {
+	fs := flag.NewFlagSet("", flag.ContinueOnError)
+	fs.String(FlagAmount, "", "The amount to be rebonded. e.g. 1osmo")
+	return fs
+}
+
 func FlagSetUnlockTokens() *flag.FlagSet {
 	fs := flag.NewFlagSet("", flag.ContinueOnError)
 	fs.String(FlagAmount, "", "The amount to be unlocked. e.g. 1osmo")

@@ -16,6 +16,7 @@ func GetTxCmd() *cobra.Command {
 	osmocli.AddTxCmd(cmd, NewBeginUnlockByIDCmd)
 	osmocli.AddTxCmd(cmd, NewForceUnlockByIdCmd)
 	osmocli.AddTxCmd(cmd, NewSetRewardReceiverAddress)
+	osmocli.AddTxCmd(cmd, NewRebondTokensCmd)
 
 	return cmd
 }
@@ -72,3 +73,20 @@ func NewSetRewardReceiverAddress() (*osmocli.TxCliDesc, *types.MsgSetRewardRecei
 		Long:  "sets reward receiver address for the designated lock id",
 	}, &types.MsgSetRewardReceiverAddress{}
 }
+
+// NewRebondTokensCmd allows a user to rebond their tokens if they have unlocked them.
+func NewRebondTokensCmd() (*osmocli.TxCliDesc, *types.MsgRebondTokens) {
+	return &osmocli.TxCliDesc{
+		Use:   "rebond-tokens",
+		Short: "rebond unlocking tokens",
+		Long: `Rebond unlocking tokens. If the amount flag is not specified, will rebond all tokens
+
+Example:
+osmosisd tx lockup rebond-tokens 1 
+		`,
+		CustomFlagOverrides: map[string]string{
+			"coins": FlagAmount,
+		},
+		Flags: osmocli.FlagDesc{OptionalFlags: []*pflag.FlagSet{FlagSetRebondTokens()}},
+	}, &types.MsgRebondTokens{}
+}
@@ -29,3 +29,19 @@ func (k Keeper) Lock(ctx sdk.Context, lock types.PeriodLock, tokensToLock sdk.Co
 func (k Keeper) UnlockMaturedLockInternalLogic(ctx sdk.Context, lock types.PeriodLock) error {
 	return k.unlockMaturedLockInternalLogic(ctx, lock)
 }
+
+func DurationLockRefKeys(lock types.PeriodLock) ([][]byte, error) {
+	return durationLockRefKeys(lock)
+}
+
+func LockRefKeys(lock types.PeriodLock) ([][]byte, error) {
+	return lockRefKeys(lock)
+}
+
+func CombineKeys(keys ...[]byte) []byte {
+	return combineKeys(keys...)
+}
+
+func UnlockingPrefix(unlocking bool) []byte {
+	return unlockingPrefix(unlocking)
+}
@@ -9,10 +9,11 @@ import (
 	"github.com/osmosis-labs/osmosis/v19/x/lockup/types"
 )
 
-func (s *KeeperTestSuite) LockTokens(addr sdk.AccAddress, coins sdk.Coins, duration time.Duration) {
-	s.FundAcc(addr, coins)
-	_, err := s.querier.CreateLock(s.Ctx, addr, coins, duration)
-	s.Require().NoError(err)
+func (suite *KeeperTestSuite) LockTokens(addr sdk.AccAddress, coins sdk.Coins, duration time.Duration) uint64 {
+	suite.FundAcc(addr, coins)
+	lock, err := suite.querier.CreateLock(suite.Ctx, addr, coins, duration)
+	suite.Require().NoError(err)
+	return lock.ID
 }
 
 func (s *KeeperTestSuite) BeginUnlocking(addr sdk.AccAddress) {

@@ -904,3 +904,47 @@ func (k Keeper) getCoinsFromLocks(locks []types.PeriodLock) sdk.Coins {
 	}
 	return coins
 }
+
+// RebondTokens rebonds some amount or all coins of a lock with id lockID only if it is already unbonding
+func (k Keeper) RebondTokens(ctx sdk.Context, lockID uint64, owner sdk.AccAddress) error {
+	lock, err := k.GetLockByID(ctx, lockID)
+	if err != nil {
+		return err
+	}
+
+	// check synthetic lockup exists
+	if k.HasAnySyntheticLockups(ctx, lock.ID) {
+		return errorsmod.Wrap(types.ErrLockHasSyntheticLockup, fmt.Sprintf("cannot edit lockup with synthetic lock %d", lock.ID))
+	}
+
+	// check that lock's owner is the same as a message sender
+	if lock.Owner != owner.String() {
+		return errorsmod.Wrap(types.ErrNotLockOwner, fmt.Sprintf("lock %d is not owned by %s", lockID, owner))
+	}
+
+	if !lock.IsUnlocking() {
+		return errorsmod.Wrap(types.ErrLockNotUnlocking, fmt.Sprintf("lock %d is not unlocking, rebonding only possible in unlocking stage", lockID))
+	}
+
+	// Restart lock timer and set back to the store
+	// Rebonded lock is the same lock as the original lock, but with an empty EndTime.
+	rebondedLock := types.NewPeriodLock(lock.ID, lock.OwnerAddress(), lock.RewardReceiverAddress, lock.Duration, time.Time{}, lock.Coins)
+	err = k.setLock(ctx, rebondedLock)
+	if err != nil {
+		return err
+	}
+
+	// Remove original lock's refs from state
+	err = k.deleteLockRefs(ctx, types.KeyPrefixUnlocking, *lock)
+	if err != nil {
+		return err
+	}
+
+	// Add refs for a newly created lock
+	err = k.addLockRefs(ctx, rebondedLock)
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
@@ -10,12 +10,119 @@ import (
 	"github.com/osmosis-labs/osmosis/osmomath"
 	cl "github.com/osmosis-labs/osmosis/v19/x/concentrated-liquidity"
 	cltypes "github.com/osmosis-labs/osmosis/v19/x/concentrated-liquidity/types"
+	"github.com/osmosis-labs/osmosis/v19/x/lockup/keeper"
 	"github.com/osmosis-labs/osmosis/v19/x/lockup/types"
 	lockuptypes "github.com/osmosis-labs/osmosis/v19/x/lockup/types"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
+func (suite *KeeperTestSuite) TestRebondTokens() {
+	// coins that will be locked
+	lockedCoins := sdk.NewCoins(sdk.NewInt64Coin("stake", 10))
+
+	addr1 := suite.TestAccs[0]
+	defaultLockID := uint64(1)
+	nonExistingLockID := uint64(2)
+	notOwnerAddress := suite.TestAccs[1]
+
+	testCases := []struct {
+		name                string
+		unlock              bool
+		rebondLockID        uint64
+		createSyntheticLock bool
+		owner               sdk.AccAddress
+
+		expectedError error
+	}{
+		{
+			name:         "Valid test case",
+			unlock:       true,
+			owner:        addr1,
+			rebondLockID: defaultLockID,
+		},
+		{
+			name:          "Invalid: Trying to rebond a non existent lock id",
+			unlock:        true,
+			owner:         addr1,
+			rebondLockID:  nonExistingLockID,
+			expectedError: types.ErrLockupNotFound,
+		},
+		{
+			name:          "Invalid: Trying to rebond a non-unbonding lock",
+			owner:         addr1,
+			rebondLockID:  defaultLockID,
+			expectedError: types.ErrLockNotUnlocking,
+		},
+		{
+			name:                "Invalid: Trying to rebond a synthetic's underlying lock",
+			createSyntheticLock: true,
+			owner:               addr1,
+			rebondLockID:        defaultLockID,
+			expectedError:       types.ErrLockHasSyntheticLockup,
+		},
+		{
+			name:          "Invalid: Not the owner of a lock",
+			unlock:        true,
+			owner:         notOwnerAddress,
+			rebondLockID:  defaultLockID,
+			expectedError: types.ErrNotLockOwner,
+		},
+	}
+
+	for _, tc := range testCases {
+		suite.Run(tc.name, func() {
+			suite.SetupTest()
+
+			// lock coins
+			lockID := suite.LockTokens(addr1, lockedCoins, time.Second)
+
+			if tc.unlock {
+				// unlock coins
+				_, err := suite.App.LockupKeeper.BeginUnlock(suite.Ctx, lockID, lockedCoins)
+				suite.Require().NoError(err)
+			}
+
+			initialLock, err := suite.App.LockupKeeper.GetLockByID(suite.Ctx, lockID)
+			suite.Require().NoError(err)
+
+			// a sanity check to make sure the lock is in the correct state
+			if tc.unlock {
+				suite.Require().True(initialLock.IsUnlocking())
+			}
+
+			// underlying synthetic locks' period locks cannot be rebonded
+			if tc.createSyntheticLock {
+				err := suite.App.LockupKeeper.CreateSyntheticLockup(suite.Ctx, lockID, "synthetic", initialLock.Duration, false)
+				suite.Require().NoError(err)
+			}
+
+			// rebond coins
+			err = suite.App.LockupKeeper.RebondTokens(suite.Ctx, tc.rebondLockID, tc.owner)
+
+			if tc.expectedError != nil {
+				suite.Require().ErrorIs(err, tc.expectedError)
+				return
+			}
+			suite.Require().NoError(err)
+
+			// get rebonded lock
+			lock, err := suite.App.LockupKeeper.GetLockByID(suite.Ctx, lockID)
+			suite.Require().NoError(err)
+
+			// Assertions
+			suite.Require().Equal(lock.Owner, initialLock.Owner)
+			suite.Require().Equal(lock.Duration, initialLock.Duration)
+			suite.Require().Equal(lock.ID, initialLock.ID)
+			suite.Require().Equal(lock.Coins, initialLock.Coins)
+			suite.Require().Equal(lock.RewardReceiverAddress, initialLock.RewardReceiverAddress)
+			suite.Require().False(lock.IsUnlocking())
+
+			// Check lock refs
+			suite.assertLockRefs(*lock)
+		})
+	}
+}
 func (s *KeeperTestSuite) TestBeginUnlocking() { // test for all unlockable coins
 	s.SetupTest()
 
@@ -1579,3 +1686,31 @@ func (s *KeeperTestSuite) TestPartialForceUnlock() {
 		}
 	}
 }
+
+// assertLockRefs checks that a lock has required refs in store based on the current state of the lock
+// Ex: if lock is unlocking, it should have unlocking refs
+func (suite *KeeperTestSuite) assertLockRefs(lock types.PeriodLock) {
+	refKeys, err := keeper.DurationLockRefKeys(lock)
+	suite.Require().NoError(err)
+
+	if lock.IsUnlocking() {
+		refKeys, err = keeper.LockRefKeys(lock)
+		suite.Require().NoError(err)
+	}
+
+	keyPrefix := keeper.UnlockingPrefix(lock.IsUnlocking())
+	for _, refKey := range refKeys {
+		refKey = keeper.CombineKeys(keyPrefix, refKey)
+		ids := suite.App.LockupKeeper.GetLockRefs(suite.Ctx, refKey)
+
+		found := false
+		for _, id := range ids {
+			if lock.ID == id {
+				found = true
+				break
+			}
+		}
+
+		suite.Require().True(found)
+	}
+}