feat: uni-directional trading pair taker fee support

domain/mvc/router.go

@@ -5,9 +5,10 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
-	"github.com/osmosis-labs/osmosis/osmomath"
 	"github.com/osmosis-labs/sqs/domain"
 	"github.com/osmosis-labs/sqs/sqsdomain"
+
+	"github.com/osmosis-labs/osmosis/osmomath"
 )
 
 // CandidateRouteSearchDataUpdateListener is the interface for the candidate route search data holder.
@@ -29,13 +30,13 @@ type RouterRepository interface {
 	CandidateRouteSearchDataHolder
 
 	// GetTakerFee returns the taker fee for a given pair of denominations
-	// Sorts the denominations lexicographically before looking up the taker fee.
+	// Sorting is no longer performed before looking up as bi-directional taker fees are stored.
 	// Returns true if the taker fee for a given denomimnation is found. False otherwise.
 	GetTakerFee(denom0, denom1 string) (osmomath.Dec, bool)
 	// GetAllTakerFees returns all taker fees
 	GetAllTakerFees() sqsdomain.TakerFeeMap
 	// SetTakerFee sets the taker fee for a given pair of denominations
-	// Sorts the denominations lexicographically before storing the taker fee.
+	// Sorting is no longer performed before storing as bi-directional taker fee is supported.
 	SetTakerFee(denom0, denom1 string, takerFee osmomath.Dec)
 	// SetTakerFees sets taker fees on router repository
 	SetTakerFees(takerFees sqsdomain.TakerFeeMap)

router/repository/memory_router_repository.go

@@ -5,25 +5,26 @@ import (
 	"sync"
 
 	"cosmossdk.io/math"
-	"github.com/osmosis-labs/osmosis/osmomath"
 	"github.com/osmosis-labs/sqs/domain"
 	"github.com/osmosis-labs/sqs/domain/mvc"
 	"github.com/osmosis-labs/sqs/log"
 	"github.com/osmosis-labs/sqs/sqsdomain"
+
+	"github.com/osmosis-labs/osmosis/osmomath"
 )
 
 // RouterRepository represents the contract for a repository handling router information
 type RouterRepository interface {
 	mvc.CandidateRouteSearchDataHolder
 
 	// GetTakerFee returns the taker fee for a given pair of denominations
-	// Sorts the denominations lexicographically before looking up the taker fee.
+	// Sorting is no longer performed before looking up as bi-directional taker fees are stored.
 	// Returns true if the taker fee for a given denomimnation is found. False otherwise.
 	GetTakerFee(denom0, denom1 string) (osmomath.Dec, bool)
 	// GetAllTakerFees returns all taker fees
 	GetAllTakerFees() sqsdomain.TakerFeeMap
 	// SetTakerFee sets the taker fee for a given pair of denominations
-	// Sorts the denominations lexicographically before storing the taker fee.
+	// Sorting is no longer performed before storing as bi-directional taker fee is supported.
 	SetTakerFee(denom0, denom1 string, takerFee osmomath.Dec)
 	SetTakerFees(takerFees sqsdomain.TakerFeeMap)
 }
@@ -75,11 +76,6 @@ func (r *routerRepo) GetAllTakerFees() sqsdomain.TakerFeeMap {
 
 // GetTakerFee implements RouterRepository.
 func (r *routerRepo) GetTakerFee(denom0 string, denom1 string) (math.LegacyDec, bool) {
-	// Ensure increasing lexicographic order.
-	if denom1 < denom0 {
-		denom0, denom1 = denom1, denom0
-	}
-
 	takerFeeAny, ok := r.takerFeeMap.Load(sqsdomain.DenomPair{Denom0: denom0, Denom1: denom1})
 
 	if !ok {
@@ -96,11 +92,6 @@ func (r *routerRepo) GetTakerFee(denom0 string, denom1 string) (math.LegacyDec,
 
 // SetTakerFee implements RouterRepository.
 func (r *routerRepo) SetTakerFee(denom0 string, denom1 string, takerFee math.LegacyDec) {
-	// Ensure increasing lexicographic order.
-	if denom1 < denom0 {
-		denom0, denom1 = denom1, denom0
-	}
-
 	r.takerFeeMap.Store(sqsdomain.DenomPair{Denom0: denom0, Denom1: denom1}, takerFee)
 }
 

sqsdomain/taker_fee.go

@@ -9,15 +9,13 @@ import (
 )
 
 // DenomPair encapsulates a pair of denoms.
-// The order of the denoms ius that Denom0 precedes
-// Denom1 lexicographically.
 type DenomPair struct {
 	Denom0 string
 	Denom1 string
 }
 
 // TakerFeeMap is a map of DenomPair to taker fee.
-// It sorts the denoms lexicographically before looking up the taker fee.
+// Sorting is no longer performed since bi-directional taker fee is supported.
 type TakerFeeMap map[DenomPair]osmomath.Dec
 
 var _ json.Marshaler = &TakerFeeMap{}
@@ -56,25 +54,17 @@ func (tfm TakerFeeMap) UnmarshalJSON(data []byte) error {
 }
 
 // Has returns true if the taker fee for the given denoms is found.
-// It sorts the denoms lexicographically before looking up the taker fee.
+// Sorting is no longer performed since bi-directional taker fees are stored.
 func (tfm TakerFeeMap) Has(denom0, denom1 string) bool {
-	// Ensure increasing lexicographic order.
-	if denom1 < denom0 {
-		denom0, denom1 = denom1, denom0
-	}
 
 	_, found := tfm[DenomPair{Denom0: denom0, Denom1: denom1}]
 	return found
 }
 
 // GetTakerFee returns the taker fee for the given denoms.
-// It sorts the denoms lexicographically before looking up the taker fee.
+// Sorting is no longer performed since bi-directional taker fees are stored.
 // Returns error if the taker fee is not found.
 func (tfm TakerFeeMap) GetTakerFee(denom0, denom1 string) osmomath.Dec {
-	// Ensure increasing lexicographic order.
-	if denom1 < denom0 {
-		denom0, denom1 = denom1, denom0
-	}
 
 	takerFee, found := tfm[DenomPair{Denom0: denom0, Denom1: denom1}]
 
@@ -86,12 +76,8 @@ func (tfm TakerFeeMap) GetTakerFee(denom0, denom1 string) osmomath.Dec {
 }
 
 // SetTakerFee sets the taker fee for the given denoms.
-// It sorts the denoms lexicographically before setting the taker fee.
+// Sorting is no longer performed since bi-directional taker fee is supported.
 func (tfm TakerFeeMap) SetTakerFee(denom0, denom1 string, takerFee osmomath.Dec) {
-	// Ensure increasing lexicographic order.
-	if denom1 < denom0 {
-		denom0, denom1 = denom1, denom0
-	}
 
 	tfm[DenomPair{Denom0: denom0, Denom1: denom1}] = takerFee
 }