Add custom recipient field for amm swap functions

proto/elys/amm/tx.proto

@@ -63,12 +63,12 @@ message MsgSwapExactAmountIn {
            cosmos.base.v1beta1.Coin token_in             = 3 [(gogoproto.nullable)   = false                                   ] ;
            string                   token_out_min_amount = 4 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
            string                   discount   = 5 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
-
+           string                   recipient  = 6;
 }
 
 message MsgSwapExactAmountInResponse {
   string token_out_amount = 1 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
-  string                   discount   = 2 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string discount   = 2 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
 }
 
 message MsgSwapExactAmountOut {
@@ -77,11 +77,12 @@ message MsgSwapExactAmountOut {
            cosmos.base.v1beta1.Coin token_out           = 3 [(gogoproto.nullable)   = false                                   ] ;
            string                   token_in_max_amount = 4 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
            string                   discount   = 5 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+           string                   recipient  = 6;
 }
 
 message MsgSwapExactAmountOutResponse {
   string token_in_amount = 1 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Int", (gogoproto.nullable) = false];
-  string                   discount   = 2 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string discount   = 2 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
 }
 
 message MsgFeedMultipleExternalLiquidity {
@@ -111,6 +112,7 @@ message MsgSwapByDenom {
   string                   denom_in   = 5;
   string                   denom_out  = 6;
   string                   discount   = 7 [(gogoproto.customtype) = "github.com/cosmos/cosmos-sdk/types.Dec", (gogoproto.nullable) = false];
+  string                   recipient = 8;
 }
 
 message MsgSwapByDenomResponse {

x/amm/client/cli/tx.go

@@ -17,6 +17,7 @@ var (
 
 const (
 	FlagDiscount               = "discount"
+	FlagRecipient              = "recipient"
 	flagPacketTimeoutTimestamp = "packet-timeout-timestamp"
 	listSeparator              = ","
 )

x/amm/client/cli/tx_swap_by_denom.go

@@ -65,13 +65,19 @@ func CmdSwapByDenom() *cobra.Command {
 				return err
 			}
 
+			recipient, err := cmd.Flags().GetString(FlagRecipient)
+			if err != nil {
+				return err
+			}
+
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
 				return err
 			}
 
 			msg := types.NewMsgSwapByDenom(
 				clientCtx.GetFromAddress().String(),
+				recipient,
 				argAmount,
 				minAmount,
 				maxAmount,
@@ -91,6 +97,7 @@ func CmdSwapByDenom() *cobra.Command {
 	cmd.Flags().String(FlagMinAmount, "", "minimum amount of tokens to receive")
 	cmd.Flags().String(FlagMaxAmount, "", "maximum amount of tokens to send")
 	cmd.Flags().String(FlagDiscount, "0.0", "discount to apply to the swap fee (only smart contract broker can apply the discount)")
+	cmd.Flags().String(FlagRecipient, "", "optional recipient field for the tokens swapped to be sent to")
 
 	return cmd
 }

x/amm/client/cli/tx_swap_exact_amount_in.go

@@ -53,13 +53,19 @@ func CmdSwapExactAmountIn() *cobra.Command {
 				return err
 			}
 
+			recipient, err := cmd.Flags().GetString(FlagRecipient)
+			if err != nil {
+				return err
+			}
+
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
 				return err
 			}
 
 			msg := types.NewMsgSwapExactAmountIn(
 				clientCtx.GetFromAddress().String(),
+				recipient,
 				argTokenIn,
 				argTokenOutMinAmount,
 				argSwapRoutePoolIds,
@@ -76,6 +82,7 @@ func CmdSwapExactAmountIn() *cobra.Command {
 	flags.AddTxFlagsToCmd(cmd)
 
 	cmd.Flags().String(FlagDiscount, "0.0", "discount to apply to the swap fee (only smart contract broker can apply the discount)")
+	cmd.Flags().String(FlagRecipient, "", "optional recipient field for the tokens swapped to be sent to")
 
 	return cmd
 }

x/amm/client/cli/tx_swap_exact_amount_out.go

@@ -53,13 +53,19 @@ func CmdSwapExactAmountOut() *cobra.Command {
 				return err
 			}
 
+			recipient, err := cmd.Flags().GetString(FlagRecipient)
+			if err != nil {
+				return err
+			}
+
 			clientCtx, err := client.GetClientTxContext(cmd)
 			if err != nil {
 				return err
 			}
 
 			msg := types.NewMsgSwapExactAmountOut(
 				clientCtx.GetFromAddress().String(),
+				recipient,
 				argTokenOut,
 				argTokenOutMaxAmount,
 				argSwapRoutePoolIds,
@@ -76,6 +82,7 @@ func CmdSwapExactAmountOut() *cobra.Command {
 	flags.AddTxFlagsToCmd(cmd)
 
 	cmd.Flags().String(FlagDiscount, "0.0", "discount to apply to the swap fee (only smart contract broker can apply the discount)")
+	cmd.Flags().String(FlagRecipient, "", "optional recipient field for the tokens swapped to be sent to")
 
 	return cmd
 }

x/amm/keeper/abci.go

@@ -28,7 +28,11 @@ func (k Keeper) ApplySwapRequest(ctx sdk.Context, msg sdk.Msg) error {
 		if err != nil {
 			return err
 		}
-		_, err = k.RouteExactAmountIn(ctx, sender, msg.Routes, msg.TokenIn, math.Int(msg.TokenOutMinAmount), msg.Discount)
+		recipient, err := sdk.AccAddressFromBech32(msg.Recipient)
+		if err != nil {
+			recipient = sender
+		}
+		_, err = k.RouteExactAmountIn(ctx, sender, recipient, msg.Routes, msg.TokenIn, math.Int(msg.TokenOutMinAmount), msg.Discount)
 		if err != nil {
 			return err
 		}
@@ -38,7 +42,11 @@ func (k Keeper) ApplySwapRequest(ctx sdk.Context, msg sdk.Msg) error {
 		if err != nil {
 			return err
 		}
-		_, err = k.RouteExactAmountOut(ctx, sender, msg.Routes, msg.TokenInMaxAmount, msg.TokenOut, msg.Discount)
+		recipient, err := sdk.AccAddressFromBech32(msg.Recipient)
+		if err != nil {
+			recipient = sender
+		}
+		_, err = k.RouteExactAmountOut(ctx, sender, recipient, msg.Routes, msg.TokenInMaxAmount, msg.TokenOut, msg.Discount)
 		if err != nil {
 			return err
 		}

x/amm/keeper/fee.go

@@ -61,7 +61,7 @@ func (k Keeper) SwapFeesToRevenueToken(ctx sdk.Context, pool types.Pool, fee sdk
 
 		// Settles balances between the tx sender and the pool to match the swap that was executed earlier.
 		// Also emits a swap event and updates related liquidity metrics.
-		err, _ = k.UpdatePoolForSwap(ctx, pool, poolRevenueAddress, tokenIn, tokenOutCoin, sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec())
+		err, _ = k.UpdatePoolForSwap(ctx, pool, poolRevenueAddress, poolRevenueAddress, tokenIn, tokenOutCoin, sdk.ZeroDec(), sdk.ZeroDec(), sdk.ZeroDec())
 		if err != nil {
 			return err
 		}

x/amm/keeper/keeper_swap_exact_amount_in.go

@@ -19,6 +19,7 @@ import (
 func (k Keeper) SwapExactAmountIn(
 	ctx sdk.Context,
 	sender sdk.AccAddress,
+	recipient sdk.AccAddress,
 	pool types.Pool,
 	tokenIn sdk.Coin,
 	tokenOutDenom string,
@@ -61,7 +62,7 @@ func (k Keeper) SwapExactAmountIn(
 
 	// Settles balances between the tx sender and the pool to match the swap that was executed earlier.
 	// Also emits a swap event and updates related liquidity metrics.
-	err, swapOutFee := k.UpdatePoolForSwap(ctx, pool, sender, tokenIn, tokenOutCoin, sdk.ZeroDec(), swapFee, weightBalanceBonus)
+	err, swapOutFee := k.UpdatePoolForSwap(ctx, pool, sender, recipient, tokenIn, tokenOutCoin, sdk.ZeroDec(), swapFee, weightBalanceBonus)
 	if err != nil {
 		return math.Int{}, err
 	}

x/amm/keeper/keeper_swap_exact_amount_in_test.go

@@ -21,7 +21,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 		tokenOut            sdk.Coin
 		weightBalanceBonus  sdk.Dec
 		isOraclePool        bool
+		useNewRecipient     bool
 		expSenderBalance    sdk.Coins
+		expRecipientBalance sdk.Coins
 		expPoolBalance      sdk.Coins
 		expTreasuryBalance  sdk.Coins
 		expPass             bool
@@ -38,7 +40,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 10000),
 			weightBalanceBonus:  sdk.ZeroDec(),
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{},
 			expTreasuryBalance:  sdk.Coins{},
 			expPass:             false,
@@ -55,7 +59,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 10000),
 			weightBalanceBonus:  sdk.ZeroDec(),
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{},
 			expTreasuryBalance:  sdk.Coins{},
 			expPass:             false,
@@ -72,7 +78,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9704),
 			weightBalanceBonus:  sdk.ZeroDec(),
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1009704)},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990198)},
 			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000010)},
 			expPass:             true,
@@ -89,7 +97,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9900),
 			weightBalanceBonus:  sdk.ZeroDec(),
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1009900)},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990100)},
 			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
 			expPass:             true,
@@ -106,7 +116,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9975),
 			weightBalanceBonus:  sdk.ZeroDec(),
 			isOraclePool:        true,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1009975)},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990025)},
 			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
 			expPass:             true,
@@ -123,7 +135,9 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9900),
 			weightBalanceBonus:  sdk.NewDecWithPrec(3, 1), // 30% bonus
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1009900)},
+			expRecipientBalance: sdk.Coins{},
 			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990100)},
 			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
 			expPass:             true,
@@ -140,7 +154,28 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9900),
 			weightBalanceBonus:  sdk.NewDecWithPrec(3, 1), // 30% bonus
 			isOraclePool:        false,
+			useNewRecipient:     false,
 			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1009900)},
+			expRecipientBalance: sdk.Coins{},
+			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990100)},
+			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 100)},
+			expPass:             true,
+		},
+		{
+			desc:                "new recipient address",
+			senderInitBalance:   sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
+			poolInitBalance:     sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
+			treasuryInitBalance: sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 100)},
+			swapFeeIn:           sdk.ZeroDec(),
+			swapFeeOut:          sdk.ZeroDec(),
+			tokenIn:             sdk.NewInt64Coin("uusda", 10000),
+			tokenOutMin:         sdk.ZeroInt(),
+			tokenOut:            sdk.NewInt64Coin(ptypes.BaseCurrency, 9900),
+			weightBalanceBonus:  sdk.NewDecWithPrec(3, 1), // 30% bonus
+			isOraclePool:        false,
+			useNewRecipient:     true,
+			expSenderBalance:    sdk.Coins{sdk.NewInt64Coin("uusda", 990000), sdk.NewInt64Coin(ptypes.BaseCurrency, 1000000)},
+			expRecipientBalance: sdk.Coins{sdk.NewInt64Coin(ptypes.BaseCurrency, 9900)},
 			expPoolBalance:      sdk.Coins{sdk.NewInt64Coin("uusda", 1010000), sdk.NewInt64Coin(ptypes.BaseCurrency, 990100)},
 			expTreasuryBalance:  sdk.Coins{sdk.NewInt64Coin("uusda", 1000000), sdk.NewInt64Coin(ptypes.BaseCurrency, 100)},
 			expPass:             true,
@@ -152,8 +187,12 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 
 			// bootstrap accounts
 			sender := sdk.AccAddress(ed25519.GenPrivKey().PubKey().Address())
+			recipient := sender
 			poolAddr := sdk.AccAddress(ed25519.GenPrivKey().PubKey().Address())
 			treasuryAddr := sdk.AccAddress(ed25519.GenPrivKey().PubKey().Address())
+			if tc.useNewRecipient {
+				recipient = sdk.AccAddress(ed25519.GenPrivKey().PubKey().Address())
+			}
 
 			// bootstrap balances
 			err := suite.app.BankKeeper.MintCoins(suite.ctx, minttypes.ModuleName, tc.senderInitBalance)
@@ -205,7 +244,7 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 				TotalWeight: sdk.ZeroInt(),
 			}
 
-			tokenOut, err := suite.app.AmmKeeper.SwapExactAmountIn(suite.ctx, sender, pool, tc.tokenIn, tc.tokenOut.Denom, tc.tokenOutMin, tc.swapFeeIn)
+			tokenOut, err := suite.app.AmmKeeper.SwapExactAmountIn(suite.ctx, sender, recipient, pool, tc.tokenIn, tc.tokenOut.Denom, tc.tokenOutMin, tc.swapFeeIn)
 			if !tc.expPass {
 				suite.Require().Error(err)
 			} else {
@@ -220,6 +259,12 @@ func (suite *KeeperTestSuite) TestSwapExactAmountIn() {
 				balances = suite.app.BankKeeper.GetAllBalances(suite.ctx, sender)
 				suite.Require().Equal(balances.String(), tc.expSenderBalance.String())
 
+				if tc.useNewRecipient {
+					// check balance change on recipient
+					balances = suite.app.BankKeeper.GetAllBalances(suite.ctx, recipient)
+					suite.Require().Equal(balances.String(), tc.expRecipientBalance.String())
+				}
+
 				// check balance change on treasury
 				balances = suite.app.BankKeeper.GetAllBalances(suite.ctx, treasuryAddr)
 				suite.Require().Equal(balances.String(), tc.expTreasuryBalance.String())

x/amm/keeper/keeper_swap_exact_amount_out.go

@@ -17,6 +17,7 @@ import (
 func (k Keeper) SwapExactAmountOut(
 	ctx sdk.Context,
 	sender sdk.AccAddress,
+	recipient sdk.AccAddress,
 	pool types.Pool,
 	tokenInDenom string,
 	tokenInMaxAmount math.Int,
@@ -54,7 +55,7 @@ func (k Keeper) SwapExactAmountOut(
 		return math.Int{}, sdkerrors.Wrapf(types.ErrLimitMaxAmount, "swap requires %s, which is greater than the amount %s", tokenIn, tokenInMaxAmount)
 	}
 
-	err, _ = k.UpdatePoolForSwap(ctx, pool, sender, tokenIn, tokenOut, swapFee, sdk.ZeroDec(), weightBalanceBonus)
+	err, _ = k.UpdatePoolForSwap(ctx, pool, sender, recipient, tokenIn, tokenOut, swapFee, sdk.ZeroDec(), weightBalanceBonus)
 	if err != nil {
 		return math.Int{}, err
 	}