[TRA-78] Add function to retrieve collateral pool addr for a subaccount #1142
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
WalkthroughThe update introduces new functionalities to manage subaccounts within a protocol, specifically focusing on collateral management and market isolation. New functions have been added to handle the retrieval of collateral pool addresses and names for subaccounts, and to determine if a subaccount is isolated to a specific market. This enhancement aims to improve the flexibility and efficiency of subaccount management, particularly in the context of collateralization and market access. Changes
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 Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 2
Configuration used: CodeRabbit UI
Files selected for processing (1)
- protocol/x/subaccounts/keeper/subaccount.go (2 hunks)
Additional comments: 2
protocol/x/subaccounts/keeper/subaccount.go (2)
- 57-71: The implementation of
GetCollateralPoolForSubaccountcorrectly retrieves the collateral pool address for a subaccount by first obtaining the pool name and then converting it to an address. This aligns well with the PR objectives.- 92-106: The implementation of
IsIsolatedMarketSubaccountcorrectly determines whether a subaccount is isolated to a specific market by examining the market type of the first perpetual position. This approach is consistent with the PR objectives.
|
Can you add tests for the new functions? |
Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
vincentwschau
approved these changes
Mar 5, 2024
There was a problem hiding this comment.
Review Status
Actionable comments generated: 3
Configuration used: CodeRabbit UI
Files selected for processing (2)
- protocol/x/subaccounts/keeper/subaccount.go (2 hunks)
- protocol/x/subaccounts/keeper/subaccount_test.go (2 hunks)
Additional comments: 2
protocol/x/subaccounts/keeper/subaccount.go (1)
- 57-70: The implementation of
GetCollateralPoolForSubaccountcorrectly retrieves the collateral pool address for a subaccount, leveraging theGetCollateralPoolNameForSubaccountfunction to obtain the pool name first. This approach is logical and aligns with the PR objectives.protocol/x/subaccounts/keeper/subaccount_test.go (1)
- 105-173: The test function
TestGetCollateralPoolis well-structured and covers various scenarios for retrieving collateral pool addresses. It properly utilizes test utilities for setting up the test environment and asserts the expected outcomes accurately.
| @@ -7,6 +7,8 @@ import ( | |||
| "math/rand" | |||
There was a problem hiding this comment.
The usage of math/rand is noted. For cryptographic operations or where security is a concern, it's recommended to use crypto/rand instead to ensure the randomness is secure. This change is crucial for functions that require secure random number generation.
- "math/rand"
+ "crypto/rand"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.
Suggested change
| "math/rand" | |
| "crypto/rand" |
Comment on lines
+72
to
+89
| func (k Keeper) GetCollateralPoolNameForSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (string, error) { | ||
| subaccount := k.GetSubaccount(ctx, subaccountId) | ||
| if len(subaccount.PerpetualPositions) == 0 { | ||
| return types.ModuleName, nil | ||
| } | ||
|
|
||
| // Get the first perpetual position and return the collateral pool name. | ||
| perpetual, err := k.perpetualsKeeper.GetPerpetual(ctx, subaccount.PerpetualPositions[0].PerpetualId) | ||
| if err != nil { | ||
| panic(fmt.Sprintf("GetCollateralPoolNameForSubaccount: %v", err)) | ||
| } | ||
|
|
||
| if perpetual.Params.MarketType == perptypes.PerpetualMarketType_PERPETUAL_MARKET_TYPE_ISOLATED { | ||
| return types.ModuleName + ":" + lib.UintToString(perpetual.GetId()), nil | ||
| } | ||
|
|
||
| return types.ModuleName, nil | ||
| } |
There was a problem hiding this comment.
Using panic within GetCollateralPoolNameForSubaccount for error handling is not recommended as it can terminate the entire application. Consider returning the error to the caller to handle it more gracefully.
- panic(fmt.Sprintf("GetCollateralPoolNameForSubaccount: %v", err))
+ return "", fmt.Errorf("GetCollateralPoolNameForSubaccount: %w", err)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.
Suggested change
| func (k Keeper) GetCollateralPoolNameForSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (string, error) { | |
| subaccount := k.GetSubaccount(ctx, subaccountId) | |
| if len(subaccount.PerpetualPositions) == 0 { | |
| return types.ModuleName, nil | |
| } | |
| // Get the first perpetual position and return the collateral pool name. | |
| perpetual, err := k.perpetualsKeeper.GetPerpetual(ctx, subaccount.PerpetualPositions[0].PerpetualId) | |
| if err != nil { | |
| panic(fmt.Sprintf("GetCollateralPoolNameForSubaccount: %v", err)) | |
| } | |
| if perpetual.Params.MarketType == perptypes.PerpetualMarketType_PERPETUAL_MARKET_TYPE_ISOLATED { | |
| return types.ModuleName + ":" + lib.UintToString(perpetual.GetId()), nil | |
| } | |
| return types.ModuleName, nil | |
| } | |
| func (k Keeper) GetCollateralPoolNameForSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (string, error) { | |
| subaccount := k.GetSubaccount(ctx, subaccountId) | |
| if len(subaccount.PerpetualPositions) == 0 { | |
| return types.ModuleName, nil | |
| } | |
| // Get the first perpetual position and return the collateral pool name. | |
| perpetual, err := k.perpetualsKeeper.GetPerpetual(ctx, subaccount.PerpetualPositions[0].PerpetualId) | |
| if err != nil { | |
| return "", fmt.Errorf("GetCollateralPoolNameForSubaccount: %w", err) | |
| } | |
| if perpetual.Params.MarketType == perptypes.PerpetualMarketType_PERPETUAL_MARKET_TYPE_ISOLATED { | |
| return types.ModuleName + ":" + lib.UintToString(perpetual.GetId()), nil | |
| } | |
| return types.ModuleName, nil | |
| } |
Comment on lines
+91
to
+98
| // IsIsolatedMarketSubaccount returns whether a subaccount is isolated to a specific market. | ||
| func (k Keeper) IsIsolatedMarketSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (bool, error) { | ||
| poolName, err := k.GetCollateralPoolNameForSubaccount(ctx, subaccountId) | ||
| if err != nil { | ||
| panic(fmt.Sprintf("IsIsolatedMarketSubaccount: %v", err)) | ||
| } | ||
| return poolName != types.ModuleName, nil | ||
| } |
There was a problem hiding this comment.
Using panic within IsIsolatedMarketSubaccount for error handling is not recommended as it can terminate the entire application. Consider returning the error to the caller to handle it more gracefully.
- panic(fmt.Sprintf("IsIsolatedMarketSubaccount: %v", err))
+ return false, fmt.Errorf("IsIsolatedMarketSubaccount: %w", err)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.
Suggested change
| // IsIsolatedMarketSubaccount returns whether a subaccount is isolated to a specific market. | |
| func (k Keeper) IsIsolatedMarketSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (bool, error) { | |
| poolName, err := k.GetCollateralPoolNameForSubaccount(ctx, subaccountId) | |
| if err != nil { | |
| panic(fmt.Sprintf("IsIsolatedMarketSubaccount: %v", err)) | |
| } | |
| return poolName != types.ModuleName, nil | |
| } | |
| // IsIsolatedMarketSubaccount returns whether a subaccount is isolated to a specific market. | |
| func (k Keeper) IsIsolatedMarketSubaccount(ctx sdk.Context, subaccountId types.SubaccountId) (bool, error) { | |
| poolName, err := k.GetCollateralPoolNameForSubaccount(ctx, subaccountId) | |
| if err != nil { | |
| return false, fmt.Errorf("IsIsolatedMarketSubaccount: %w", err) | |
| } | |
| return poolName != types.ModuleName, nil | |
| } |
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
Files selected for processing (1)
- protocol/x/subaccounts/keeper/subaccount_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/x/subaccounts/keeper/subaccount_test.go
Eric-Warehime
pushed a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
…nt (dydxprotocol#1142) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com>
Eric-Warehime
added a commit
to skip-mev/v4-chain
that referenced
this pull request
Mar 12, 2024
commit d98f859 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 11 12:46:53 2024 -0700 Update sample pregenesis Signed-off-by: Eric <eric.warehime@gmail.com> commit 7f178fe Author: Mohammed Affan <affanmd@nyu.edu> Date: Mon Mar 11 13:46:08 2024 -0400 [OTE-209] Emit metrics gated through execution mode (dydxprotocol#1157) Signed-off-by: Eric <eric.warehime@gmail.com> commit 47e365d Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 11 13:43:16 2024 -0400 add aggregate comlink response code stats (dydxprotocol#1162) Signed-off-by: Eric <eric.warehime@gmail.com> commit 7774ad9 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Fri Mar 8 17:30:49 2024 -0500 [TRA-70] Add state migrations for isolated markets (dydxprotocol#1155) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit 89c7405 Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Thu Mar 7 17:28:06 2024 -0500 [CT-517] E2E tests batch cancel (dydxprotocol#1149) * more end to end test * extraprint * more e2e test Signed-off-by: Eric <eric.warehime@gmail.com> commit 41a3a41 Author: Teddy Ding <teddy@dydx.exchange> Date: Thu Mar 7 15:42:30 2024 -0500 [OTE-200] OIMF protos (dydxprotocol#1125) * OIMF protos * add default genesis value, modify methods interface * fix genesis file * fix integration test * lint Signed-off-by: Eric <eric.warehime@gmail.com> commit 2a062b1 Author: Teddy Ding <teddy@dydx.exchange> Date: Thu Mar 7 15:24:15 2024 -0500 Add `v5` upgrade handler and set up container upgrade test (dydxprotocol#1153) * wip * update preupgrade_genesis * fix preupgrade_genesis.json * nit * setupUpgradeStoreLoaders for v5.0.0 Signed-off-by: Eric <eric.warehime@gmail.com> commit b7942b3 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Thu Mar 7 13:43:48 2024 -0500 [CT-647] construct the initial orderbook snapshot (dydxprotocol#1147) * [CT-647] construct the initial orderbook snapshot * [CT-647] initialize new streams and send orderbook snapshot (dydxprotocol#1152) * [CT-647] initialize new streams and send orderbook snapshot * use sync once * comments Signed-off-by: Eric <eric.warehime@gmail.com> commit c67a3c6 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Thu Mar 7 12:40:37 2024 -0500 [TRA-84] Move SA module address transfers to use perpetual based SA accounts (dydxprotocol#1146) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange Signed-off-by: Eric <eric.warehime@gmail.com> commit dba23e0 Author: Mohammed Affan <affanmd@nyu.edu> Date: Thu Mar 7 10:34:11 2024 -0500 update readme link to point to the right page (dydxprotocol#1151) Signed-off-by: Eric <eric.warehime@gmail.com> commit b5870d5 Author: Tian <tian@dydx.exchange> Date: Wed Mar 6 16:43:04 2024 -0500 [TRA-86] scaffold x/vault (dydxprotocol#1148) * scaffold x/vault Signed-off-by: Eric <eric.warehime@gmail.com> commit 0eca041 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Wed Mar 6 10:48:42 2024 -0500 [CT-652] add command line flag for full node streaming (dydxprotocol#1145) Signed-off-by: Eric <eric.warehime@gmail.com> commit b319cb8 Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Tue Mar 5 21:58:35 2024 -0500 [CT-646] stream offchain updates through stream manager (dydxprotocol#1138) * [CT-646] stream offchain updates through stream manager * comments * fix lint * get rid of finished * comments * comments Signed-off-by: Eric <eric.warehime@gmail.com> commit 1c54620 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Tue Mar 5 16:34:19 2024 -0500 [TRA-78] Add function to retrieve collateral pool addr for a subaccount (dydxprotocol#1142) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit b8c1d62 Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Tue Mar 5 15:03:28 2024 -0500 [OTE-141] implement post /compliance/geoblock (dydxprotocol#1129) Signed-off-by: Eric <eric.warehime@gmail.com> commit ab8c570 Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Tue Mar 5 11:19:53 2024 -0500 Fix mock-gen dydxprotocol#1140 Signed-off-by: Eric <eric.warehime@gmail.com> commit 12506a1 Author: shrenujb <98204323+shrenujb@users.noreply.github.com> Date: Mon Mar 4 21:33:28 2024 -0500 [TRA-64] Use market specific insurance fund for cross or isolated markets (dydxprotocol#1132) Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange> Signed-off-by: Eric <eric.warehime@gmail.com> commit 929f09e Author: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com> Date: Mon Mar 4 13:48:04 2024 -0800 [CT-514] Clob `MsgBatchCancel` functionality (dydxprotocol#1110) * wip implementation * use new cometbft * Revert "use new cometbft" This reverts commit e5b8a03. * go mod tidy * basic e2e test * more msgBatchCancels in code * repeated fixed32 -> uint32 * remove debug prints * update cometbft replace go.mod sha * one more debug print * typo * regen indexer protos * update comment on proto * proto comment changes * extract stateful validation into own fn * pr format comments * clean up test file * new return type with success and failure Signed-off-by: Eric <eric.warehime@gmail.com> commit 41de83e Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 4 12:22:16 2024 -0500 add index to address read replica lag (dydxprotocol#1137) Signed-off-by: Eric <eric.warehime@gmail.com> commit 735d9a8 Author: dydxwill <119354122+dydxwill@users.noreply.github.com> Date: Mon Mar 4 11:56:59 2024 -0500 rename (dydxprotocol#1136) Signed-off-by: Eric <eric.warehime@gmail.com> commit 86617dd Author: jayy04 <103467857+jayy04@users.noreply.github.com> Date: Mon Mar 4 10:43:31 2024 -0500 [CT-644] instantiate grpc stream manager (dydxprotocol#1134) * [CT-644] instantiate grpc stream manager * update type * update channel type Signed-off-by: Eric <eric.warehime@gmail.com> commit 32afd64 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 11 12:41:06 2024 -0700 Update go version in Dockerfile Signed-off-by: Eric <eric.warehime@gmail.com> commit ba27204 Author: Eric <eric.warehime@gmail.com> Date: Fri Mar 8 09:44:04 2024 -0800 Add slinky utils, use that to convert between market and currency pair commit 667a804 Author: Eric <eric.warehime@gmail.com> Date: Wed Mar 6 20:43:40 2024 -0800 Update error messages commit d53292c Author: Eric <eric.warehime@gmail.com> Date: Wed Mar 6 20:16:01 2024 -0800 Update docstrings, rename OracleClient commit daad125 Author: Eric <eric.warehime@gmail.com> Date: Mon Mar 4 10:51:23 2024 -0800 VoteExtension slinky logic
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changelist
Add functions to get collateral pool address for cross or isolated markets based on the subaccount being used
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.