[OTE-752] Add totalVolume and isWhitelistAffiliate to wallets table #2166
Conversation
jerryfan01234
force-pushed
the
affiliates-update-wallets-table
branch
from
9263bb6
to
c9e4411
Compare
WalkthroughThe changes introduce two new properties, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant WalletTable
participant Database
User->>WalletTable: Create Wallet
WalletTable->>Database: Insert wallet with totalVolume and isWhitelistAffiliate
Database-->>WalletTable: Confirm insert
WalletTable-->>User: Return wallet details
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (13)
- 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 (4 hunks)
- indexer/packages/postgres/src/db/migrations/migration_files/20240827162119_add_wallets_total_volume_and_affiliates_whitelist.ts (1 hunks)
- indexer/packages/postgres/src/models/wallet-model.ts (3 hunks)
- indexer/packages/postgres/src/stores/wallet-table.ts (3 hunks)
- indexer/packages/postgres/src/types/db-model-types.ts (1 hunks)
- indexer/packages/postgres/src/types/query-types.ts (2 hunks)
- indexer/packages/postgres/src/types/wallet-types.ts (1 hunks)
- indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts (6 hunks)
- indexer/services/ender/tests/handlers/trading-rewards-handler.test.ts (3 hunks)
- indexer/services/ender/tests/handlers/transfer-handler.test.ts (3 hunks)
- indexer/services/ender/src/scripts/handlers/dydx_transfer_handler.sql (2 hunks)
Additional comments not posted (46)
indexer/packages/postgres/src/types/wallet-types.ts (3)
6-7: LGTM!The new properties
totalVolumeandisWhitelistAffiliateare correctly added and typed.The code changes are approved.
13-14: LGTM!The new properties
totalVolumeandisWhitelistAffiliateare correctly added and typed.The code changes are approved.
20-21: LGTM!The new members
totalVolumeandisWhitelistAffiliateare correctly added and typed.The code changes are approved.
indexer/packages/postgres/src/db/migrations/migration_files/20240827162119_add_wallets_total_volume_and_affiliates_whitelist.ts (2)
3-9: LGTM!The new columns
totalVolumeandisWhitelistAffiliateare correctly added with appropriate types and default values.The code changes are approved.
12-18: LGTM!The columns
totalVolumeandisWhitelistAffiliateare correctly dropped.The code changes are approved.
indexer/packages/postgres/src/models/wallet-model.ts (4)
43-44: LGTM!The new properties
totalVolumeandisWhitelistAffiliateare correctly added and typed.The code changes are approved.
Also applies to: 49-50
65-66: LGTM!The new mappings
totalVolumeandisWhitelistAffiliateare correctly added and typed.The code changes are approved.
76-76: LGTM!The new class field
totalVolumeis correctly added and typed.The code changes are approved.
78-78: LGTM!The new class field
isWhitelistAffiliateis correctly added and typed.The code changes are approved.
indexer/packages/postgres/__tests__/stores/wallet-table.test.ts (3)
30-41: LGTM!The function correctly tests the
upsertmethod with the new propertiesisWhitelistAffiliateandtotalVolume.The code changes are approved.
50-51: LGTM!The function correctly tests the
findAllmethod with the new propertiesisWhitelistAffiliateandtotalVolume.The code changes are approved.
78-94: LGTM!The function correctly tests the
findAllmethod with theisWhitelistAffiliateproperty.The code changes are approved.
indexer/packages/postgres/src/stores/wallet-table.ts (1)
22-23: LGTM!The function correctly includes
isWhitelistAffiliatein the query, allowing for more granular filtering.The code changes are approved.
Also applies to: 31-32, 46-48
indexer/services/ender/src/scripts/handlers/dydx_transfer_handler.sql (1)
60-61: LGTM!The function correctly includes
totalVolumeandisWhitelistAffiliatein the wallet records, enhancing the data model.The code changes are approved.
Also applies to: 70-71
indexer/packages/postgres/src/types/db-model-types.ts (2)
31-31: LGTM! But verify the usage of the new property.The addition of
totalVolumeto theWalletFromDatabaseinterface looks good. Ensure that this new property is consistently integrated and utilized in the codebase.The code changes are approved.
Run the following script to verify the usage of the new property:
Verification successful
The
totalVolumeproperty is consistently integrated and utilized across the codebase.The property appears in various files, including models, migration scripts, and test files, indicating thorough integration.
- Files:
indexer/packages/postgres/src/models/wallet-model.tsindexer/packages/postgres/src/db/migrations/migration_files/20240827162119_add_wallets_total_volume_and_affiliates_whitelist.tsindexer/packages/postgres/__tests__/helpers/constants.tsindexer/packages/postgres/__tests__/stores/wallet-table.test.ts- And others.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all usages of the `totalVolume` property. # Test: Search for the property usage. Expect: Consistent integration and utilization. rg --type python -A 5 $'totalVolume'Length of output: 66
Script:
#!/bin/bash # Description: Verify all usages of the `totalVolume` property in TypeScript files. # Test: Search for the property usage. Expect: Consistent integration and utilization. rg --type ts -A 5 $'totalVolume'Length of output: 21559
32-32: LGTM! But verify the usage of the new property.The addition of
isWhitelistAffiliateto theWalletFromDatabaseinterface looks good. Ensure that this new property is consistently integrated and utilized in the codebase.The code changes are approved.
Run the following script to verify the usage of the new property:
Verification successful
The
isWhitelistAffiliateproperty is consistently integrated and utilized across the codebase.The property is used in various test files, store files, and migration files, indicating thorough integration and testing.
- Test Files: The property is tested in multiple test cases, ensuring its behavior is verified.
- Store Files: It is part of the data handling logic, showing its role in application functionality.
- Migration Files: The property is included in the database schema, confirming its support at the database level.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify all usages of the `isWhitelistAffiliate` property. # Test: Search for the property usage. Expect: Consistent integration and utilization. rg --type python -A 5 $'isWhitelistAffiliate'Length of output: 75
Script:
#!/bin/bash # Description: Verify all usages of the `isWhitelistAffiliate` property in TypeScript files. # Test: Search for the property usage. Expect: Consistent integration and utilization. rg --type ts -A 5 $'isWhitelistAffiliate'Length of output: 19751
indexer/services/ender/__tests__/handlers/trading-rewards-handler.test.ts (6)
177-177: LGTM!The addition of
totalVolumewith a default value of '0' to the wallet object in the test case looks good.The code changes are approved.
178-178: LGTM!The addition of
isWhitelistAffiliatewith a default value offalseto the wallet object in the test case looks good.The code changes are approved.
202-202: LGTM!The addition of
totalVolumewith a default value of '0' to the wallet object in the test case looks good.The code changes are approved.
203-203: LGTM!The addition of
isWhitelistAffiliatewith a default value offalseto the wallet object in the test case looks good.The code changes are approved.
213-213: LGTM!The addition of
totalVolumewith a default value of '0' to the wallet object in the test case looks good.The code changes are approved.
214-214: LGTM!The addition of
isWhitelistAffiliatewith a default value offalseto the wallet object in the test case looks good.The code changes are approved.
indexer/packages/postgres/src/types/query-types.ts (2)
114-114: LGTM! But verify the usage of the new property.The addition of
[QueryableField.IS_WHITELIST_AFFILIATE]?: boolean;to theWalletQueryConfiginterface looks good. Ensure that this new property is consistently integrated and utilized in the codebase.The code changes are approved.
Run the following script to verify the usage of the new property:
91-91: LGTM! But verify the usage of the new value.The addition of
IS_WHITELIST_AFFILIATEto theQueryableFieldenum looks good. Ensure that this new value is consistently integrated and utilized in the codebase.The code changes are approved.
Run the following script to verify the usage of the new value:
indexer/packages/postgres/__tests__/stores/transfer-table.test.ts (2)
325-325: Verify handling oftotalVolumeinWalletTable.Ensure that the
totalVolumefield is properly handled in theWalletTableimplementation.
326-326: Verify handling ofisWhitelistAffiliateinWalletTable.Ensure that the
isWhitelistAffiliatefield is properly handled in theWalletTableimplementation.indexer/services/ender/__tests__/handlers/transfer-handler.test.ts (4)
309-309: Verify handling oftotalVolumeinWalletTable.Ensure that the
totalVolumefield is properly handled in theWalletTableimplementation.
310-310: Verify handling ofisWhitelistAffiliateinWalletTable.Ensure that the
isWhitelistAffiliatefield is properly handled in theWalletTableimplementation.
363-363: Verify handling oftotalVolumeinWalletTable.Ensure that the
totalVolumefield is properly handled in theWalletTableimplementation.
364-364: Verify handling ofisWhitelistAffiliateinWalletTable.Ensure that the
isWhitelistAffiliatefield is properly handled in theWalletTableimplementation.indexer/packages/postgres/__tests__/helpers/constants.ts (4)
161-161: Verify handling oftotalVolumeinWalletTable.Ensure that the
totalVolumefield is properly handled in theWalletTableimplementation.
162-162: Verify handling ofisWhitelistAffiliateinWalletTable.Ensure that the
isWhitelistAffiliatefield is properly handled in theWalletTableimplementation.
168-168: Verify handling oftotalVolumeinWalletTable.Ensure that the
totalVolumefield is properly handled in theWalletTableimplementation.
169-169: Verify handling ofisWhitelistAffiliateinWalletTable.Ensure that the
isWhitelistAffiliatefield is properly handled in theWalletTableimplementation.indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts (12)
59-60: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
60-60: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
185-186: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
186-186: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
468-469: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
469-469: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
594-595: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
595-595: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
749-750: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
750-750: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
837-838: LGTM!The addition of
totalVolumeto theWalletTable.createfunction call is correct and consistent with the PR objectives.
838-838: LGTM!The addition of
isWhitelistAffiliateto theWalletTable.createfunction call is correct and consistent with the PR objectives.
indexer/services/comlink/__tests__/controllers/api/v4/transfers-controller.test.ts
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts (8 hunks)
- indexer/services/ender/tests/handlers/trading-rewards-handler.test.ts (5 hunks)
- indexer/services/ender/tests/handlers/transfer-handler.test.ts (4 hunks)
Files skipped from review as they are similar to previous changes (3)
- indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts
- indexer/services/ender/tests/handlers/trading-rewards-handler.test.ts
- indexer/services/ender/tests/handlers/transfer-handler.test.ts
jerryfan01234
force-pushed
the
affiliates-update-wallets-table
branch
2 times, most recently
from
7bf6b74
to
8f8400c
Compare
| @@ -27,6 +27,13 @@ import { | |||
| } from '@dydxprotocol-indexer/postgres/build/__tests__/helpers/constants'; | |||
| import Big from 'big.js'; | |||
|
|
|||
| const defaultWallet = { | |||
There was a problem hiding this comment.
nit: why not use testConstants.defaultWallet imported from postgres?
jerryfan01234
force-pushed
the
affiliates-update-wallets-table
branch
from
8f8400c
to
8a8a2c1
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts (7 hunks)
- indexer/services/ender/tests/handlers/trading-rewards-handler.test.ts (3 hunks)
- indexer/services/ender/tests/handlers/transfer-handler.test.ts (5 hunks)
Files skipped from review as they are similar to previous changes (3)
- indexer/services/comlink/tests/controllers/api/v4/transfers-controller.test.ts
- indexer/services/ender/tests/handlers/trading-rewards-handler.test.ts
- indexer/services/ender/tests/handlers/transfer-handler.test.ts
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- indexer/packages/postgres/src/types/db-model-types.ts (1 hunks)
- indexer/packages/postgres/src/types/query-types.ts (2 hunks)
Files skipped from review as they are similar to previous changes (2)
- indexer/packages/postgres/src/types/db-model-types.ts
- indexer/packages/postgres/src/types/query-types.ts
✅ Backports have been created
|
Commented on wrong PR, will close packport PR once created |
Changelist
[Describe or list the changes made in this PR]
Test Plan
[Describe how this PR was tested (if applicable)]
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.Summary by CodeRabbit
New Features
totalVolumeandisWhitelistAffiliateacross various wallet-related functionalities to enhance wallet management and reporting capabilities.Bug Fixes
Documentation
Chores