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

fix transfers parent SA API for external addresses in transfers #2630

Merged
merged 1 commit into from
Dec 7, 2024

Conversation

shrenujb
Copy link
Contributor

@shrenujb shrenujb commented Dec 6, 2024

Changelist

The transfers parent subaccount API was filtering out transfers from different addresses if the parent subaccount number was the same. This fixes it

Test Plan

Added tests

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced new constants for creating transfer objects with alternate addresses, enhancing transfer flexibility.
    • Improved transfer handling for parent subaccounts, including new test scenarios for alternate addresses and pagination.
  • Bug Fixes

    • Enhanced error handling for invalid addresses and subaccount numbers in transfer operations.
  • Improvements

    • Refined filtering logic for transfer requests to ensure accurate results based on sender and recipient addresses.

Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
@shrenujb shrenujb requested a review from a team as a code owner December 6, 2024 22:42
Copy link
Contributor

coderabbitai bot commented Dec 6, 2024

Walkthrough

The pull request introduces new constants and modifications to the transfer functionality within the codebase. Specifically, it adds constants for creating transfer objects with alternate addresses and updates the filtering logic for transfers in the TransfersController. The test suite for the transfers controller is also enhanced to cover new scenarios, including error handling and pagination. Additionally, changes are made to the request transformer to incorporate a new address parameter, refining the logic for determining transfer types.

Changes

File Path Change Summary
indexer/packages/postgres/__tests__/helpers/constants.ts Added constants: defaultTransferWithAlternateAddress and defaultTransferWithAlternateAddressId.
indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts Added variables: defaultSubaccount2Num0, expectedTransferWithAlternateAddressResponse; expanded test cases for transfers involving alternate addresses and pagination. Enhanced error handling.
indexer/services/comlink/src/controllers/api/v4/transfers-controller.ts Updated getTransfersForParentSubaccount method to refine filtering logic based on addresses and parent subaccount numbers.
indexer/services/comlink/src/request-helpers/request-transformer.ts Updated transferToParentSubaccountResponseObject function to include a new address parameter and adjust internal logic accordingly.

Possibly related PRs

Suggested labels

indexer

Suggested reviewers

  • tqin7
  • vincentwschau

🐇 In the land of code where transfers flow,
New constants sprout, helping transactions grow.
With alternate addresses, the paths now expand,
Tests are robust, like a rabbit's strong hand.
So hop along, let the transfers take flight,
In the world of code, everything feels right! 🌟


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

🧹 Outside diff range and nitpick comments (2)
indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts (1)

462-464: Simplify the creation of a single subaccount

Using Promise.all for a single promise is unnecessary. Consider removing Promise.all to streamline the code.

Apply this change:

-          await Promise.all([
-            SubaccountTable.create(defaultSubaccount2Num0),
-          ]);
+          await SubaccountTable.create(defaultSubaccount2Num0);
indexer/services/comlink/src/request-helpers/request-transformer.ts (1)

273-273: Remove unnecessary inline comment

The comment // if (recipientParentSubaccountNum === parentSubaccountNumber) is redundant and may cause confusion. Consider removing it for clarity.

Apply this change:

-      } else { // if (recipientParentSubaccountNum === parentSubaccountNumber) {
+      } else {
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between a957b13 and 1431ce3.

📒 Files selected for processing (4)
  • indexer/packages/postgres/__tests__/helpers/constants.ts (2 hunks)
  • indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts (4 hunks)
  • indexer/services/comlink/src/controllers/api/v4/transfers-controller.ts (1 hunks)
  • indexer/services/comlink/src/request-helpers/request-transformer.ts (3 hunks)
🔇 Additional comments (11)
indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts (4)

23-25: Updated imports are appropriate

The new constants defaultSubaccount2Num0 and defaultTendermintEventId4 are correctly imported to support the additional test cases.


470-470: Additional transfer included correctly for testing

The defaultTransferWithAlternateAddress is appropriately added to the test setup to validate transfers involving alternate addresses.


556-572: Expected response for alternate address transfer is correctly defined

The expectedTransferWithAlternateAddressResponse object accurately represents the expected transfer data for testing purposes.


588-590: New transfer assertion added to the test verification

Including expectedTransferWithAlternateAddressResponse in the assertions ensures that the test properly verifies transfers with alternate addresses.

indexer/services/comlink/src/controllers/api/v4/transfers-controller.ts (2)

221-221: Function call updated with additional parameters

Passing address and parentSubaccountNumber to transferToParentSubaccountResponseObject aligns with the updated function signature and logic.


229-230: Filter condition enhanced to exclude internal transfers

The updated filter correctly excludes transfers where both the sender and recipient have the same address and parent subaccount number, preventing internal transfers from being included.

indexer/services/comlink/src/request-helpers/request-transformer.ts (3)

246-246: Function signature updated appropriately

Adding address and parentSubaccountNumber as parameters to transferToParentSubaccountResponseObject accommodates the need for comparing addresses and parent subaccount numbers.


255-257: Correctly assign senderAddress with fallback

The assignment of senderAddress now properly defaults to the subaccount's address when senderWalletAddress is not provided.


267-267: Improved transfer type determination logic

The condition accurately identifies transfer types by comparing both senderAddress and senderParentSubaccountNum with the provided address and parentSubaccountNumber.

indexer/packages/postgres/__tests__/helpers/constants.ts (2)

648-653: New transfer constant defined correctly

The defaultTransferWithAlternateAddress constant is properly defined to test transfers involving alternate addresses.


663-671: Transfer ID generated correctly for alternate address transfer

The defaultTransferWithAlternateAddressId is correctly computed using the appropriate properties, ensuring the unique identification of the transfer.

@teddyding teddyding merged commit fc5ff36 into main Dec 7, 2024
16 checks passed
@teddyding teddyding deleted the sbansal/fix-transfers-api branch December 7, 2024 03:23
teddyding pushed a commit that referenced this pull request Dec 7, 2024
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
@teddyding
Copy link
Contributor

@Mergifyio backport release/indexer/v7.x

Copy link
Contributor

mergify bot commented Dec 8, 2024

backport release/indexer/v7.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Dec 8, 2024
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
(cherry picked from commit fc5ff36)
teddyding pushed a commit that referenced this pull request Dec 8, 2024
…port #2630) (#2631)

Co-authored-by: shrenujb <98204323+shrenujb@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants