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.

Sign up for GitHub

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

Jump to bottom

[TRA-112] Add util to convert between parent and child subaccount numbers #1171

Merged
merged 5 commits into from
Mar 14, 2024
Merged

[TRA-112] Add util to convert between parent and child subaccount numbers #1171

merged 5 commits into from
Mar 14, 2024

Conversation

shrenujb
Copy link
Contributor

Changelist

Add utils to provide conversions between parent (user-level) subaccount numbers and child (protocol-level) subaccount numbers

Test Plan

Unit 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.

@shrenujb
Add util to convert between parent and child subaccount numbers
7953365 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
@linear Linear
Copy link

linear bot commented Mar 13, 2024

TRA-112 Add utility to provide conversions between parentSubaccount and childSubaccount numbers

@coderabbitai coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 13, 2024 •
edited
Loading

Walkthrough

The recent updates involve enhancing the api-translations module in the Postgres package to manage parent and child subaccount relationships. New functions getChildSubaccountNums and getParentSubaccountNum have been added to facilitate retrieving child subaccount numbers for a given parent and vice versa. Additionally, two constants, MAX_PARENT_SUBACCOUNTS and CHILD_SUBACCOUNT_MULTIPLIER, have been introduced to support these functionalities. Tests have been included to ensure the reliability and correctness of these new functions.

Changes

File Path Changes
.../postgres/__tests__/lib/api-translations.test.ts
.../postgres/src/lib/api-translations.ts		 Added getChildSubaccountNums and getParentSubaccountNum functions.
.../postgres/src/constants.ts Introduced MAX_PARENT_SUBACCOUNTS and CHILD_SUBACCOUNT_MULTIPLIER constants.

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-tests 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 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 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[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 2

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 3c05233 and 7953365.
Files selected for processing (3)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts (2 hunks)
  • indexer/packages/postgres/src/constants.ts (1 hunks)
  • indexer/packages/postgres/src/lib/api-translations.ts (2 hunks)
Additional comments: 5
indexer/packages/postgres/__tests__/lib/api-translations.test.ts (4)
  • 40-47: The tests for getChildSubaccountNums correctly verify the functionality under normal conditions. However, given the logical error in the getChildSubaccountNums function implementation, these tests might pass incorrectly. Ensure the function implementation is corrected as suggested.
  • 50-53: The test for error handling in getChildSubaccountNums when the parent subaccount number exceeds the maximum is well-implemented. However, ensure the error message aligns with the corrected logic in the function implementation.
  • 56-61: The tests for getParentSubaccountNum correctly verify the functionality under normal conditions. However, given the logical error in the getParentSubaccountNum function implementation, these tests might pass incorrectly. Ensure the function implementation is corrected as suggested.
  • 64-67: The test for error handling in getParentSubaccountNum when the child subaccount number exceeds the maximum is well-implemented. However, ensure the error message aligns with the corrected logic in the function implementation.
indexer/packages/postgres/src/constants.ts (1)
  • 125-127: The constants MAX_PARENT_SUBACCOUNTS and CHILD_SUBACCOUNT_MULTIPLIER are correctly defined and align with the requirements for subaccount number conversions. Ensure their values are consistent with the system's design and limitations.

indexer/packages/postgres/src/lib/api-translations.ts Show resolved Hide resolved
indexer/packages/postgres/src/lib/api-translations.ts Outdated Show resolved Hide resolved
@shrenujb
fix lint
099636b 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 7953365 and 099636b.
Files selected for processing (1)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts

@shrenujb
fix small bug
0884df3 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 099636b and 0884df3.
Files selected for processing (1)
  • indexer/packages/postgres/src/lib/api-translations.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • indexer/packages/postgres/src/lib/api-translations.ts

@shrenujb
address comments
09ef07c 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0884df3 and 09ef07c.
Files selected for processing (2)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts (2 hunks)
  • indexer/packages/postgres/src/lib/api-translations.ts (2 hunks)
Files skipped from review as they are similar to previous changes (2)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts
  • indexer/packages/postgres/src/lib/api-translations.ts

@shrenujb
fix test bug
79bdc3e 
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
coderabbitai[bot]
coderabbitai bot reviewed Mar 13, 2024
View reviewed changes
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.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 09ef07c and 79bdc3e.
Files selected for processing (1)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • indexer/packages/postgres/tests/lib/api-translations.test.ts

@shrenujb shrenujb merged commit 7b100ac into main Mar 14, 2024
11 checks passed
@shrenujb shrenujb deleted the tra112 branch March 14, 2024 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@coderabbitai coderabbitai coderabbitai left review comments

@vincentwschau vincentwschau vincentwschau approved these changes

Assignees
No one assigned
Labels
indexer
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@shrenujb @vincentwschau