perf: Remove an extra heap allocation from NewLegacyDec

[ValarDragon]

Description

Performance improvement to NewLegacyDec. Its pretty small impact in terms of the whole system, but noticed it so figured I'd make a quick PR for it.

This is covered by existing tests.

---

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

• included the correct type prefix in the PR title
• confirmed ! in the type prefix if API or client breaking change
• targeted the correct branch (see PR Targeting)
• provided a link to the relevant issue or specification
• reviewed "Files changed" and left comments if necessary
• included the necessary unit and integration tests
• added a changelog entry to CHANGELOG.md
• updated the relevant documentation or specification, including comments for documenting Go code
• confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

• confirmed the correct type prefix in the PR title
• confirmed all author checklist items have been addressed
• reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

• Refactor
  • Optimized certain math operations in the math module for improved performance by updating the LegacyNewDecWithPrec function.

[coderabbitai]

Walkthrough

Walkthrough

The update focuses on optimizing specific math operations in the math module to boost performance by refining overflow checks and minimizing heap allocations.

Changes

File(s)	Change Summary
math/dec.go	Updated LegacyNewDecWithPrec to utilize a big.Int variable bi for precise multiplication.
math/CHANGELOG.md	Accelerated math operations through optimized overflow checks and reduced heap allocations.

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

• X
• Mastodon
• Reddit
• LinkedIn

---

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-tests for this file.
• 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 tests 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 from git and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @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.
• The JSON schema for the configuration file is available here.
• 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between a79f932 and c873a57.

Files selected for processing (1)

• math/dec.go (1 hunks)

Additional comments: 1

math/dec.go (1)

• 105-107: The optimization introduced in the LegacyNewDecWithPrec function by using a local variable bi to store the big.Int representation of i and then using it for multiplication with precisionMultiplier(prec) is a good practice for reducing unnecessary heap allocations. This change is expected to slightly improve the performance by avoiding the direct use of big.NewInt(i) for multiplication, which can lead to extra heap allocations. The logic of the function remains intact, ensuring that the functionality is preserved while enhancing performance.

However, it's important to ensure that this optimization does not introduce any side effects in the usage of the LegacyNewDecWithPrec function across the Cosmos SDK. Given the nature of the change, it's unlikely to cause functional regressions, but a thorough testing strategy should be in place to validate the change across different scenarios where LegacyNewDecWithPrec is used.

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between c873a57 and 9160d3f.

Files selected for processing (1)

• math/CHANGELOG.md (1 hunks)

Additional comments: 1

math/CHANGELOG.md (1)

• 46-46: The changelog entry for PR 19466 accurately reflects the changes made to optimize the math.NewLegacyDec function by reducing heap allocation. It follows the project's guidelines for changelog entries, grouping it under "Features" and providing a link to the PR for more details. This entry helps users understand the impact of the changes without needing to delve into the code or PR discussion directly.

[alexanderbez]

Thanks! LGTM

[likhita-809]

lgtm

[julienrbrt]

Ditto #19467 (comment)

[coderabbitai]

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 9160d3f and f36128a.

Files selected for processing (2)

• math/CHANGELOG.md (1 hunks)
• math/dec.go (1 hunks)

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

• math/CHANGELOG.md
• math/dec.go