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

add a fix for conflicting Stellar transactions #1943

Open
wants to merge 1 commit into
base: staging
Choose a base branch
from

Conversation

Meriem-BM
Copy link
Member

@Meriem-BM Meriem-BM commented Feb 21, 2025

This fix, will be eliminate the transaction conflict only for muxed Stallar addresses (doesn't have a memo)

Summary by CodeRabbit

  • Refactor
    • Enhanced the internal transaction validation process with more granular checks and detailed logging for improved clarity and debugging.

No user interface changes are expected with this update.

Copy link
Contributor

coderabbitai bot commented Feb 21, 2025

Walkthrough

The changes update the checkTransactions function in checkQRTransactionJob.ts. The transaction memo is now assigned to a variable and the logic is split into nested conditionals. When the transaction type is 'payment', the function first checks if toWalletMemo is defined; if so, it compares the memo with toWalletMemo and logs a debug message with an early return on mismatch. In the absence of toWalletMemo, it compares the memo against the string representation of id, similarly logging and returning on mismatch. No public entity declarations were modified.

Changes

File Change Summary
src/services/…/checkQRTransactionJob.ts Refactored the checkTransactions function by introducing a memo variable and nested conditionals to separately handle checks when toWalletMemo is present or absent, with added debug logging.

Sequence Diagram(s)

sequenceDiagram
    participant T as Transaction
    participant F as checkTransactions
    T->>F: Send transaction (type, memo, toWalletMemo, id)
    F->>F: Check if type is 'payment'
    alt toWalletMemo is defined
        F->>F: Compare memo vs. toWalletMemo
        alt Mismatch
            F->>F: Log debug message and return
        else
            F->>F: Continue processing transaction
        end
    else
        F->>F: Compare memo vs. id (as string)
        alt Mismatch
            F->>F: Log alternate debug message and return
        else
            F->>F: Continue processing transaction
        end
    end
Loading

Possibly related PRs

Suggested reviewers

  • mohammadranjbarz

Poem

In the code garden, I happily hop,
Tweaking conditions with each skip and stop.
A memo here, a log there so bright,
Debug messages shine like stars at night.
With every change, my code feels light,
Carrot crunching through bugs in pure 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
Contributor

@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: 4

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 415927f and 25da7d1.

📒 Files selected for processing (1)
  • src/services/cronJobs/checkQRTransactionJob.ts (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: test

Comment on lines +108 to +113
} else if (memo !== id.toString()) {
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
return;
}
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add type validation before toString comparison.

The memo comparison with id.toString() assumes the memo is a string or can be safely compared. Add type validation to ensure correct comparison.

-          } else if (memo !== id.toString()) {
+          } else if (typeof memo !== 'string' || memo !== id.toString()) {
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
} else if (memo !== id.toString()) {
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
return;
}
} else if (typeof memo !== 'string' || memo !== id.toString()) {
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
return;
}

Comment on lines +109 to +111
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Fix incorrect debug message.

The debug message indicates a match when the condition actually checks for a mismatch.

-              `Transaction memo matches donation memo for donation ID ${donation.id}`,
+              `Transaction memo does not match donation ID for donation ID ${donation.id}`,
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
logger.debug(
`Transaction memo does not match donation ID for donation ID ${donation.id}`,
);

Comment on lines +100 to 114
if (transaction.type === 'payment') {
if (toWalletMemo) {
if (memo !== toWalletMemo) {
logger.debug(
`Transaction memo does not match donation memo for donation ID ${donation.id}`,
);
return;
}
} else if (memo !== id.toString()) {
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
return;
}
}
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add memo validation for 'create_account' transactions.

The memo validation is only performed for 'payment' type transactions. To prevent transaction conflicts, add similar validation for 'create_account' type.

         if (transaction.type === 'payment') {
           if (toWalletMemo) {
             if (memo !== toWalletMemo) {
               logger.debug(
                 `Transaction memo does not match donation memo for donation ID ${donation.id}`,
               );
               return;
             }
           } else if (typeof memo !== 'string' || memo !== id.toString()) {
             logger.debug(
               `Transaction memo does not match donation ID for donation ID ${donation.id}`,
             );
             return;
           }
+        } else if (transaction.type === 'create_account') {
+          if (toWalletMemo) {
+            if (memo !== toWalletMemo) {
+              logger.debug(
+                `Transaction memo does not match donation memo for donation ID ${donation.id}`,
+              );
+              return;
+            }
+          } else if (typeof memo !== 'string' || memo !== id.toString()) {
+            logger.debug(
+              `Transaction memo does not match donation ID for donation ID ${donation.id}`,
+            );
+            return;
+          }
         }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if (transaction.type === 'payment') {
if (toWalletMemo) {
if (memo !== toWalletMemo) {
logger.debug(
`Transaction memo does not match donation memo for donation ID ${donation.id}`,
);
return;
}
} else if (memo !== id.toString()) {
logger.debug(
`Transaction memo matches donation memo for donation ID ${donation.id}`,
);
return;
}
}
if (transaction.type === 'payment') {
if (toWalletMemo) {
if (memo !== toWalletMemo) {
logger.debug(
`Transaction memo does not match donation memo for donation ID ${donation.id}`,
);
return;
}
} else if (typeof memo !== 'string' || memo !== id.toString()) {
logger.debug(
`Transaction memo does not match donation ID for donation ID ${donation.id}`,
);
return;
}
} else if (transaction.type === 'create_account') {
if (toWalletMemo) {
if (memo !== toWalletMemo) {
logger.debug(
`Transaction memo does not match donation memo for donation ID ${donation.id}`,
);
return;
}
} else if (typeof memo !== 'string' || memo !== id.toString()) {
logger.debug(
`Transaction memo does not match donation ID for donation ID ${donation.id}`,
);
return;
}
}

Comment on lines +98 to +99
const memo = transaction.transaction.memo;

Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Add null check for transaction memo.

The memo value should be validated before use to prevent potential runtime errors.

-        const memo = transaction.transaction.memo;
+        const memo = transaction.transaction?.memo;
+        if (memo === undefined || memo === null) {
+          logger.debug(
+            `Transaction memo is missing for donation ID ${donation.id}`,
+          );
+          return;
+        }
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
const memo = transaction.transaction.memo;
const memo = transaction.transaction?.memo;
if (memo === undefined || memo === null) {
logger.debug(
`Transaction memo is missing for donation ID ${donation.id}`,
);
return;
}

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