Speedup quo round up, start CL speedup integration #8014

ValarDragon · 2024-04-11T07:49:12Z

Significantly speedup quo round up by removing a second quo call, and lowering the big int size throughout by 2 words.

Also uses code reuse for panic checks as requested by @czarcas7ic

Summary by CodeRabbit

New Features
- Introduced enhanced rounding logic for division operations in financial calculations.
- Added a new function to support multiplication of decimal values, improving precision in financial computations.
Bug Fixes
- Corrected rounding issues in division operations to accurately handle remainders.
- Updated liquidity and price calculation methods to ensure accurate financial reporting in pools.

coderabbitai · 2024-04-11T07:49:19Z

Walkthrough

The update enhances mathematical operations in BigDec by refining rounding logic and adding overflow checks. It also introduces a new function for creating BigDec from product operations. In the Pool struct, the calculation method for actual amounts has been revised to improve accuracy based on liquidity and prices.

Changes

File Path	Change Summary
`osmomath/decimal.go`	Revised rounding in `QuoRoundUp` functions, added overflow check, and new function for `BigDec` creation.
`x/concentrated-liquidity/model/...`	Updated `CalcActualAmounts` method to refine actual amount calculations based on liquidity and prices.

Possibly related issues

[Feature]: Make liquidity in CL math a normal Dec again, not BigDec #8016: The changes in decimal.go may impact the performance and precision of calculations involving BigDec and Dec, which is relevant to the discussion in this issue about optimizing computational load by using Dec.

🐰✨📜✨🐰
A rabbit hopped through the code,
Twisting logic where numbers flowed.
With a flick and a hop, a new path it paved,
Ensuring every decimal perfectly behaved.
Celebrate the math, so deftly saved!
🐰✨📜✨🐰

Recent Review Details

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between aabae07 and a33352f.

Files selected for processing (2)

osmomath/decimal.go (14 hunks)
x/concentrated-liquidity/model/pool.go (2 hunks)

Files skipped from review as they are similar to previous changes (2)

osmomath/decimal.go
x/concentrated-liquidity/model/pool.go

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai generate interesting stats about this repository and render them as a table.
- @coderabbitai show all the console.log statements in this repository.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

github-actions · 2024-04-11T07:49:30Z

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-labs/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.

…d dependencies locally

…sis into dev/speedup_quoroundup

…d dependencies locally

coderabbitai

Actionable comments posted: 3

osmomath/decimal_test.go

x/concentrated-liquidity/swapstrategy/one_for_zero.go

…sis into dev/speedup_quoroundup

…d dependencies locally

coderabbitai

Actionable comments posted: 5

x/concentrated-liquidity/position_test.go

x/concentrated-liquidity/model/pool.go

coderabbitai

Actionable comments posted: 1

x/concentrated-liquidity/swapstrategy/spread_rewards.go

p0mvn

LGTM

Great speed-ups!

I will backport this and run a node for testing state compat

* Speedup quo round up * Code reuse * Missed a code re-use point * Add future notes * Comment cleanup * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Add new fn: NewBigDecFromDecMulDec * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove some extra ops from CL * Further perf notes * Make faster QuoRoundUpNextIntMut * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove another 2 BigDec ops * Add another dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Start moving some liquidity calls to Dec not BigDec * One more BigDec x Dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Another liq BigDec -> Dec * Missed one step * Move another Liquidity BigDec -> Dec * Minor spread reward update * Make CalcAmount1Dec use Dec for Liquidity * Make one more op mutative * One more speedup * Fix test * Speedup SpotPrice impl --------- Co-authored-by: github-actions <[email protected]> (cherry picked from commit 7b599d5) # Conflicts: # CHANGELOG.md # go.mod # go.sum # osmomath/decimal.go # osmomath/go.mod # osmomath/go.sum # osmoutils/go.mod # osmoutils/go.sum # x/concentrated-liquidity/math/math.go # x/concentrated-liquidity/swapstrategy/one_for_zero.go # x/epochs/go.mod # x/epochs/go.sum # x/ibc-hooks/go.mod # x/ibc-hooks/go.sum

* Speedup quo round up * Code reuse * Missed a code re-use point * Add future notes * Comment cleanup * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Add new fn: NewBigDecFromDecMulDec * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove some extra ops from CL * Further perf notes * Make faster QuoRoundUpNextIntMut * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove another 2 BigDec ops * Add another dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Start moving some liquidity calls to Dec not BigDec * One more BigDec x Dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Another liq BigDec -> Dec * Missed one step * Move another Liquidity BigDec -> Dec * Minor spread reward update * Make CalcAmount1Dec use Dec for Liquidity * Make one more op mutative * One more speedup * Fix test * Speedup SpotPrice impl --------- Co-authored-by: github-actions <[email protected]>

* BigDec operation speedups (backport #8006) * Speedup quo round up, start CL speedup integration (#8014) * Speedup quo round up * Code reuse * Missed a code re-use point * Add future notes * Comment cleanup * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Add new fn: NewBigDecFromDecMulDec * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove some extra ops from CL * Further perf notes * Make faster QuoRoundUpNextIntMut * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Remove another 2 BigDec ops * Add another dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Start moving some liquidity calls to Dec not BigDec * One more BigDec x Dec op * Auto: update go.mod after push to dev/speedup_quoroundup that modified dependencies locally * Another liq BigDec -> Dec * Missed one step * Move another Liquidity BigDec -> Dec * Minor spread reward update * Make CalcAmount1Dec use Dec for Liquidity * Make one more op mutative * One more speedup * Fix test * Speedup SpotPrice impl --------- Co-authored-by: github-actions <[email protected]> * updates * updates --------- Co-authored-by: Dev Ojha <[email protected]> Co-authored-by: github-actions <[email protected]>

Speedup quo round up

f50052b

ValarDragon added V:state/compatible/backport State machine compatible PR, should be backported A:backport/v23.x backport patches to v23.x branch A:backport/v24.x backport patches to v24.x branch labels Apr 11, 2024

ValarDragon and others added 5 commits April 11, 2024 17:14

Code reuse

e340728

Missed a code re-use point

4ff1858

Add future notes

5fbf7ee

Comment cleanup

590a939

Auto: update go.mod after push to dev/speedup_quoroundup that modifie…

cacbcfe

…d dependencies locally

ValarDragon requested review from mattverse and nicolaslara as code owners April 11, 2024 08:50

ValarDragon added 2 commits April 11, 2024 18:09

Add new fn: NewBigDecFromDecMulDec

8b87e7b

Merge branch 'dev/speedup_quoroundup' of github.com:osmosis-labs/osmo…

c4c24f0

…sis into dev/speedup_quoroundup

ValarDragon requested review from czarcas7ic, p0mvn and AlpinYukseloglu as code owners April 11, 2024 09:09

github-actions bot added C:x/epochs C:x/concentrated-liquidity labels Apr 11, 2024

Auto: update go.mod after push to dev/speedup_quoroundup that modifie…

87a067f

…d dependencies locally

coderabbitai bot reviewed Apr 11, 2024

View reviewed changes

osmomath/decimal_test.go Outdated Show resolved Hide resolved

osmomath/decimal_test.go Outdated Show resolved Hide resolved

x/concentrated-liquidity/swapstrategy/one_for_zero.go Outdated Show resolved Hide resolved

ValarDragon and others added 8 commits April 11, 2024 18:19

Remove some extra ops from CL

d61aba4

Merge branch 'dev/speedup_quoroundup' of github.com:osmosis-labs/osmo…

14dfdb7

…sis into dev/speedup_quoroundup

Further perf notes

b8e39bc

Make faster QuoRoundUpNextIntMut

2c52870

Auto: update go.mod after push to dev/speedup_quoroundup that modifie…

7911f25

…d dependencies locally

Remove another 2 BigDec ops

93041da

Add another dec op

67b62f5

Auto: update go.mod after push to dev/speedup_quoroundup that modifie…

7147aa7

…d dependencies locally

ValarDragon added 3 commits April 11, 2024 22:03

Another liq BigDec -> Dec

6c7846f

Missed one step

0923f2b

Move another Liquidity BigDec -> Dec

ed9072d

coderabbitai bot reviewed Apr 11, 2024

View reviewed changes

x/concentrated-liquidity/position_test.go Show resolved Hide resolved

x/concentrated-liquidity/model/pool.go Outdated Show resolved Hide resolved

Minor spread reward update

bca4a54

coderabbitai bot reviewed Apr 11, 2024

View reviewed changes

x/concentrated-liquidity/swapstrategy/spread_rewards.go Show resolved Hide resolved

ValarDragon added 4 commits April 11, 2024 23:32

Make CalcAmount1Dec use Dec for Liquidity

2b75b79

Make one more op mutative

6347c4a

One more speedup

8fce257

Fix test

aabae07

This was referenced Apr 12, 2024

Remove some 0 allocations in CL routing osmosis-labs/sqs#166

Merged

Add an LRU cache for tick to sqrt price osmosis-labs/sqs#167

Merged

Speedup SpotPrice impl

a33352f

p0mvn approved these changes Apr 12, 2024

View reviewed changes

p0mvn merged commit 7b599d5 into main Apr 12, 2024
1 check passed

p0mvn deleted the dev/speedup_quoroundup branch April 12, 2024 16:31

p0mvn restored the dev/speedup_quoroundup branch April 12, 2024 16:32

p0mvn added A:backport/v24.x backport patches to v24.x branch and removed A:backport/v24.x backport patches to v24.x branch labels Apr 12, 2024

This was referenced Apr 12, 2024

Speedup quo round up, start CL speedup integration (backport #8014) #8034

Closed

Speedup quo round up, start CL speedup integration (backport #8014) #8035

Closed

Speedup quo round up, start CL speedup integration (backport #8014) #8036

Closed

p0mvn mentioned this pull request Apr 12, 2024

Roman/backport dev math speed up v24 #8037

Merged

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

Broken Links Detected #8046

Closed

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

Broken Links Detected #8183

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Speedup quo round up, start CL speedup integration #8014

Speedup quo round up, start CL speedup integration #8014

ValarDragon commented Apr 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot commented Apr 11, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

coderabbitai bot left a comment

p0mvn left a comment

Speedup quo round up, start CL speedup integration #8014

Speedup quo round up, start CL speedup integration #8014

Conversation

ValarDragon commented Apr 11, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

coderabbitai bot commented Apr 11, 2024 • edited Loading

Walkthrough

Changes

Possibly related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot commented Apr 11, 2024

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

p0mvn left a comment

Choose a reason for hiding this comment

ValarDragon commented Apr 11, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 11, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)