refactor: break PoolI.SpotPrice API to return BigDec (backport #6372) (…

…#6407) * updates * fix conflicts in tests * lint * Update CHANGELOG.md * Update CHANGELOG.md --------- Co-authored-by: roman <[email protected]>
osmosis-labs · Sep 20, 2023 · 3c734c9 · 3c734c9
1 parent 01f0117
commit 3c734c9
Show file tree

Hide file tree

Showing 22 changed files with 258 additions and 271 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -67,6 +67,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
    * maxDecBitLen has changed by one bit so overflow panic can be triggerred sooner.
 * [#6368](https://github.com/osmosis-labs/osmosis/pull/6368) Convert priceLimit API in CL swaps to BigDec 
 
+* [#6371](https://github.com/osmosis-labs/osmosis/pull/6371) Change PoolI.SpotPrice API from Dec (18 decimals) to BigDec (36 decimals), maintain state-compatibility. 
 
 ## v19.0.0
 

diff --git a/app/apptesting/gamm.go b/app/apptesting/gamm.go
@@ -294,7 +294,7 @@ func (s *KeeperTestHelper) CalcAmoutOfTokenToGetTargetPrice(ctx sdk.Context, poo
 	// Amount of quote token need to trade to get target spot price
 	// AmoutQuoteTokenNeedToTrade = AmoutQuoTokenNow * ((targetSpotPrice/spotPriceNow)^((weight_base/(weight_base + weight_quote))) -1 )
 
-	ratioPrice := targetSpotPrice.Quo(spotPriceNow)
+	ratioPrice := targetSpotPrice.Quo(spotPriceNow.Dec())
 	ratioWeight := (baseAsset.Weight.ToLegacyDec()).Quo(baseAsset.Weight.ToLegacyDec().Add(quoteAsset.Weight.ToLegacyDec()))
 
 	amountTrade = quoteAsset.Token.Amount.ToLegacyDec().Mul(osmomath.Pow(ratioPrice, ratioWeight).Sub(osmomath.OneDec()))

diff --git a/tests/e2e/initialization/config.go b/tests/e2e/initialization/config.go
@@ -481,16 +481,17 @@ func updateTWAPGenesis(appGenState map[string]json.RawMessage) func(twapGenState
 				}
 
 				twapRecord := twaptypes.TwapRecord{
-					PoolId:                      balancerPool.Id,
-					Asset0Denom:                 denomPair.Denom0,
-					Asset1Denom:                 denomPair.Denom0,
-					Height:                      1,
-					Time:                        time.Date(2023, 0o2, 1, 0, 0, 0, 0, time.UTC), // some time in the past.
-					P0LastSpotPrice:             sp0,
-					P1LastSpotPrice:             sp1,
-					P0ArithmeticTwapAccumulator: osmomath.ZeroDec(),
-					P1ArithmeticTwapAccumulator: osmomath.ZeroDec(),
-					GeometricTwapAccumulator:    osmomath.ZeroDec(),
+					PoolId:      balancerPool.Id,
+					Asset0Denom: denomPair.Denom0,
+					Asset1Denom: denomPair.Denom0,
+					Height:      1,
+					Time:        time.Date(2023, 0o2, 1, 0, 0, 0, 0, time.UTC), // some time in the past.
+					// Note: truncation is acceptable as x/twap is guaranteed to work only on pools with spot prices > 10^-18.
+					P0LastSpotPrice:             sp0.Dec(),
+					P1LastSpotPrice:             sp1.Dec(),
+					P0ArithmeticTwapAccumulator: sdk.ZeroDec(),
+					P1ArithmeticTwapAccumulator: sdk.ZeroDec(),
+					GeometricTwapAccumulator:    sdk.ZeroDec(),
 					LastErrorTime:               time.Time{}, // no previous error
 				}
 				twapGenState.Twaps = append(twapGenState.Twaps, twapRecord)

diff --git a/tests/mocks/cfmm_pool.go b/tests/mocks/cfmm_pool.go
diff --git a/tests/mocks/cl_pool.go b/tests/mocks/cl_pool.go
diff --git a/tests/mocks/pool.go b/tests/mocks/pool.go
diff --git a/tests/mocks/pool_module.go b/tests/mocks/pool_module.go