fix: msg multihop validation #ntrn-157

proto/neutron/dex/query.proto

@@ -254,7 +254,7 @@ message QueryEstimateMultiHopSwapRequest {
   string        exitLimitPrice = 5 [(gogoproto.moretags) = "yaml:\"exitLimitPrice\"", (gogoproto.customtype) = "github.com/neutron-org/neutron/utils/math.PrecDec", (gogoproto.nullable) = false, (gogoproto.jsontag) = "exitLimitPrice"];
 
   // If pickBestRoute == true then all routes are run and the route with the best price is chosen
-  // otherwise, the first succesful route is used.
+  // otherwise, the first successful route is used.
   bool pickBestRoute = 6;
 }
 

proto/neutron/dex/tx.proto

@@ -176,7 +176,7 @@ message MsgMultiHopSwap {
                              (gogoproto.jsontag) = "exitLimitPrice"
                              ];
   // If pickBestRoute == true then all routes are run and the route with the best price is chosen
-  // otherwise, the first succesful route is used.
+  // otherwise, the first successful route is used.
   bool pickBestRoute = 6;
 }
 

x/dex/types/errors.go

@@ -164,9 +164,24 @@ var (
 		1149,
 		"Invalid Address",
 	)
-	ErrDuplicatePoolDeposit = sdkerrors.Register(
+	ErrRouteWithoutExitToken = sdkerrors.Register(
 		ModuleName,
 		1150,
+		"Each route should specify at least two hops - input and output tokens",
+	)
+	ErrCycleInHops = sdkerrors.Register(
+		ModuleName,
+		1151,
+		"Hops cannot have cycles",
+	)
+	ErrZeroExitPrice = sdkerrors.Register(
+		ModuleName,
+		1152,
+		"Cannot have negative or zero exit price",
+	)
+	ErrDuplicatePoolDeposit = sdkerrors.Register(
+		ModuleName,
+		1153,
 		"Can only provide a single deposit amount for each tick, fee pair",
 	)
 )

x/dex/types/message_multi_hop_swap.go

@@ -4,6 +4,7 @@ import (
 	sdkerrors "cosmossdk.io/errors"
 	"cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
+
 	math_utils "github.com/neutron-org/neutron/utils/math"
 )
 
@@ -13,7 +14,7 @@ var _ sdk.Msg = &MsgMultiHopSwap{}
 
 func NewMsgMultiHopSwap(
 	creator string,
-	receiever string,
+	receiver string,
 	routesArr [][]string,
 	amountIn math.Int,
 	exitLimitPrice math_utils.PrecDec,
@@ -26,7 +27,7 @@ func NewMsgMultiHopSwap(
 
 	return &MsgMultiHopSwap{
 		Creator:        creator,
-		Receiver:       receiever,
+		Receiver:       receiver,
 		Routes:         routes,
 		AmountIn:       amountIn,
 		ExitLimitPrice: exitLimitPrice,
@@ -70,6 +71,20 @@ func (msg *MsgMultiHopSwap) ValidateBasic() error {
 		return ErrMissingMultihopRoute
 	}
 
+	for _, route := range msg.Routes {
+		if len(route.Hops) < 2 {
+			return ErrRouteWithoutExitToken
+		}
+
+		existingHops := make(map[string]bool, len(route.Hops))
+		for _, hop := range route.Hops {
+			if _, ok := existingHops[hop]; ok {
+				return ErrCycleInHops
+			}
+			existingHops[hop] = true
+		}
+	}
+
 	expectedExitToken := msg.Routes[0].Hops[len(msg.Routes[0].Hops)-1]
 	for _, route := range msg.Routes[1:] {
 		hops := route.Hops
@@ -82,5 +97,9 @@ func (msg *MsgMultiHopSwap) ValidateBasic() error {
 		return ErrZeroSwap
 	}
 
+	if !msg.ExitLimitPrice.IsPositive() {
+		return ErrZeroExitPrice
+	}
+
 	return nil
 }

x/dex/types/message_multi_hop_swap_test.go

@@ -1,7 +1,8 @@
 package types_test
 
 import (
+	math_utils "github.com/neutron-org/neutron/utils/math"
 	"testing"
 
 	"cosmossdk.io/math"
 	"github.com/neutron-org/neutron/testutil/common/sample"
@@ -20,6 +21,10 @@
 			msg: MsgMultiHopSwap{
 				Creator:  "invalid_address",
 				Receiver: sample.AccAddress(),
+				Routes: []*MultiHopRoute{
+					{Hops: []string{"A", "B", "C"}},
+				},
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 			err: ErrInvalidAddress,
 		},
@@ -28,14 +33,20 @@
 			msg: MsgMultiHopSwap{
 				Creator:  sample.AccAddress(),
 				Receiver: "invalid_address",
+				Routes: []*MultiHopRoute{
+					{Hops: []string{"A", "B", "C"}},
+				},
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 			err: ErrInvalidAddress,
 		},
 		{
 			name: "missing route",
 			msg: MsgMultiHopSwap{
-				Creator:  sample.AccAddress(),
-				Receiver: sample.AccAddress(),
+				Creator:        sample.AccAddress(),
+				Receiver:       sample.AccAddress(),
+				Routes:         []*MultiHopRoute{},
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 			err: ErrMissingMultihopRoute,
 		},
@@ -48,26 +59,65 @@
 					{Hops: []string{"A", "B", "C"}},
 					{Hops: []string{"A", "B", "Z"}},
 				},
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 			err: ErrMultihopExitTokensMismatch,
 		},
 		{
 			name: "invalid amountIn",
 			msg: MsgMultiHopSwap{
-				Creator:  sample.AccAddress(),
-				Receiver: sample.AccAddress(),
-				Routes:   []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
-				AmountIn: math.NewInt(-1),
+				Creator:        sample.AccAddress(),
+				Receiver:       sample.AccAddress(),
+				Routes:         []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
+				AmountIn:       math.NewInt(-1),
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 			err: ErrZeroSwap,
 		},
 		{
-			name: "valid",
+			name: "cycles in hops",
 			msg: MsgMultiHopSwap{
-				Routes:   []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
 				Creator:  sample.AccAddress(),
 				Receiver: sample.AccAddress(),
-				AmountIn: math.OneInt(),
+				Routes: []*MultiHopRoute{
+					{Hops: []string{"A", "B", "C"}},                // normal
+					{Hops: []string{"A", "B", "D", "E", "B", "C"}}, // has cycle
+				},
+				AmountIn:       math.OneInt(),
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
+			},
+			err: ErrCycleInHops,
+		},
+		{
+			name: "zero exit limit price",
+			msg: MsgMultiHopSwap{
+				Creator:        sample.AccAddress(),
+				Receiver:       sample.AccAddress(),
+				Routes:         []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
+				AmountIn:       math.OneInt(),
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0"),
+			},
+			err: ErrZeroExitPrice,
+		},
+		{
+			name: "negative exit limit price",
+			msg: MsgMultiHopSwap{
+				Creator:        sample.AccAddress(),
+				Receiver:       sample.AccAddress(),
+				Routes:         []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
+				AmountIn:       math.OneInt(),
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("-0.5"),
+			},
+			err: ErrZeroExitPrice,
+		},
+		{
+			name: "valid",
+			msg: MsgMultiHopSwap{
+				Creator:        sample.AccAddress(),
+				Receiver:       sample.AccAddress(),
+				Routes:         []*MultiHopRoute{{Hops: []string{"A", "B", "C"}}},
+				AmountIn:       math.OneInt(),
+				ExitLimitPrice: math_utils.MustNewPrecDecFromStr("0.9"),
 			},
 		},
 	}