Change LiquidityNetInDirection return type to sdk math
#8509
Conversation
mattverse
requested review from
czarcas7ic,
p0mvn and
AlpinYukseloglu
as code owners
WalkthroughThe recent modifications focus on addressing type inconsistencies and potential panics in the Changes
Sequence Diagram(s)The conceptual change involves the modification of return types, which doesn't significantly alter the control flow or introduce new features. Therefore, no sequence diagrams are provided. Assessment against linked issues
These changes address the objectives, ensuring type consistency and preventing runtime panics due to type mismatches. Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (2)
Additional comments not posted (2)
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (1)
x/concentrated-liquidity/types/cl_pool_extensionI.go (1)
25-25: Update allGetLiquiditymethod implementations to returnsdkmath.LegacyDec.The following instances of the
GetLiquiditymethod still returnosmomath.Decand need to be updated tosdkmath.LegacyDec:
x/concentrated-liquidity/model/pool.gotests/mocks/cl_pool.goPlease update these implementations to ensure consistency across the codebase.
Analysis chain
Update to
GetLiquiditymethod return type is correct.The return type of the
GetLiquiditymethod has been updated tosdkmath.LegacyDecto prevent panics and ensure proper unmarshalling of the response.Ensure that all implementations of
GetLiquidityare updated accordingly.Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all implementations of the `GetLiquidity` method are updated to return `sdkmath.LegacyDec`. # Test: Search for the `GetLiquidity` method implementation. Expect: Only occurances of the new return type. rg --type go -A 5 $'GetLiquidity() sdkmath.LegacyDec'Length of output: 54
Script:
#!/bin/bash # Description: Verify all implementations of the `GetLiquidity` method are updated to return `sdkmath.LegacyDec`. # Test: Search for the `GetLiquidity` method implementation. Expect: Only occurrences of the new return type. rg --type go 'GetLiquidity()' -A 5Length of output: 33231
Closes: #8469
What is the purpose of the change
Changes return value for pool.GetLiquidity, as it was returning osmomath.LegacyDec thus was not able to be unmarshalled when being returned as result for the query.
Testing and Verifying
This change is a trivial rework / code cleanup without any test coverage.
Documentation and Release Note
Unreleasedsection ofCHANGELOG.md?Where is the change documented?
x/{module}/README.md)