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

Multi send #1445

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Multi send #1445

wants to merge 2 commits into from

Conversation

levoncrypto
Copy link
Contributor

@levoncrypto levoncrypto commented Jun 2, 2024

This update enhances multi-sending capabilities. Previously, sending from a transparent address was limited to either another transparent address or a private address. Now, you can send Firo from a transparent address to a private and transparent address. Transaction fees will be evenly distributed across all transactions. When the fee is intended to be deducted from the sent amount, it will be deducted from the total transaction, not from any specific transaction. Sending Firo has now become more versatile and functional.

Copy link

coderabbitai bot commented Jun 2, 2024

Walkthrough

This pull request introduces comprehensive modifications to the Spark transaction handling across multiple files in the codebase. The changes primarily focus on enhancing the flexibility of creating and processing transactions involving Spark addresses. Key modifications include updating method signatures in wallet-related classes, expanding the logic for handling multiple recipients, and improving the transaction creation process to support both standard and Spark addresses more effectively.

Changes

File Change Summary
src/qt/sendcoinsdialog.cpp Modified transaction preparation logic for Spark addresses, relaxing conditions for processing transactions
src/qt/walletmodel.cpp Updated transaction preparation methods to handle both standard and Spark addresses more flexibly
src/spark/sparkwallet.cpp Added support for multiple recipients in CreateSparkMintTransactions method
src/wallet/rpcwallet.cpp Enhanced mintspark function with more complex parameter parsing and recipient handling
src/wallet/wallet.cpp Updated Spark transaction creation methods to accept vector of recipients
src/wallet/wallet.h Added new methods for Spark mint transactions and storage

Sequence Diagram

sequenceDiagram
    participant User
    participant SendCoinsDialog
    participant WalletModel
    participant SparkWallet
    participant Wallet

    User->>SendCoinsDialog: Initiate Transaction
    SendCoinsDialog->>WalletModel: Prepare Transaction
    WalletModel->>SparkWallet: Create Mint Transactions
    SparkWallet->>Wallet: Process Recipients
    Wallet-->>SparkWallet: Transaction Details
    SparkWallet-->>WalletModel: Mint Transaction
    WalletModel-->>SendCoinsDialog: Transaction Ready
Loading

Possibly related PRs

Poem

🐰 Hopping through code with glee,
Spark transactions now run free!
Recipients dance, addresses shine,
Flexibility's the new design!
Wallet magic, rabbit's delight! 🎩✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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.
    • @coderabbitai help me debug CodeRabbit configuration file.

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 using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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.

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: 9

Outside diff range and nitpick comments (1)
src/qt/walletmodel.cpp (1)

Line range hint 1358-1412: Refactor prepareMintSparkTransaction to improve readability and maintainability.

The prepareMintSparkTransaction method has multiple responsibilities, including validation, transaction creation, and error handling. Consider breaking this method into smaller, more focused methods. For example, separate the validation logic into a method validateRecipients, and the transaction creation logic into createMintSparkTransaction. This will make the code easier to maintain and test.

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cf19353 and 0af162e.

Files selected for processing (16)
  • qa/rpc-tests/llmq-is-spark.py (1 hunks)
  • qa/rpc-tests/spark_mint.py (1 hunks)
  • qa/rpc-tests/spark_setmintstatus_validation.py (2 hunks)
  • qa/rpc-tests/spark_spend_gettransaction.py (1 hunks)
  • src/qt/sendcoinsdialog.cpp (4 hunks)
  • src/qt/sparkmodel.cpp (2 hunks)
  • src/qt/walletmodel.cpp (3 hunks)
  • src/qt/walletmodeltransaction.cpp (2 hunks)
  • src/spark/sparkwallet.cpp (9 hunks)
  • src/spark/sparkwallet.h (1 hunks)
  • src/test/evospork_tests.cpp (1 hunks)
  • src/test/fixtures.cpp (2 hunks)
  • src/wallet/rpcwallet.cpp (3 hunks)
  • src/wallet/test/spark_tests.cpp (9 hunks)
  • src/wallet/wallet.cpp (7 hunks)
  • src/wallet/wallet.h (2 hunks)
Files not reviewed due to errors (6)
  • qa/rpc-tests/spark_setmintstatus_validation.py (no review received)
  • src/qt/walletmodeltransaction.cpp (no review received)
  • qa/rpc-tests/spark_spend_gettransaction.py (no review received)
  • qa/rpc-tests/llmq-is-spark.py (no review received)
  • src/qt/sparkmodel.cpp (no review received)
  • qa/rpc-tests/spark_mint.py (no review received)
Additional context used
Ruff
qa/rpc-tests/spark_setmintstatus_validation.py

3-3: from test_framework.util import * used; unable to detect undefined names


13-13: enable_mocktime may be undefined, or defined from star imports


14-14: start_nodes may be undefined, or defined from star imports


65-65: assert_raises may be undefined, or defined from star imports


65-65: JSONRPCException may be undefined, or defined from star imports


66-66: assert_raises may be undefined, or defined from star imports


66-66: JSONRPCException may be undefined, or defined from star imports


67-67: assert_raises may be undefined, or defined from star imports


67-67: JSONRPCException may be undefined, or defined from star imports


68-68: assert_raises may be undefined, or defined from star imports


68-68: JSONRPCException may be undefined, or defined from star imports


69-69: assert_raises may be undefined, or defined from star imports


69-69: JSONRPCException may be undefined, or defined from star imports

qa/rpc-tests/spark_spend_gettransaction.py

2-2: from decimal import * used; unable to detect undefined names


5-5: from test_framework.util import * used; unable to detect undefined names


15-15: enable_mocktime may be undefined, or defined from star imports


16-16: start_nodes may be undefined, or defined from star imports


29-29: Local variable valid_address is assigned to but never used


55-55: Decimal may be undefined, or defined from star imports


65-65: Decimal may be undefined, or defined from star imports


77-77: assert_raises may be undefined, or defined from star imports


77-77: JSONRPCException may be undefined, or defined from star imports

qa/rpc-tests/llmq-is-spark.py

6-6: from test_framework.mininode import * used; unable to detect undefined names


8-8: test_framework.util.sync_blocks imported but unused


8-8: test_framework.util.set_node_times imported but unused


9-9: test_framework.util.isolate_node imported but unused


9-9: test_framework.util.reconnect_isolated_node imported but unused


9-9: test_framework.util.set_mocktime imported but unused


9-9: test_framework.util.get_mocktime imported but unused


10-10: test_framework.util.assert_equal imported but unused


11-11: test_framework.util.bitcoind_processes imported but unused


11-11: test_framework.util.start_nodes imported but unused


11-11: test_framework.util.start_node imported but unused


11-11: test_framework.util.connect_nodes_bi imported but unused


43-43: Statement ends with an unnecessary semicolon


56-56: Statement ends with an unnecessary semicolon

Additional comments not posted (19)
src/spark/sparkwallet.h (1)

117-117: The addition of vecSend parameter in CreateSparkMintTransactions method aligns with the PR's multi-send feature.

src/test/fixtures.cpp (1)

Line range hint 362-373: The initialization of vecSend and its use in MintAndStoreSpark correctly reflects the changes made in CSparkWallet. This ensures that the test setup aligns with the new functionality.

src/wallet/test/spark_tests.cpp (1)

79-80: The introduction of vecSend in various test cases correctly reflects the updated method signature in MintAndStoreSpark. The tests are well-structured to check the new functionality.

Also applies to: 185-186, 335-336, 426-427, 477-477

src/qt/sendcoinsdialog.cpp (4)

533-533: Confirm the handling of Spark transactions in non-anonymous mode.

Verification successful

Let's proceed by examining the implementation of the mintSparkCoins method in walletmodel.cpp to ensure it handles Spark transactions correctly.


Let's try a different approach to locate and review the implementation of the mintSparkCoins method in walletmodel.cpp.


The implementation of the mintSparkCoins method in walletmodel.cpp has been successfully retrieved. The method appears to handle Spark transactions by committing transactions and processing recipients' messages.

  • The method locks the wallet and main chain.
  • It iterates over the transactions and commits each one.
  • It handles messages from recipients and serializes the transaction.

This confirms that the mintSparkCoins method is designed to handle Spark transactions properly when fAnonymousMode is false, sparkAddressCount is greater than 0, and spark::IsSparkAllowed() returns true.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that Spark transactions are handled correctly when `fAnonymousMode` is false and `sparkAddressCount` is greater than 0.

# Test: Search for the method usage. Expect: Proper transaction handling.
rg --type cpp $'mintSparkCoins'

Length of output: 421



Script:

#!/bin/bash
# Description: Retrieve the implementation of the mintSparkCoins method in walletmodel.cpp to verify proper handling of Spark transactions.

# Extract the implementation of mintSparkCoins from walletmodel.cpp
ast-grep --lang cpp --pattern $'WalletModel::SendCoinsReturn WalletModel::mintSparkCoins($_, $_, $_) {
  $$$
}' 

Length of output: 112



Script:

#!/bin/bash
# Description: Retrieve the implementation of the mintSparkCoins method in walletmodel.cpp to verify proper handling of Spark transactions.

# Extract the implementation of mintSparkCoins from walletmodel.cpp using ripgrep to locate the function definition.
rg --type cpp --context 20 'WalletModel::SendCoinsReturn WalletModel::mintSparkCoins'

Length of output: 2834


491-491: Check the total amount calculation logic for various transaction scenarios.

Verification successful

The getTotalTransactionAmount method in walletmodeltransaction.cpp sums up the amounts from the recipients list. This logic appears straightforward and correct for calculating the total transaction amount.

The usage of this method in sendcoinsdialog.cpp and lelantusdialog.cpp also seems consistent with its purpose.

  • sendcoinsdialog.cpp:

    • mintSparkAmount += transaction.getTotalTransactionAmount();
    • totalAmount = currentTransaction.getTotalTransactionAmount() + txFee;
  • lelantusdialog.cpp:

    • allAmount += wtx.getTotalTransactionAmount();

These usages indicate that the total transaction amount is being correctly calculated and used in different contexts.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the total amount is calculated correctly for different transaction scenarios, especially when `fAnonymousMode` is toggled.

# Test: Search for the method usage. Expect: Correct total amount calculations.
rg --type cpp $'getTotalTransactionAmount'

Length of output: 492



Script:

#!/bin/bash
# Retrieve the implementation of getTotalTransactionAmount in walletmodeltransaction.cpp
ast-grep --lang cpp --pattern $'CAmount WalletModelTransaction::getTotalTransactionAmount() {
  $$$
}' --json

# Retrieve the usage of getTotalTransactionAmount in sendcoinsdialog.cpp
rg --type cpp 'getTotalTransactionAmount' src/qt/sendcoinsdialog.cpp

# Retrieve the usage of getTotalTransactionAmount in lelantusdialog.cpp
rg --type cpp 'getTotalTransactionAmount' src/qt/lelantusdialog.cpp

Length of output: 454



Script:

#!/bin/bash
# Retrieve the implementation of getTotalTransactionAmount in walletmodeltransaction.cpp
rg --type cpp 'CAmount WalletModelTransaction::getTotalTransactionAmount' src/qt/walletmodeltransaction.cpp

Length of output: 169



Script:

#!/bin/bash
# Retrieve the full implementation of getTotalTransactionAmount in walletmodeltransaction.cpp
rg --type cpp -A 10 -B 10 'CAmount WalletModelTransaction::getTotalTransactionAmount' src/qt/walletmodeltransaction.cpp

Length of output: 588


465-465: Validate the calculation of transaction fees and sizes for Spark transactions.


335-335: Ensure correct handling of Spark transactions when fAnonymousMode is false.

Verification successful

Ensure correct handling of Spark transactions when fAnonymousMode is false.

The prepareMintSparkTransaction method in src/qt/walletmodel.cpp correctly handles Spark transactions, including checks for valid addresses, amounts, and balance. The method prepares the transaction data and ensures that the transaction is created successfully, emitting error messages if any issues arise.

  • src/qt/walletmodel.cpp: Implementation of prepareMintSparkTransaction method.
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the `prepareMintSparkTransaction` method correctly handles transactions when `fAnonymousMode` is false and `sparkAddressCount` is greater than 0.

# Test: Search for the method usage. Expect: Proper handling of transactions.
rg --type cpp $'prepareMintSparkTransaction'

Length of output: 571



Script:

#!/bin/bash
# Extract the implementation of the `prepareMintSparkTransaction` method from `src/qt/walletmodel.cpp`.
ast-grep --lang cpp --pattern $'SendCoinsReturn WalletModel::prepareMintSparkTransaction($_, $_, $_, $_, $_) {
  $$$
}' src/qt/walletmodel.cpp

Length of output: 143



Script:

#!/bin/bash
# Extract the implementation of the `prepareMintSparkTransaction` method from `src/qt/walletmodel.cpp` with a more flexible pattern.
ast-grep --lang cpp --pattern $'SendCoinsReturn WalletModel::prepareMintSparkTransaction($_, $_, $_, $_, $_) {
  $$$
}' src/qt/walletmodel.cpp

Length of output: 143



Script:

#!/bin/bash
# Search for the definition of `prepareMintSparkTransaction` in `src/qt/walletmodel.cpp` and extract the surrounding lines to get the full implementation.
rg --context 20 'SendCoinsReturn WalletModel::prepareMintSparkTransaction' src/qt/walletmodel.cpp

Length of output: 1482



Script:

#!/bin/bash
# Search for the definition of `prepareMintSparkTransaction` in `src/qt/walletmodel.cpp` and extract more surrounding lines to get the full implementation.
rg --context 50 'SendCoinsReturn WalletModel::prepareMintSparkTransaction' src/qt/walletmodel.cpp

Length of output: 3279



Script:

#!/bin/bash
# Search for the definition of `prepareMintSparkTransaction` in `src/qt/walletmodel.cpp` and extract even more surrounding lines to get the full implementation.
rg --context 100 'SendCoinsReturn WalletModel::prepareMintSparkTransaction' src/qt/walletmodel.cpp

Length of output: 7304

src/wallet/wallet.h (2)

1041-1041: Ensure the new method signature is consistent with its implementation and usage across the project.

Verification successful

The method signature for CreateSparkMintTransactions is consistent across the project. The header file, source file implementations, and usages all align with the new signature.

  • Header File: src/wallet/wallet.h
  • Source File Implementations: src/wallet/wallet.cpp, src/spark/sparkwallet.cpp
  • Usages: src/wallet/wallet.cpp, src/qt/walletmodel.cpp
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify that the new method signature for `CreateSparkMintTransactions` is used consistently across the project.

# Test: Search for the method usage. Expect: Only occurrences of the new signature.
ast-grep --lang cpp --pattern $'class CWallet {
  $$$
  CreateSparkMintTransactions($_, $_, $_, $_, $_, $_, $_, $_, $_, $_) {
    $$$
  }
  $$$  
}'

Length of output: 494



Script:

#!/bin/bash
# Description: Verify the method signature for `CreateSparkMintTransactions` in the header file and its implementation and usage across the project.

# Step 1: Search for the method signature in the header file.
echo "Searching for method signature in header files..."
ast-grep --lang cpp --pattern 'CreateSparkMintTransactions(const std::vector<CRecipient>&, $_, $_, $_, $_, $_, $_, $_, $_)' > header_signature.txt

# Step 2: Search for the method implementation in the source files.
echo "Searching for method implementation in source files..."
ast-grep --lang cpp --pattern 'CreateSparkMintTransactions(const std::vector<CRecipient>&, $_, $_, $_, $_, $_, $_, $_, $_) {' > source_implementation.txt

# Step 3: Search for the method usage across the project.
echo "Searching for method usage across the project..."
rg 'CreateSparkMintTransactions\(' > method_usage.txt

# Combine results for review.
echo "Combining results..."
cat header_signature.txt source_implementation.txt method_usage.txt

Length of output: 1634


1092-1092: Ensure the new method signature is consistent with its implementation and usage across the project.

src/spark/sparkwallet.cpp (2)

753-753: Ensure proper error handling for CreateSparkMintTransactions.


1267-1270: Verify logic for handling remaining transaction value.

src/wallet/rpcwallet.cpp (2)

3642-3658: Ensure the help text and examples are clear and accurate.

Verification successful

The help text and examples for the mintspark command in src/wallet/rpcwallet.cpp appear to be accurate and consistent with the function's implementation. The function definition and the help text both describe the command's usage, parameters, and expected results clearly.

  • The help text specifies the format for the mintspark command, including the address, amount, memo, and subtractfee parameters.
  • The examples provided in the help text demonstrate typical use cases for the mintspark command, including sending amounts to transparent and private addresses.

Based on the extracted implementation and the provided help text, no discrepancies were found.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the accuracy of the help text and examples for the `mintspark` command.

# Test: Search for the `mintspark` command usage in the documentation and compare with the help text.
rg --type markdown $'mintspark'

Length of output: 30



Script:

#!/bin/bash
# Description: Locate the implementation of the `mintspark` command in the codebase and review its parameters and usage.

# Search for the `mintspark` command implementation in the codebase.
ast-grep --lang cpp --pattern $'void mintspark($_) {
  $$$
}'

Length of output: 62



Script:

#!/bin/bash
# Description: Search for the `mintspark` keyword in the codebase to locate its definition and usage.

# Search for the `mintspark` keyword in the codebase.
rg 'mintspark'

Length of output: 4136



Script:

#!/bin/bash
# Description: Extract the implementation of the `mintspark` function from `src/wallet/rpcwallet.cpp`.

# Extract the implementation of the `mintspark` function.
ast-grep --lang cpp --pattern $'UniValue mintspark(const JSONRPCRequest& request) {
  $$$
}' src/wallet/rpcwallet.cpp

Length of output: 118



Script:

#!/bin/bash
# Description: Search for the `mintspark` function definition in `src/wallet/rpcwallet.cpp`.

# Search for the `mintspark` function definition.
rg 'UniValue mintspark' src/wallet/rpcwallet.cpp

Length of output: 100



Script:

#!/bin/bash
# Description: Extract the full implementation of the `mintspark` function from `src/wallet/rpcwallet.cpp`.

# Extract the full implementation of the `mintspark` function.
rg -A 50 'UniValue mintspark' src/wallet/rpcwallet.cpp

Length of output: 4071


3675-3755: Review the logic for handling Spark and Bitcoin addresses, validating parameters, and preparing data for transaction creation.

Verification successful

The verification process has confirmed the presence and implementation of the functions and classes involved in the logic for handling Spark and Bitcoin addresses, validating parameters, and preparing data for transaction creation. The following points summarize the findings:

  • The decode method for Spark addresses is implemented in src/libspark/keys.cpp.
  • The CBitcoinAddress class and its IsValid method are implemented in src/base58.cpp.
  • The AmountFromValue function is implemented in src/rpc/server.cpp.
  • The MintAndStoreSpark method is implemented in src/wallet/wallet.cpp.

These implementations confirm that the logic in the provided code snippet is supported by the necessary functions and classes.

Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Verify the logic for handling Spark and Bitcoin addresses, validating parameters, and preparing data for transaction creation.

# Test: Search for similar logic in other parts of the codebase and compare for consistency.
rg --type cpp $'address handling'

Length of output: 34



Script:

#!/bin/bash
# Description: Gather information about the implementation of sAddress.decode, CBitcoinAddress, AmountFromValue, and MintAndStoreSpark.

# Find the implementation of sAddress.decode
ast-grep --lang cpp --pattern $'class Address {
  $$$
  decode($_) {
    $$$
  }
  $$$
}'

# Find the implementation of CBitcoinAddress
ast-grep --lang cpp --pattern $'class CBitcoinAddress {
  $$$
  IsValid() {
    $$$
  }
  $$$
}'

# Find the implementation of AmountFromValue
ast-grep --lang cpp --pattern $'AmountFromValue($_) {
  $$$
}'

# Find the implementation of MintAndStoreSpark
ast-grep --lang cpp --pattern $'class CWallet {
  $$$
  MintAndStoreSpark($_, $_, $_, $_) {
    $$$
  }
  $$$
}'

Length of output: 1401



Script:

#!/bin/bash
# Description: Gather information about the implementation of sAddress.decode, CBitcoinAddress, AmountFromValue, and MintAndStoreSpark with refined patterns.

# Find the implementation of sAddress.decode
ast-grep --lang cpp --pattern $'class $_ {
  $$$
  unsigned char decode($_) {
    $$$
  }
  $$$
}'

# Find the implementation of CBitcoinAddress
ast-grep --lang cpp --pattern $'class CBitcoinAddress {
  $$$
  bool IsValid() const {
    $$$
  }
  $$$
}'

# Find the implementation of AmountFromValue
ast-grep --lang cpp --pattern $'CAmount AmountFromValue(const UniValue& value) {
  $$$
}'

# Find the implementation of MintAndStoreSpark
ast-grep --lang cpp --pattern $'class CWallet {
  $$$
  std::string MintAndStoreSpark(const std::vector<CRecipient>& recipients, const std::vector<spark::MintedCoinData>& outputs, std::vector<std::pair<CWalletTx, CAmount>>& wtxAndFee, bool subtractFeeFromAmount) {
    $$$
  }
  $$$
}'

Length of output: 1621



Script:

#!/bin/bash
# Description: Gather information about the implementation of sAddress.decode, CBitcoinAddress, AmountFromValue, and MintAndStoreSpark using rg.

# Search for the implementation of sAddress.decode
rg 'decode' --type cpp

# Search for the implementation of CBitcoinAddress
rg 'CBitcoinAddress' --type cpp

# Search for the implementation of AmountFromValue
rg 'AmountFromValue' --type cpp

# Search for the implementation of MintAndStoreSpark
rg 'MintAndStoreSpark' --type cpp

Length of output: 62035

src/wallet/wallet.cpp (6)

Line range hint 1-1: LGTM! Simple and straightforward addition operation.


5612-5612: LGTM! Updated function signature aligns with the PR's objectives.


5646-5646: LGTM! Proper use of the updated CreateSparkMintTransactions function.


8176-8176: LGTM! Consistent update to function signature.


8187-8187: LGTM! Correct usage of the updated CreateSparkMintTransactions.


5927-5927: Verify the intention behind using empty vectors in MintAndStoreSpark.

Verification successful

Verify the context and intention behind using empty vectors in MintAndStoreSpark by examining the function definition and relevant test cases.


Correct the regex pattern in the rg command and re-run the ast-grep command to gather the necessary information.


The use of empty vectors {} in MintAndStoreSpark is intentional and validated through test cases. The tests check for expected outcomes, indicating that this usage is correct and purposeful.

  • [src/wallet/test/spark_tests.cpp]
Scripts executed

The following scripts were executed for the analysis:


Script:

#!/bin/bash
# Description: Check for other occurrences of MintAndStoreSpark to ensure consistency.

# Test: Search for other uses of MintAndStoreSpark. Expect: Consistent usage or clear documentation when empty vectors are passed.
rg --type cpp $'MintAndStoreSpark'

Length of output: 2187



Script:

#!/bin/bash
# Description: Retrieve the definition of MintAndStoreSpark and relevant test cases to understand the usage of empty vectors.

# Retrieve the function definition from wallet.cpp
ast-grep --lang cpp --pattern $'std::string CWallet::MintAndStoreSpark($_, $_, $_, $_, $_, $_, $_) {
  $$$
}' src/wallet/wallet.cpp

# Retrieve the relevant test cases from spark_tests.cpp
rg --type cpp --context 10 $'MintAndStoreSpark({}, {}, wtxAndFee, false, true)' src/wallet/test/spark_tests.cpp

Length of output: 388



Script:

#!/bin/bash
# Description: Retrieve the definition of MintAndStoreSpark and relevant test cases to understand the usage of empty vectors.

# Retrieve the function definition from wallet.cpp
ast-grep --lang cpp --pattern $'std::string CWallet::MintAndStoreSpark($_, $_, $_, $_, $_, $_, $_) {
  $$$
}' src/wallet/wallet.cpp

# Retrieve the relevant test cases from spark_tests.cpp with corrected regex pattern
rg --type cpp --context 10 'MintAndStoreSpark\(\{\}, \{\}, wtxAndFee, false, true\)' src/wallet/test/spark_tests.cpp

Length of output: 1581

Comment on lines +606 to +608
std::vector<CRecipient> vecSend;
std::vector<spark::MintedCoinData> mints{{address, 50*COIN, ""}};
std::string error = pwalletMain->MintAndStoreSpark(mints, wtxAndFee, false);
std::string error = pwalletMain->MintAndStoreSpark(vecSend, mints, wtxAndFee, false);
Copy link

Choose a reason for hiding this comment

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

Consider adding error handling for MintAndStoreSpark.

The function MintAndStoreSpark is called without handling potential errors. It's good practice to handle or assert expected outcomes to ensure robustness, especially in test environments. Consider adding error handling or assertions to check the return value.

Comment on lines +765 to +774
CAmount nValue = 0;
for (const auto& recipient : vecSend)
{
if (nValue < 0 || recipient.nAmount < 0)
{
strFailReason = _("Transaction amounts must not be negative");
return false;
}
nValue += recipient.nAmount;
}
Copy link

Choose a reason for hiding this comment

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

Check for negative transaction amounts.

The check for negative transaction amounts is crucial to prevent erroneous or malicious inputs. Ensure that this validation is robust and consider adding more detailed error messages or handling specific edge cases.

@@ -774,11 +784,14 @@
assert(txNew.nLockTime <= (unsigned int) chainActive.Height());
assert(txNew.nLockTime < LOCKTIME_THRESHOLD);
std::vector<spark::MintedCoinData> outputs_ = outputs;
std::vector<CRecipient> sendOutputs = vecSend;
Copy link

Choose a reason for hiding this comment

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

Refactor to improve clarity and maintainability.

Consider renaming valueToSendInTx to valueToProcessInTx to better reflect its usage in the context of both sending and processing transactions.

Also applies to: 825-825

Comment on lines +837 to +846
sendValue = valueToSendInTx;
if (subtractFeeFromAmount)
nValueToSelect = mintedValue;
nValueToSelect = sendValue;
else
nValueToSelect = mintedValue + nFeeRet;
nValueToSelect = sendValue + nFeeRet;

// if no enough coins in this group then subtract fee from mint
if (nValueToSelect > itr->first && !subtractFeeFromAmount) {
nValueToSelect = mintedValue;
mintedValue -= nFeeRet;
nValueToSelect = sendValue;
sendValue -= nFeeRet;
Copy link

Choose a reason for hiding this comment

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

Optimize fee calculation logic.

The fee calculation logic is repeated multiple times. Consider extracting this into a separate method to reduce redundancy and improve code maintainability.

}

if (!MoneyRange(mintedValue) || mintedValue == 0) {
if (!MoneyRange(sendValue) || sendValue == 0) {
Copy link

Choose a reason for hiding this comment

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

Handle potential division by zero in fee distribution.

There is a potential risk of division by zero when calculating singleFee. Ensure that totalOutputs is never zero before performing the division.

Comment on lines +911 to +939
size_t totalOutputs = singleTxOutputs.size() + singleTxSendOutputs.size();
CAmount singleFee = nFeeRet / totalOutputs;
CAmount remainder = nFeeRet % totalOutputs;

for (size_t i = 0; i < singleTxOutputs.size(); ++i) {
if (singleTxOutputs[i].v <= singleFee) {
remainder += singleTxOutputs[i].v - singleFee;
singleTxOutputs.erase(singleTxOutputs.begin() + i);
reminder += singleTxOutputs[i].v - singleFee;
--i;
} else {
singleTxOutputs[i].v -= singleFee;
if (remainder > 0 && singleTxOutputs[i].v > remainder) {
singleTxOutputs[i].v -= remainder;
remainder = 0;
}
}
singleTxOutputs[i].v -= singleFee;
if (reminder > 0 && singleTxOutputs[i].v > nFeeRet % singleTxOutputs.size()) {// first receiver pays the remainder not divisible by output count
singleTxOutputs[i].v -= reminder;
reminder = 0;
}

for (size_t i = 0; i < singleTxSendOutputs.size(); ++i) {
if (singleTxSendOutputs[i].nAmount <= singleFee) {
remainder += singleTxSendOutputs[i].nAmount - singleFee;
singleTxSendOutputs.erase(singleTxSendOutputs.begin() + i);
--i;
} else {
singleTxSendOutputs[i].nAmount -= singleFee;
if (remainder > 0 && singleTxSendOutputs[i].nAmount > remainder) {
singleTxSendOutputs[i].nAmount -= remainder;
remainder = 0;
}
Copy link

Choose a reason for hiding this comment

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

Refine fee subtraction logic for clarity.

The logic for subtracting fees from transaction outputs is complex and could be simplified. Consider breaking down the operations into smaller, more manageable functions or adding more comments to clarify the steps involved.

src/spark/sparkwallet.cpp Show resolved Hide resolved
src/wallet/wallet.cpp Show resolved Hide resolved
src/wallet/rpcwallet.cpp Show resolved Hide resolved
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: 2

🧹 Nitpick comments (12)
src/spark/sparkwallet.cpp (9)

758-758: Consider clarifying function purpose via docstring.
The method CSparkWallet::CreateSparkMintTransactions(...) has a complex signature. Adding a concise docstring or comment at the declaration could improve maintainability by clarifying the method’s usage and parameters.


770-779: Question the necessity of repeatedly checking nValue < 0.
Since nValue is initialized to zero and only accumulates recipient.nAmount, checking nValue < 0 might be redundant. Consider either removing the check or clarifying potential overflow scenarios.


792-792: Ensure clarity for reassigning recipients.
This line duplicates the recipient list in sendOutputs. If it’s meant to be modified separately from vecSend, consider adding a comment explaining this rationale to avoid confusion.


830-830: Improve naming for clarity.
valueToSendInTx might be more intuitively named (e.g., groupValue or maxGroupAllocation) to reflect its meaning clearly.


836-836: Enhance variable naming.
The purpose of nValueToSelect vs. sendValue could be more explicit. Consider naming them to reflect their roles in fee logic (e.g., requiredSelection, adjustedSend).


854-854: Expand error conditions for zero vs. out-of-range.
Treating zero and out-of-range amounts similarly might obscure the root cause. Consider separate error handling or at least clarifying logs for zero-value scenario.


866-866: Reduce potential confusion in output vectors.
Multiple vectors for “remaining” vs. “singleTx” recipients can be confusing. Ensure thorough inline comments or rename them to reflect distinct usage. Also confirm no negative amounts for mintedCoinData.v.

Also applies to: 869-869, 872-872


963-983: Examine dust threshold handling.
While checking txout.IsDust(...), ensure that the associated error messages or logs properly reflect the cause. This is important for diagnosing user-facing issues with small amounts.


1184-1184: Clarify reassigning outputs_.
Assigning outputs_ = remainingOutputs might alter the global state in unexpected ways. Consider safer naming or clarifying comments to indicate leftover or partial usage.

src/wallet/wallet.cpp (3)

Line range hint 8224-8235: Consider adding parameter validation

While the implementation looks correct, consider adding validation for the input parameters before delegating to sparkWallet to fail fast on invalid inputs.

if (vecSend.empty() && outputs.empty()) {
    strFailReason = _("No recipients specified");
    return false;
}

Line range hint 8246-8249: Consider adding address validation

While IsSparkAddressMine() works correctly, consider adding basic address format validation before delegating to sparkWallet.

if (!validateSparkAddress(address)) {
    return false;
}

Line range hint 8250-8284: Consider consolidating duplicate notification code

The address book management functions have some code duplication in the notification handling. Consider extracting common notification logic into a helper function.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 0af162e and 265c526.

📒 Files selected for processing (6)
  • src/qt/sendcoinsdialog.cpp (4 hunks)
  • src/qt/walletmodel.cpp (3 hunks)
  • src/spark/sparkwallet.cpp (9 hunks)
  • src/wallet/rpcwallet.cpp (3 hunks)
  • src/wallet/wallet.cpp (6 hunks)
  • src/wallet/wallet.h (2 hunks)
🧰 Additional context used
🪛 cppcheck (2.10-2)
src/spark/sparkwallet.cpp

[error] 904-904: Uninitialized variable

(uninitvar)


[error] 904-904: Uninitialized struct member

(uninitStructMember)

⏰ Context from checks skipped due to timeout of 90000ms (4)
  • GitHub Check: Build for Windows
  • GitHub Check: Build for macOS
  • GitHub Check: Build for Linux
  • GitHub Check: Create Source Distribution
🔇 Additional comments (21)
src/spark/sparkwallet.cpp (7)

798-799: Validate totalValue edge cases.
valueToMint + nValue could theoretically approach or exceed integer limits given extreme inputs. Consider adding overflow checks or explicit validation on high amounts.


833-833: Check partial usage logic.
Capping valueToSendInTx at totalValue is correct for partial usage, but ensure leftover UTXO usage is handled correctly. A quick comment clarifying the reason helps future maintainers.


842-842: Check the fee-splitting path.
When subtractFeeFromAmount is false, the code sets nValueToSelect to sendValue + nFeeRet, which might leave limited leftover for other operations. Validate no corner cases slip through.

Also applies to: 844-844, 846-846


850-851: Ensure no negative final amounts.
Subtracting nFeeRet from sendValue might slip below zero if fees exceed available amounts. Consider an explicit check to avoid unintentional negative results.


877-881: Validate 64-bit usage.
uint64_t remainingMintValue is assigned from sendValue (a CAmount). If sendValue can be negative, this may cause unexpected wrap. Confirm negative amounts are rejected earlier.


898-905: Double-check loop termination conditions.
Inside the while loop for remainingSendOutputs, watch out for partial usage of outputs or early breaks. Also confirm that the condition remainingMintValue > 0 accurately prevents infinite loops.

Also applies to: 906-912

🧰 Tools
🪛 cppcheck (2.10-2)

[error] 904-904: Uninitialized variable

(uninitvar)


[error] 904-904: Uninitialized struct member

(uninitStructMember)


1273-1274: Confirm partial transaction termination.
Subtracting sendValue from totalValue and exiting if zero is correct. However, ensure the code handles partial leftover scenarios without leaving unspent in an inconsistent state.

src/wallet/rpcwallet.cpp (1)

Line range hint 3658-3807: Review mintspark logic.

  1. Validation: Verify no negative or zero amounts pass through silently; extra checks could protect from inadvertent user errors.
  2. Address type checks: The code differentiates Spark addresses from transparent ones by decoding. Confirm robust handling of invalid addresses or cross-network usage.
  3. Dust Handling: Ensure consistent dust threshold checks for newly created UTXOs.
  4. Transaction Output Management: The final loop can produce multiple transaction outputs if certain conditions are met; consider logging or summarizing them clearly if multiple TXs result.
  5. Concurrency: Since this function modifies the wallet, confirm it holds necessary locks and is safe from concurrent modifications.
    [refactor_suggestion_good_to_have, verify]
src/wallet/wallet.h (2)

Line range hint 1043-1050: LGTM! Method signature updated to support multi-send functionality.

The CreateSparkMintTransactions method signature has been updated to include const std::vector<CRecipient>& vecSend parameter, which enables handling multiple recipients in a single mint transaction.


Line range hint 1094-1101: LGTM! Method signature updated to support multi-send functionality.

The MintAndStoreSpark method signature has been updated to include const std::vector<CRecipient>& vecSend parameter, which enables handling multiple recipients in a single mint transaction.

src/qt/walletmodel.cpp (2)

Line range hint 1364-1396: LGTM! Enhanced address validation and processing for multi-send support.

The code now properly handles both standard and Spark addresses:

  1. Standard addresses are added to vecSend with proper script generation
  2. Spark addresses are added to outputs with proper address decoding
  3. Input validation is comprehensive for both address types

1417-1418: Verify the transaction creation call.

The call to CreateSparkMintTransactions now includes both vecSend and outputs vectors to support multi-send functionality. Ensure that the transaction fee calculation and change handling work correctly with multiple recipients.

Run this script to verify the transaction creation:

✅ Verification successful

Transaction creation call verified successfully

The CreateSparkMintTransactions implementation correctly handles multiple recipients and outputs, with proper fee calculation and change management across all call sites. The extensive test coverage confirms the multi-send functionality works as intended.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check if CreateSparkMintTransactions is called with correct parameters
# and verify fee calculation with multiple recipients

ast-grep --pattern $'CreateSparkMintTransactions\($$$, vecSend, outputs, $$$\)'

Length of output: 246


Script:

#!/bin/bash
# Search for CreateSparkMintTransactions occurrences
rg "CreateSparkMintTransactions" -A 5

# Find relevant implementation files
fd -t f ".*wallet.*\.(cpp|h)" -X rg "CreateSparkMintTransactions"

# Look for test files
fd -t f ".*test.*\.(cpp|h)" -X rg "Spark.*Mint"

Length of output: 7068

src/qt/sendcoinsdialog.cpp (4)

Line range hint 390-397: LGTM! Updated transaction preparation logic for Spark addresses.

The condition for preparing mint Spark transaction has been updated to handle cases where some recipients are Spark addresses. The code now properly checks if Spark is allowed before proceeding.


Line range hint 549-558: LGTM! Enhanced fee calculation for multi-send transactions.

The code now properly accumulates transaction fees and sizes for multiple transactions when sending to Spark addresses. This ensures accurate fee calculation in multi-send scenarios.


Line range hint 584-593: LGTM! Updated total amount calculation for multi-send transactions.

The code now correctly calculates the total amount based on the transaction type:

  1. For mint Spark transactions: total = mintSparkAmount + txFee
  2. For spend Spark transactions: total = amount + fee (with fee subtraction handling)

Line range hint 626-630: LGTM! Updated send coins logic for multi-send transactions.

The code now properly handles different transaction types and ensures correct processing of multi-send transactions with Spark addresses.

src/wallet/wallet.cpp (5)

Line range hint 5660-5684: LGTM: Parameter changes for multi-send support look good

The changes to CreateSparkMintTransactions parameters properly support the multi-send functionality by adding vecSend and outputs parameters, along with subtractFeeFromAmount flag. The implementation correctly checks for subtractFeeFromAmount in the recipients.


Line range hint 8235-8245: LGTM: Proper null checks and balance handling

The GetSparkBalance implementation correctly handles the sparkWallet null case and properly separates confirmed/unconfirmed balances.


Line range hint 8285-8397: LGTM: Proper locking and validation in DelAddressBook

The DelAddressBook implementation correctly handles locking and validation for different address types. The error handling and notifications are properly implemented.


Line range hint 8398-8421: LGTM: Clean implementation of validation functions

The address validation functions are well implemented with proper error handling and clear separation between standard and Spark addresses.


Line range hint 8422-8476: LGTM: RAP address book management properly implemented

The RAP address book management functions follow the same pattern as other address book functions with proper locking and notifications.

Comment on lines +916 to +930
size_t totalOutputs = singleTxOutputs.size() + singleTxSendOutputs.size();
CAmount singleFee = nFeeRet / totalOutputs;
CAmount remainder = nFeeRet % totalOutputs;

for (size_t i = 0; i < singleTxOutputs.size(); ++i) {
if (singleTxOutputs[i].v <= singleFee) {
remainder += singleTxOutputs[i].v - singleFee;
singleTxOutputs.erase(singleTxOutputs.begin() + i);
reminder += singleTxOutputs[i].v - singleFee;
--i;
} else {
singleTxOutputs[i].v -= singleFee;
if (remainder > 0 && singleTxOutputs[i].v > remainder) {
singleTxOutputs[i].v -= remainder;
remainder = 0;
}
Copy link

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Review fee distribution logic.
Splitting nFeeRet across minted outputs and send outputs uses integer division. Double-check rounding behavior for small outputs and dust. Make sure the leftover remainder is handled consistently so no output is penalized more than intended.

Also applies to: 932-944

}
}
}
}

if (!autoMintAll && valueToMint > 0) {
if (!autoMintAll && totalValue > 0) {
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Handle leftover amounts properly.
Failing if totalValue > 0 can surprise the user if partial transactions were created. Consider returning partial success or a more explicit error message to clarify incomplete minted amounts.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant