Convert sdk.Int to BigDec #6409

hieuvubk · 2023-09-14T11:58:29Z

Closes: #6370

What is the purpose of the change

Create a func BigDecFromSDKInt to convert sdk.Int => BigDec instead of converting sdk.Int => sdk.Dec => BigDec
Benchmark:

OLD:
BenchmarkBigDecFromInt-16        2074845               579.7 ns/op           640 B/op         18 allocs/op

NEW:
BenchmarkBigDecFromInt-16        3566844               312.9 ns/op           312 B/op          9 allocs/op

Testing and Verifying

(Please pick one of the following options)

This change is a trivial rework / code cleanup without any test coverage.

(or)

This change is already covered by existing tests, such as (please describe tests).

(or)

This change added tests and can be verified as follows:

(example:)

Added unit test that validates ...
Added integration tests for end-to-end deployment with ...
Extended integration test for ...
Manually verified the change by ...

Documentation and Release Note

Does this pull request introduce a new feature or user-facing behavior changes?
Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

Specification (x/{module}/README.md)
Osmosis documentation site
Code comments?
N/A

…t tests at low price level

github-actions · 2023-09-14T11:58:50Z

Important Notice

This PR modifies an in-repo Go module. It is one of:

osmomath
osmoutils
x/ibc-hooks
x/epochs

The dependent Go modules, especially the root one, will have to be
updated to reflect the changes. Failing to do so might cause e2e to fail.

Please follow the instructions below:

Open https://github.com/osmosis/osmosis/actions/workflows/go-mod-auto-bump.yml
Provide the current branch name
On success, confirm if an automated commit corretly updated the go.mod and go.sum files

Please let us know if you need any help.

p0mvn

Thanks for the change, please see comment

p0mvn · 2023-09-14T21:16:51Z

osmomath/decimal.go

+func BigDecFromSDKInt(i Int) BigDec {
+	return NewBigDecFromBigIntWithPrec(i.BigInt(), 0)
+}


Note that this is not mutative. See that BigInt() reinitializes the underlying buffer.

Let's still keep this, please. However, I'm also wondering if we can make a mutative version that would reuse the input's buffer?

Yeah I see, currently it's hard to access Int.i directly without BigInt()

Could you make an issue to consider this in the future and potentially talk to the SDK team about exposing such API?

Created an issue for tracking #17772

I tried returning Int.i in my local, performance is improved but the potential risks are unclear

pysel

thanks! left a small nit, lgtm when Roman's comment is addressed

pysel · 2023-09-15T00:05:06Z

osmomath/decimal.go

@@ -582,6 +582,12 @@ func BigDecFromDec(d Dec) BigDec {
 	return NewBigDecFromBigIntWithPrec(d.BigInt(), PrecisionDec)
 }

+// BigDecFromSDKInt returns the BigDec representation of an sdkInt.


nit: I think we do not reference sdk anymore, Int is defined in osmomath package

Suggested change

// BigDecFromSDKInt returns the BigDec representation of an sdkInt.

// BigDecFromSDKInt returns the BigDec representation of an Int.

p0mvn · 2023-09-16T01:42:16Z

@hieuvubk please add a changelog entry and create an issue. Thanks!

p0mvn · 2023-09-16T01:42:44Z

Marking as draft until the requests are resolved

hieuvubk · 2023-09-16T08:43:19Z

@hieuvubk please add a changelog entry and create an issue. Thanks!

Added!
Tracking issue: #17772

p0mvn · 2023-09-16T13:46:05Z

Thanks @hieuvubk

There are more TODOs left related to Dec() functions with no reallocations:

osmosis/x/concentrated-liquidity/math/math.go

Line 29 in 1f21fc3

// TODO (perf): consider Dec() function that does not reallocate

Are you planning on working on that as well? @hieuvubk

hieuvubk · 2023-09-16T14:24:17Z

Thanks @hieuvubk

There are more TODOs left related to Dec() functions with no reallocations:

osmosis/x/concentrated-liquidity/math/math.go

Line 29 in 1f21fc3

// TODO (perf): consider Dec() function that does not reallocate

Are you planning on working on that as well? @hieuvubk

I thought #6261 should resolve Dec(), also Im working on QuoRoundUp & QuoTruncate

p0mvn · 2023-09-17T20:15:31Z

@hieuvubk could you investigate the e2e failure please? I tried rerunning it a few times, and it didn't work. From logs, unclear what the issue is so might require investigations

hieuvubk · 2023-09-18T14:02:24Z

@hieuvubk could you investigate the e2e failure please? I tried rerunning it a few times, and it didn't work. From logs, unclear what the issue is so might require investigations

I think it's due to a version conflict of osmomath because go.mod is taking the version of osmomath as v0.0.7-0.20230911120014-b14342e08daf while my change hasn't been tagged yet.

p0mvn · 2023-09-18T17:20:05Z

@hieuvubk could you investigate the e2e failure please? I tried rerunning it a few times, and it didn't work. From logs, unclear what the issue is so might require investigations

I think it's due to a version conflict of osmomath because go.mod is taking the version of osmomath as v0.0.7-0.20230911120014-b14342e08daf while my change hasn't been tagged yet.

Please run:

go get github.com/osmosis-labs/osmosis/osmomath@4225d5f

Should update the tag to the one taken from a commit on your branch. You should see updates in go.mod and go.sum. Please also run go work sync after and make sure that there are no errors

hieuvubk · 2023-09-18T18:43:35Z

thanks @p0mvn it works!

p0mvn

One more request before merge please @hieuvubk

p0mvn · 2023-09-18T19:43:05Z

x/concentrated-liquidity/math/math.go

-	// TODO (perf): consider better conversion helpers to minimize reallocations.
-	amountBigDec := osmomath.BigDecFromDec(amount.ToLegacyDec())
+	amountBigDec := osmomath.BigDecFromSDKInt(amount)


Let's keep these comments please.

Do you mint creating an issue for this osmosis side and linking it to cosmos/cosmos-sdk#17772?

Thanks!

…-labs/osmosis into hieu/bigdec_from_sdk_int

CHANGELOG.md

* refactor/test(CL): Stricter rounding behavior in CL math methods; unit tests at low price level * comment updates * convert int => bigdec instead of int => dec => bigdec * tests * Liquidity1 lack * add changelog endpoint * update go mod * keep comments * go mod * fix * Update CHANGELOG.md --------- Co-authored-by: Roman <roman@osmosis.team> (cherry picked from commit e2b521d) # Conflicts: # CHANGELOG.md # go.mod # go.sum # osmomath/decimal_test.go # x/concentrated-liquidity/math/math.go

* Convert sdk.Int to BigDec (#6409) * refactor/test(CL): Stricter rounding behavior in CL math methods; unit tests at low price level * comment updates * convert int => bigdec instead of int => dec => bigdec * tests * Liquidity1 lack * add changelog endpoint * update go mod * keep comments * go mod * fix * Update CHANGELOG.md --------- Co-authored-by: Roman <roman@osmosis.team> (cherry picked from commit e2b521d) # Conflicts: # CHANGELOG.md # go.mod # go.sum # osmomath/decimal_test.go # x/concentrated-liquidity/math/math.go * resolve conflict * go mod tidy * update go mod * Update CHANGELOG.md --------- Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: roman <roman@osmosis.team>

p0mvn and others added 6 commits September 11, 2023 14:59

refactor/test(CL): Stricter rounding behavior in CL math methods; uni…

ad759f8

…t tests at low price level

comment updates

3cc21a8

convert int => bigdec instead of int => dec => bigdec

cb6f73d

tests

938436d

Liquidity1 lack

341f982

merge main

ef9785c

hieuvubk requested a review from pysel September 14, 2023 11:58

hieuvubk requested review from czarcas7ic, p0mvn and AlpinYukseloglu as code owners September 14, 2023 11:58

github-actions bot added the C:x/concentrated-liquidity label Sep 14, 2023

hieuvubk mentioned this pull request Sep 14, 2023

refactor/test(CL): Stricter rounding behavior in CL math methods; unit tests at low price level #6369

Merged

6 tasks

hieuvubk added the V:state/compatible/no_backport State machine compatible PR, depends on prior breaks label Sep 14, 2023

p0mvn requested changes Sep 14, 2023

View reviewed changes

pysel reviewed Sep 15, 2023

View reviewed changes

pysel added the A:no-changelog label Sep 15, 2023

p0mvn marked this pull request as draft September 16, 2023 01:38

p0mvn marked this pull request as ready for review September 16, 2023 01:39

p0mvn added V:state/compatible/backport State machine compatible PR, should be backported A:backport/v19.x backport patches to v19.x branch and removed A:no-changelog V:state/compatible/no_backport State machine compatible PR, depends on prior breaks labels Sep 16, 2023

p0mvn marked this pull request as draft September 16, 2023 01:42

add changelog endpoint

1f21fc3

hieuvubk marked this pull request as ready for review September 16, 2023 08:43

p0mvn approved these changes Sep 16, 2023

View reviewed changes

Merge branch 'main' into hieu/bigdec_from_sdk_int

4225d5f

update go mod

39f676a

p0mvn approved these changes Sep 18, 2023

View reviewed changes

Merge branch 'main' into hieu/bigdec_from_sdk_int

a16034f

p0mvn requested changes Sep 18, 2023

View reviewed changes

hieuvubk added 5 commits September 19, 2023 03:05

keep comments

503af84

Merge branch 'hieu/bigdec_from_sdk_int' of https://github.com/osmosis…

a574e39

…-labs/osmosis into hieu/bigdec_from_sdk_int

merge main

03a878d

go mod

88e48d5

fix

9e18a01

hieuvubk requested a review from p0mvn September 19, 2023 07:40

Merge branch 'main' into hieu/bigdec_from_sdk_int

507daf3

p0mvn reviewed Sep 20, 2023

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

Update CHANGELOG.md

79f03e2

p0mvn approved these changes Sep 20, 2023

View reviewed changes

p0mvn merged commit e2b521d into main Sep 20, 2023
1 check passed

p0mvn deleted the hieu/bigdec_from_sdk_int branch September 20, 2023 01:32

mergify bot mentioned this pull request Sep 20, 2023

Convert sdk.Int to BigDec (backport #6409) #6449

Merged

github-actions bot mentioned this pull request Mar 1, 2024

Broken Links Detected #7641

Closed

github-actions bot mentioned this pull request May 15, 2024

Broken Links Detected #8269

Closed

github-actions bot mentioned this pull request Oct 15, 2024

Broken Links Detected notional-labs/osmosis#75

Closed

github-actions bot mentioned this pull request Nov 1, 2024

Broken Links Detected notional-labs/osmosis#76

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert sdk.Int to BigDec #6409

Convert sdk.Int to BigDec #6409

hieuvubk commented Sep 14, 2023 •

edited

Loading

github-actions bot commented Sep 14, 2023

p0mvn left a comment

p0mvn Sep 14, 2023

hieuvubk Sep 15, 2023

p0mvn Sep 15, 2023

hieuvubk Sep 16, 2023

hieuvubk Sep 16, 2023

pysel left a comment

pysel Sep 15, 2023

p0mvn commented Sep 16, 2023

p0mvn commented Sep 16, 2023

hieuvubk commented Sep 16, 2023

p0mvn commented Sep 16, 2023

hieuvubk commented Sep 16, 2023 •

edited

Loading

p0mvn commented Sep 17, 2023

hieuvubk commented Sep 18, 2023

p0mvn commented Sep 18, 2023

hieuvubk commented Sep 18, 2023

p0mvn left a comment

p0mvn Sep 18, 2023

hieuvubk Sep 18, 2023

hieuvubk Sep 18, 2023

	// BigDecFromSDKInt returns the BigDec representation of an sdkInt.
	// BigDecFromSDKInt returns the BigDec representation of an Int.

Convert sdk.Int to BigDec #6409

Convert sdk.Int to BigDec #6409

Conversation

hieuvubk commented Sep 14, 2023 • edited Loading

What is the purpose of the change

Testing and Verifying

Documentation and Release Note

github-actions bot commented Sep 14, 2023

p0mvn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pysel left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

p0mvn commented Sep 16, 2023

p0mvn commented Sep 16, 2023

hieuvubk commented Sep 16, 2023

p0mvn commented Sep 16, 2023

hieuvubk commented Sep 16, 2023 • edited Loading

p0mvn commented Sep 17, 2023

hieuvubk commented Sep 18, 2023

p0mvn commented Sep 18, 2023

hieuvubk commented Sep 18, 2023

p0mvn left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hieuvubk commented Sep 14, 2023 •

edited

Loading

hieuvubk commented Sep 16, 2023 •

edited

Loading