[IND-495]: Update wallets postgres table with totalTradingRewards field

[Christopher-Li]

Changelist

Update wallets postgres table with totalTradingRewards field

Test Plan

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

[linear]

IND-495 Update wallets postgres table with totalTradingRewards field

Updated the wallets table with the following:

{
	required: [
    'address',
  ],
  properties: {
		address: { type: 'string' },
    totalTradingRewards: { type: 'string' }, // New field to be added
	}
}

Note: The wallet’s table is currently only being written to by the transfers-handler as a reference for deposit and withdraws in the transfers table.

[coderabbitai]

Warning

Rate Limit Exceeded

@Christopher-Li has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 0 minutes and 51 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between d6fa5fd and 9d8fe04.

Walkthrough

A new totalTradingRewards field, a string representing a decimal value, has been added across various components of a system, likely related to a financial or trading platform. This field has been integrated into database migrations, model schemas, and test cases, indicating a system-wide update to include trading rewards data associated with wallet entities. The changes ensure that this new field is initialized, stored, and tested consistently throughout the system.

Changes

File(s)	Summary
.../constants.ts, .../transfer-table.test.ts, .../wallet-table.test.ts, .../transfers-controller.test.ts, .../transfer-handler.test.ts	Added totalTradingRewards property with a default value of '0' to wallet-related objects in test cases.
.../migration_files/20231128175805_add_wallets_total_trading_rewards.ts	Added a new column totalTradingRewards to the wallets table and updated the up and down migration functions to handle this change.
.../wallet-model.ts, .../db-model-types.ts, .../wallet-types.ts	Updated wallet model and related types to include the new totalTradingRewards property.
.../dydx_transfer_handler.sql	Initialized totalTradingRewards to '0' in SQL script for sender and recipient wallet records.

---

Tips

Chat with CodeRabbit Bot (@coderabbitai)

• If you reply to a review comment from CodeRabbit, the bot will automatically respond.
• To engage with CodeRabbit bot directly around the specific lines of code in the PR, mention @coderabbitai in your review comment
• Note: Review comments are made on code diffs or files, not on the PR overview.
• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

Note: For conversation with the bot, please use the review comments on code diffs or files.

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

[coderabbitai]

Review Status

Actionable comments generated: 4

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between d6fa5fd and 5cc6cbf.

Files selected for processing (10)

• indexer/packages/postgres/tests/helpers/constants.ts (1 hunks)
• indexer/packages/postgres/tests/stores/transfer-table.test.ts (2 hunks)
• indexer/packages/postgres/tests/stores/wallet-table.test.ts (1 hunks)
• indexer/packages/postgres/src/db/migrations/migration_files/20231128175805_add_wallets_total_trading_rewards.ts (1 hunks)
• indexer/packages/postgres/src/models/wallet-model.ts (3 hunks)
• indexer/packages/postgres/src/types/db-model-types.ts (1 hunks)
• indexer/packages/postgres/src/types/wallet-types.ts (1 hunks)
• indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts (1 hunks)
• indexer/services/ender/tests/handlers/transfer-handler.test.ts (3 hunks)
• indexer/services/ender/src/scripts/dydx_transfer_handler.sql (2 hunks)

Files skipped from review due to trivial changes (3)

• indexer/packages/postgres/tests/stores/wallet-table.test.ts
• indexer/packages/postgres/src/types/db-model-types.ts
• indexer/services/ender/src/scripts/dydx_transfer_handler.sql

Additional comments: 10

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

• 97-100: The totalTradingRewards property is added as a string in the defaultWallet object. Please ensure that when this value is used in database operations, it is correctly converted to a decimal type as per the database schema requirements.

indexer/packages/postgres/__tests__/stores/transfer-table.test.ts (2)

• 267-271: The addition of the totalTradingRewards field in the WalletTable.create method aligns with the summary and the pull request description. This ensures that the new field is being considered in the test cases.

• 270-270: Verify that initializing totalTradingRewards with a string value of '0' is consistent with the expected data type in the database schema and the application's data handling logic.

indexer/packages/postgres/src/models/wallet-model.ts (1)

• 1-1: The import statement for NumericPattern has been correctly added.

indexer/packages/postgres/src/types/wallet-types.ts (2)

• 3-6: The addition of the totalTradingRewards property to the WalletCreateObject interface is correct and aligns with the summary.

• 8-11: The addition of the totalTradingRewards value to the WalletColumns enum is correct and aligns with the summary.

indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts (1)

• 40-42: The totalTradingRewards field is being initialized as a string with a value of '0'. Verify that this is consistent with the database schema, which expects a decimal type. If the database expects a numeric type, initializing it as a string could lead to type mismatch issues.

indexer/services/ender/__tests__/handlers/transfer-handler.test.ts (3)

• 301-307: The test case correctly checks the wallet object for the expected structure and static value for 'totalTradingRewards' after a deposit event.

• 356-358: The test case correctly checks the wallet object for the expected structure and static value for 'totalTradingRewards' after creating a new deposit for a previously non-existent subaccount.

• 410-411: The test case correctly checks the wallet object for the expected structure and static value for 'totalTradingRewards' after a withdrawal event.

[dydxwill]

Is this necessary? Can we just calculate this based on the trading_rewards table?

[vincentwschau]

It can be calculated from the trading_rewards table, however the query would continue to take longer than longer as time went on and more trading rewards are accumulated.