Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove osmomath's dependency on osmoassert & gammtypes #3768

Merged
merged 4 commits into from
Dec 16, 2022
Merged

Remove osmomath's dependency on osmoassert & gammtypes #3768

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
9ff2526
Remove osmomath's dependency on osmoassert & gammtypes
ValarDragon Dec 16, 2022
ad637d1
Add note in gamm constant
ValarDragon Dec 16, 2022
6fd30c3
Bring pack conditional panic
ValarDragon Dec 16, 2022
cda55c5
One more cond panic
ValarDragon Dec 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 32 additions & 18 deletions osmomath/decimal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,7 @@ import (
"github.com/stretchr/testify/suite"
"gopkg.in/yaml.v2"

"github.com/osmosis-labs/osmosis/v13/app/apptesting/osmoassert"
"github.com/osmosis-labs/osmosis/v13/osmomath"
gammtypes "github.com/osmosis-labs/osmosis/v13/x/gamm/types"
)

type decimalTestSuite struct {
Expand Down Expand Up @@ -720,7 +718,7 @@ func (s *decimalTestSuite) TestLog2() {
expected: osmomath.MustNewDecFromStr("99.525973560175362367047484597337715868"),
},
"log_2{Max Spot Price} = 128": {
initialValue: osmomath.BigDecFromSDKDec(gammtypes.MaxSpotPrice), // 2^128 - 1
initialValue: osmomath.BigDecFromSDKDec(osmomath.MaxSpotPrice), // 2^128 - 1
// From: https://www.wolframalpha.com/input?i=log+base+2+of+%28%282%5E128%29+-+1%29+38+digits
expected: osmomath.MustNewDecFromStr("128"),
},
Expand All @@ -734,16 +732,20 @@ func (s *decimalTestSuite) TestLog2() {

for name, tc := range tests {
s.Run(name, func() {
osmoassert.ConditionalPanic(s.T(), tc.expectedPanic, func() {
f := func() {
// Create a copy to test that the original was not modified.
// That is, that LogbBase2() is non-mutative.
initialCopy := tc.initialValue.Clone()

// system under test.
res := tc.initialValue.LogBase2()
require.True(osmomath.DecApproxEq(s.T(), tc.expected, res, expectedErrTolerance))
require.Equal(s.T(), initialCopy, tc.initialValue)
})
}
if tc.expectedPanic {
require.Panics(s.T(), f)
} else {
f()
}
})
}
}
Expand Down Expand Up @@ -818,16 +820,20 @@ func (s *decimalTestSuite) TestLn() {

for name, tc := range tests {
s.Run(name, func() {
osmoassert.ConditionalPanic(s.T(), tc.expectedPanic, func() {
f := func() {
// Create a copy to test that the original was not modified.
// That is, that Ln() is non-mutative.
initialCopy := tc.initialValue.Clone()

// system under test.
res := tc.initialValue.Ln()
require.True(osmomath.DecApproxEq(s.T(), tc.expected, res, expectedErrTolerance))
require.Equal(s.T(), initialCopy, tc.initialValue)
})
}
if tc.expectedPanic {
require.Panics(s.T(), f)
} else {
f()
}
})
}
}
Expand Down Expand Up @@ -894,17 +900,21 @@ func (s *decimalTestSuite) TestTickLog() {

for name, tc := range tests {
s.Run(name, func() {
osmoassert.ConditionalPanic(s.T(), tc.expectedPanic, func() {
f := func() {
// Create a copy to test that the original was not modified.
// That is, that Ln() is non-mutative.
initialCopy := tc.initialValue.Clone()

// system under test.
res := tc.initialValue.TickLog()
fmt.Println(name, res.Sub(tc.expected).Abs())
require.True(osmomath.DecApproxEq(s.T(), tc.expected, res, tc.expectedErrTolerance))
require.Equal(s.T(), initialCopy, tc.initialValue)
})
}
if tc.expectedPanic {
require.Panics(s.T(), f)
} else {
f()
}
})
}
}
Expand Down Expand Up @@ -1010,15 +1020,19 @@ func (s *decimalTestSuite) TestCustomBaseLog() {
}
for name, tc := range tests {
s.Run(name, func() {
osmoassert.ConditionalPanic(s.T(), tc.expectedPanic, func() {
f := func() {
// Create a copy to test that the original was not modified.
// That is, that Ln() is non-mutative.
initialCopy := tc.initialValue.Clone()
// system under test.
res := tc.initialValue.CustomBaseLog(tc.base)
require.True(osmomath.DecApproxEq(s.T(), tc.expected, res, tc.expectedErrTolerance))
require.Equal(s.T(), initialCopy, tc.initialValue)
})
}
if tc.expectedPanic {
s.Require().Panics(f)
} else {
f()
}
})
}
}
Expand Down Expand Up @@ -1067,21 +1081,21 @@ func (s *decimalTestSuite) TestPowerInteger() {
"geom twap overflow: 2^log_2{max spot price + 1}": {
base: osmomath.TwoBigDec,
// add 1 for simplicity of calculation to isolate overflow.
exponent: uint64(osmomath.BigDecFromSDKDec(gammtypes.MaxSpotPrice).Add(osmomath.OneDec()).LogBase2().TruncateInt().Uint64()),
exponent: uint64(osmomath.BigDecFromSDKDec(osmomath.MaxSpotPrice).Add(osmomath.OneDec()).LogBase2().TruncateInt().Uint64()),

// https://www.wolframalpha.com/input?i=2%5E%28floor%28+log+base+2+%282%5E128%29%29%29+++39+digits
expectedResult: osmomath.MustNewDecFromStr("340282366920938463463374607431768211456"),
},
"geom twap overflow: 2^log_2{max spot price}": {
base: osmomath.TwoBigDec,
exponent: uint64(osmomath.BigDecFromSDKDec(gammtypes.MaxSpotPrice).LogBase2().TruncateInt().Uint64()),
exponent: uint64(osmomath.BigDecFromSDKDec(osmomath.MaxSpotPrice).LogBase2().TruncateInt().Uint64()),

// https://www.wolframalpha.com/input?i=2%5E%28floor%28+log+base+2+%282%5E128+-+1%29%29%29+++39+digits
expectedResult: osmomath.MustNewDecFromStr("170141183460469231731687303715884105728"),
},
"geom twap overflow: 2^log_2{max spot price / 2 - 2017}": { // 2017 is prime.
base: osmomath.TwoBigDec,
exponent: uint64(osmomath.BigDecFromSDKDec(gammtypes.MaxSpotPrice.Quo(sdk.NewDec(2)).Sub(sdk.NewDec(2017))).LogBase2().TruncateInt().Uint64()),
exponent: uint64(osmomath.BigDecFromSDKDec(osmomath.MaxSpotPrice.Quo(sdk.NewDec(2)).Sub(sdk.NewDec(2017))).LogBase2().TruncateInt().Uint64()),

// https://www.wolframalpha.com/input?i=e%5E10+41+digits
expectedResult: osmomath.MustNewDecFromStr("85070591730234615865843651857942052864"),
Expand Down
8 changes: 8 additions & 0 deletions osmomath/export_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
package osmomath

import sdk "github.com/cosmos/cosmos-sdk/types"

var (
EulersNumber = eulersNumber
TwoBigDec = twoBigDec
)

// 2^128 - 1, needs to be the same as gammtypes.MaxSpotPrice
// but we can't directly import that due to import cycles.
// Hence we use the same var name, in hopes that if any change there happens,
// this is caught via a CTRL+F
var MaxSpotPrice = sdk.NewDec(2).Power(128).Sub(sdk.OneDec())
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would having separate constants or utils package help mitigate the import cycles?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would have to be in its own independent go.mod, which seems pretty annoying for now

4 changes: 1 addition & 3 deletions osmomath/log2_bench_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ package osmomath
import (
"math/rand"
"testing"

gammtypes "github.com/osmosis-labs/osmosis/v13/x/gamm/types"
)

func BenchmarkLog2(b *testing.B) {
Expand All @@ -15,7 +13,7 @@ func BenchmarkLog2(b *testing.B) {
NewBigDec(2048 * 2048 * 2048 * 2048 * 2048),
MustNewDecFromStr("999999999999999999999999999999999999999999999999999999.9122181273612911"),
MustNewDecFromStr("0.563289239121902491248219047129047129"),
BigDecFromSDKDec(gammtypes.MaxSpotPrice), // 2^128 - 1
BigDecFromSDKDec(MaxSpotPrice), // 2^128 - 1
MustNewDecFromStr("336879543251729078828740861357450529340.45"), // (2^128 - 1) * 0.99
}

Expand Down
28 changes: 18 additions & 10 deletions osmomath/math_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import (

sdk "github.com/cosmos/cosmos-sdk/types"

"github.com/osmosis-labs/osmosis/v13/app/apptesting/osmoassert"

"github.com/stretchr/testify/require"
)

Expand Down Expand Up @@ -91,16 +89,21 @@ func TestPowApprox(t *testing.T) {
}

for i, tc := range testCases {
var actualResult sdk.Dec
osmoassert.ConditionalPanic(t, tc.base.Equal(sdk.ZeroDec()), func() {
expectPanic := tc.base.IsZero()
f := func() {
fmt.Println(tc.base)
actualResult = PowApprox(tc.base, tc.exp, tc.powPrecision)
actualResult := PowApprox(tc.base, tc.exp, tc.powPrecision)
require.True(
t,
tc.expectedResult.Sub(actualResult).Abs().LTE(tc.powPrecision),
fmt.Sprintf("test %d failed: expected value & actual value's difference should be less than precision", i),
)
})
}
if expectPanic {
require.Panics(t, f, fmt.Sprintf("test %d failed: should panic", i))
} else {
f()
}
}
}

Expand Down Expand Up @@ -155,14 +158,19 @@ func TestPow(t *testing.T) {
}

for i, tc := range testCases {
var actualResult sdk.Dec
osmoassert.ConditionalPanic(t, tc.base.Equal(sdk.ZeroDec()), func() {
actualResult = Pow(tc.base, tc.exp)
f := func() {
actualResult := Pow(tc.base, tc.exp)
require.True(
t,
tc.expectedResult.Sub(actualResult).Abs().LTE(powPrecision),
fmt.Sprintf("test %d failed: expected value & actual value's difference should be less than precision", i),
)
})
}
expectPanic := tc.base.IsZero()
if expectPanic {
require.Panics(t, f)
} else {
f()
}
}
}
8 changes: 5 additions & 3 deletions osmomath/rounding_direction_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,6 @@ import (

sdk "github.com/cosmos/cosmos-sdk/types"
"github.com/stretchr/testify/require"

"github.com/osmosis-labs/osmosis/v13/app/apptesting/osmoassert"
)

func TestDivIntByU64ToBigDec(t *testing.T) {
Expand Down Expand Up @@ -45,7 +43,11 @@ func TestDivIntByU64ToBigDec(t *testing.T) {
t.Run(name, func(t *testing.T) {
got, err := DivIntByU64ToBigDec(tt.i, tt.u, tt.round)
require.Equal(t, tt.want, got)
osmoassert.ConditionalError(t, tt.expErr, err)
if tt.expErr {
require.Error(t, err)
} else {
require.NoError(t, err)
}
})
}
}
15 changes: 9 additions & 6 deletions osmomath/sigfig_round_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ import (
sdk "github.com/cosmos/cosmos-sdk/types"

"github.com/stretchr/testify/require"

"github.com/osmosis-labs/osmosis/v13/app/apptesting/osmoassert"
)

func TestSigFigRound(t *testing.T) {
Expand Down Expand Up @@ -77,16 +75,21 @@ func TestSigFigRound(t *testing.T) {
for i, tc := range testCases {
tc := tc
t.Run(tc.name, func(t *testing.T) {
var actualResult sdk.Dec
osmoassert.ConditionalPanic(t, tc.tenToSigFig.Equal(sdk.ZeroInt()), func() {
actualResult = SigFigRound(tc.decimal, tc.tenToSigFig)
expPanic := tc.tenToSigFig.IsZero()
f := func() {
actualResult := SigFigRound(tc.decimal, tc.tenToSigFig)
require.Equal(
t,
tc.expectedResult,
actualResult,
fmt.Sprintf("test %d failed: expected value & actual value should be equal", i),
)
})
}
if expPanic {
ValarDragon marked this conversation as resolved.
Show resolved Hide resolved
require.Panics(t, f)
} else {
f()
}
})

}
Expand Down
3 changes: 3 additions & 0 deletions x/gamm/types/constants.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ var (
// SpotPriceSigFigs is the amount of significant figures used in return value of calculate SpotPrice
SpotPriceSigFigs = sdk.NewDec(10).Power(SigFigsExponent).TruncateInt()
// MaxSpotPrice is the maximum supported spot price. Anything greater than this will error.
// Internal note: Ctrl+F for MaxSpotPrice in code if ever changed.
// Other tests depend on being equal to MaxSpotPrice,
// but don't directly import it due to import issues.
MaxSpotPrice = sdk.NewDec(2).Power(128).Sub(sdk.OneDec())

// MultihopSwapFeeMultiplierForOsmoPools if a swap fees multiplier for trades consists of just two OSMO pools during a single transaction.
Expand Down