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.

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

Spark fee calculation fix #1424

Merged
merged 1 commit into from
Apr 27, 2024
Merged

Spark fee calculation fix #1424

merged 1 commit into from
Apr 27, 2024

Conversation

levonpetrosyan93
Copy link
Contributor

@levonpetrosyan93 levonpetrosyan93 commented Apr 2, 2024

Summary by CodeRabbit

  • Refactor
    • Improved the accuracy of transaction size calculations in the wallet, affecting fees and transaction times.

Copy link

coderabbitai bot commented Apr 2, 2024

Walkthrough

The recent update brings a refined approach to the calculation of transaction sizes in the wallet software. It specifically adjusts the way nBytes—a key metric representing the size of transactions—is computed. This adjustment takes into account various factors such as different types of proofs, data sizes, and the components of transactions, ensuring more accurate estimations and optimizations for users.

Changes

Files Change Summary
.../coincontroldialog.cpp, .../sparkwallet.cpp Adjusted nBytes calculation to include various proofs, data sizes, grootle proofs, private outputs, and transaction parts.

🐰✨
Changes abound, in the code, they're found,
Bytes dance, numbers prance, in a more precise round.
With each proof and byte, our transactions take flight,
A hop, skip, and a jump, towards efficiency's light.
🌟🚀🐇

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/coderabbit-overrides.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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

Review Status

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 17aab98 and dfb75e3.
Files selected for processing (2)
  • src/qt/coincontroldialog.cpp (1 hunks)
  • src/spark/sparkwallet.cpp (1 hunks)
Additional comments not posted (5)
src/qt/coincontroldialog.cpp (1)

530-532: The adjustments to the nBytes calculation for Spark transactions introduce specific constants and multipliers for different transaction components. Ensure these values accurately reflect the transaction structure and sizes for Spark and other proofs. It's crucial to validate these constants against the actual transaction sizes to prevent underestimating or overestimating transaction fees.

Consider adding comments detailing the source or rationale behind these constants and multipliers for future maintainability and clarity. This will help others understand the basis of these calculations and make it easier to update them if transaction structures change.

src/spark/sparkwallet.cpp (4)

1698-1700: The calculation for the transaction size seems to be hardcoded with specific values for grootle proofs, private outputs, and transaction parts. This approach might not be flexible or accurate for future changes or different transaction types.

Consider implementing a more dynamic way to calculate transaction sizes based on the actual components of the transaction. This could involve calculating sizes based on the serialized sizes of each component or using predefined constants that can be easily updated.


1698-1700: The loop for fee estimation in SelectSparkCoins recalculates the required amount and selects coins until the estimated fee stabilizes. However, this approach might lead to unnecessary iterations if the fee estimation does not change significantly between iterations.

Consider adding a condition to break out of the loop if the difference between the new fee and the previous fee is below a certain threshold. This could improve efficiency by avoiding unnecessary iterations.


1698-1700: The method GetAvailableSparkCoins correctly filters out coins based on coin control selection and locked coins. However, the readability of the lambda function used for filtering could be improved.

Consider extracting the lambda function into a separate, named function or adding comments to explain the filtering criteria more clearly. This could improve the readability and maintainability of the code.


1698-1700: The method CreateSparkSpendTransaction contains complex logic for creating a Spark spend transaction. The error handling in this method could be improved to provide more detailed information about the failure reasons.

Consider adding more specific error messages or exceptions for different failure scenarios, such as insufficient funds, transaction size limits, or invalid inputs. This could help in diagnosing issues more effectively.

@reubenyap reubenyap requested review from psolstice and aleflm April 5, 2024 09:36
@reubenyap reubenyap merged commit fb1c99f into master Apr 27, 2024
6 checks passed
@reubenyap reubenyap deleted the spark_fee branch April 27, 2024 15:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants