[TRA-125] Update withdrawal gating to be per collateral pool. (#1208)

dydxprotocol · Mar 22, 2024 · 58a0f11 · 58a0f11
1 parent 780410f
commit 58a0f11
Show file tree

Hide file tree

Showing 23 changed files with 1,591 additions and 342 deletions.
diff --git a/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.lcd.ts b/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.lcd.ts
@@ -42,9 +42,17 @@ export class LCDQueryClient {
    if so which block they are re-enabled on. */
 
 
-  async getWithdrawalAndTransfersBlockedInfo(_params: QueryGetWithdrawalAndTransfersBlockedInfoRequest = {}): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponseSDKType> {
+  async getWithdrawalAndTransfersBlockedInfo(params: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponseSDKType> {
+    const options: any = {
+      params: {}
+    };
+
+    if (typeof params?.perpetualId !== "undefined") {
+      options.params.perpetual_id = params.perpetualId;
+    }
+
     const endpoint = `dydxprotocol/subaccounts/withdrawals_and_transfers_blocked_info`;
-    return await this.req.get<QueryGetWithdrawalAndTransfersBlockedInfoResponseSDKType>(endpoint);
+    return await this.req.get<QueryGetWithdrawalAndTransfersBlockedInfoResponseSDKType>(endpoint, options);
   }
 
 }
diff --git a/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.rpc.Query.ts b/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.rpc.Query.ts
@@ -15,7 +15,7 @@ export interface Query {
    * if so which block they are re-enabled on.
    */
 
-  getWithdrawalAndTransfersBlockedInfo(request?: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse>;
+  getWithdrawalAndTransfersBlockedInfo(request: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse>;
 }
 export class QueryClientImpl implements Query {
   private readonly rpc: Rpc;
@@ -41,7 +41,7 @@ export class QueryClientImpl implements Query {
     return promise.then(data => QuerySubaccountAllResponse.decode(new _m0.Reader(data)));
   }
 
-  getWithdrawalAndTransfersBlockedInfo(request: QueryGetWithdrawalAndTransfersBlockedInfoRequest = {}): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
+  getWithdrawalAndTransfersBlockedInfo(request: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
     const data = QueryGetWithdrawalAndTransfersBlockedInfoRequest.encode(request).finish();
     const promise = this.rpc.request("dydxprotocol.subaccounts.Query", "GetWithdrawalAndTransfersBlockedInfo", data);
     return promise.then(data => QueryGetWithdrawalAndTransfersBlockedInfoResponse.decode(new _m0.Reader(data)));
@@ -60,7 +60,7 @@ export const createRpcQueryExtension = (base: QueryClient) => {
       return queryService.subaccountAll(request);
     },
 
-    getWithdrawalAndTransfersBlockedInfo(request?: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
+    getWithdrawalAndTransfersBlockedInfo(request: QueryGetWithdrawalAndTransfersBlockedInfoRequest): Promise<QueryGetWithdrawalAndTransfersBlockedInfoResponse> {
       return queryService.getWithdrawalAndTransfersBlockedInfo(request);
     }
 

diff --git a/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.ts b/indexer/packages/v4-protos/src/codegen/dydxprotocol/subaccounts/query.ts
@@ -48,16 +48,22 @@ export interface QuerySubaccountAllResponseSDKType {
 }
 /**
  * QueryGetWithdrawalAndTransfersBlockedInfoRequest is a request type for
- * fetching information about whether withdrawals and transfers are blocked.
+ * fetching information about whether withdrawals and transfers are blocked for
+ * a collateral pool associated with the passed in perpetual id.
  */
 
-export interface QueryGetWithdrawalAndTransfersBlockedInfoRequest {}
+export interface QueryGetWithdrawalAndTransfersBlockedInfoRequest {
+  perpetualId: number;
+}
 /**
  * QueryGetWithdrawalAndTransfersBlockedInfoRequest is a request type for
- * fetching information about whether withdrawals and transfers are blocked.
+ * fetching information about whether withdrawals and transfers are blocked for
+ * a collateral pool associated with the passed in perpetual id.
  */
 
-export interface QueryGetWithdrawalAndTransfersBlockedInfoRequestSDKType {}
+export interface QueryGetWithdrawalAndTransfersBlockedInfoRequestSDKType {
+  perpetual_id: number;
+}
 /**
  * QueryGetWithdrawalAndTransfersBlockedInfoRequest is a response type for
  * fetching information about whether withdrawals and transfers are blocked.
@@ -280,11 +286,17 @@ export const QuerySubaccountAllResponse = {
 };
 
 function createBaseQueryGetWithdrawalAndTransfersBlockedInfoRequest(): QueryGetWithdrawalAndTransfersBlockedInfoRequest {
-  return {};
+  return {
+    perpetualId: 0
+  };
 }
 
 export const QueryGetWithdrawalAndTransfersBlockedInfoRequest = {
-  encode(_: QueryGetWithdrawalAndTransfersBlockedInfoRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+  encode(message: QueryGetWithdrawalAndTransfersBlockedInfoRequest, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.perpetualId !== 0) {
+      writer.uint32(8).uint32(message.perpetualId);
+    }
+
     return writer;
   },
 
@@ -297,6 +309,10 @@ export const QueryGetWithdrawalAndTransfersBlockedInfoRequest = {
       const tag = reader.uint32();
 
       switch (tag >>> 3) {
+        case 1:
+          message.perpetualId = reader.uint32();
+          break;
+
         default:
           reader.skipType(tag & 7);
           break;
@@ -306,8 +322,9 @@ export const QueryGetWithdrawalAndTransfersBlockedInfoRequest = {
     return message;
   },
 
-  fromPartial(_: DeepPartial<QueryGetWithdrawalAndTransfersBlockedInfoRequest>): QueryGetWithdrawalAndTransfersBlockedInfoRequest {
+  fromPartial(object: DeepPartial<QueryGetWithdrawalAndTransfersBlockedInfoRequest>): QueryGetWithdrawalAndTransfersBlockedInfoRequest {
     const message = createBaseQueryGetWithdrawalAndTransfersBlockedInfoRequest();
+    message.perpetualId = object.perpetualId ?? 0;
     return message;
   }
 

diff --git a/proto/dydxprotocol/subaccounts/query.proto b/proto/dydxprotocol/subaccounts/query.proto
@@ -56,8 +56,11 @@ message QuerySubaccountAllResponse {
 }
 
 // QueryGetWithdrawalAndTransfersBlockedInfoRequest is a request type for
-// fetching information about whether withdrawals and transfers are blocked.
-message QueryGetWithdrawalAndTransfersBlockedInfoRequest {}
+// fetching information about whether withdrawals and transfers are blocked for
+// a collateral pool associated with the passed in perpetual id.
+message QueryGetWithdrawalAndTransfersBlockedInfoRequest {
+  uint32 perpetual_id = 1;
+}
 
 // QueryGetWithdrawalAndTransfersBlockedInfoRequest is a response type for
 // fetching information about whether withdrawals and transfers are blocked.

diff --git a/protocol/testutil/constants/addresses.go b/protocol/testutil/constants/addresses.go
@@ -2,6 +2,8 @@ package constants
 
 import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+	satypes "github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
 )
 
 var (
@@ -17,4 +19,8 @@ var (
 	BobConsAddress   = sdk.ConsAddress(BobPrivateKey.PubKey().Address())
 	CarlConsAddress  = sdk.ConsAddress(CarlPrivateKey.PubKey().Address())
 	DaveConsAddress  = sdk.ConsAddress(DavePrivateKey.PubKey().Address())
+
+	// Collateral pool addresses for isolated perpetuals.
+	IsoCollateralPoolAddress  = authtypes.NewModuleAddress(satypes.ModuleName + ":3")
+	Iso2CollateralPoolAddress = authtypes.NewModuleAddress(satypes.ModuleName + ":4")
 )
diff --git a/protocol/testutil/constants/clob_pair.go b/protocol/testutil/constants/clob_pair.go
@@ -127,4 +127,40 @@ var (
 		QuantumConversionExponent: -8,
 		Status:                    clobtypes.ClobPair_STATUS_PAUSED,
 	}
+	ClobPair_3_Iso = clobtypes.ClobPair{
+		Id: 3,
+		Metadata: &clobtypes.ClobPair_PerpetualClobMetadata{
+			PerpetualClobMetadata: &clobtypes.PerpetualClobMetadata{
+				PerpetualId: 3,
+			},
+		},
+		StepBaseQuantums:          5,
+		SubticksPerTick:           5,
+		QuantumConversionExponent: -8,
+		Status:                    clobtypes.ClobPair_STATUS_ACTIVE,
+	}
+	ClobPair_3_Iso_Final_Settlement = clobtypes.ClobPair{
+		Id: 3,
+		Metadata: &clobtypes.ClobPair_PerpetualClobMetadata{
+			PerpetualClobMetadata: &clobtypes.PerpetualClobMetadata{
+				PerpetualId: 3,
+			},
+		},
+		StepBaseQuantums:          5,
+		SubticksPerTick:           5,
+		QuantumConversionExponent: -8,
+		Status:                    clobtypes.ClobPair_STATUS_FINAL_SETTLEMENT,
+	}
+	ClobPair_4_Iso2 = clobtypes.ClobPair{
+		Id: 4,
+		Metadata: &clobtypes.ClobPair_PerpetualClobMetadata{
+			PerpetualClobMetadata: &clobtypes.PerpetualClobMetadata{
+				PerpetualId: 4,
+			},
+		},
+		StepBaseQuantums:          5,
+		SubticksPerTick:           5,
+		QuantumConversionExponent: -8,
+		Status:                    clobtypes.ClobPair_STATUS_ACTIVE,
+	}
 )
diff --git a/protocol/testutil/constants/subaccounts.go b/protocol/testutil/constants/subaccounts.go
@@ -286,6 +286,22 @@ var (
 			},
 		},
 	}
+	Carl_Num0_1ISO_Short_49USD = satypes.Subaccount{
+		Id: &Carl_Num0,
+		AssetPositions: []*satypes.AssetPosition{
+			{
+				AssetId:  0,
+				Quantums: dtypes.NewInt(49_000_000), // $49
+			},
+		},
+		PerpetualPositions: []*satypes.PerpetualPosition{
+			{
+				PerpetualId:  3,
+				Quantums:     dtypes.NewInt(-1_000_000_000), // -1 ISO
+				FundingIndex: dtypes.NewInt(0),
+			},
+		},
+	}
 	Carl_Num0_599USD = satypes.Subaccount{
 		Id: &Carl_Num0,
 		AssetPositions: []*satypes.AssetPosition{
@@ -518,6 +534,22 @@ var (
 			},
 		},
 	}
+	Dave_Num0_1ISO2_Short_499USD = satypes.Subaccount{
+		Id: &Dave_Num0,
+		AssetPositions: []*satypes.AssetPosition{
+			{
+				AssetId:  0,
+				Quantums: dtypes.NewInt(499_000_000), // $499
+			},
+		},
+		PerpetualPositions: []*satypes.PerpetualPosition{
+			{
+				PerpetualId:  4,
+				Quantums:     dtypes.NewInt(-10_000_000), // -1 ISO2
+				FundingIndex: dtypes.NewInt(0),
+			},
+		},
+	}
 	Dave_Num0_599USD = satypes.Subaccount{
 		Id: &Dave_Num0,
 		AssetPositions: []*satypes.AssetPosition{

diff --git a/protocol/x/clob/e2e/withdrawal_gating_test.go b/protocol/x/clob/e2e/withdrawal_gating_test.go
@@ -252,7 +252,11 @@ func TestWithdrawalGating_NegativeTncSubaccount_BlocksThenUnblocks(t *testing.T)
 					tApp.App.SubaccountsKeeper.GetSubaccount(ctx, *expectedSubaccount.Id),
 				)
 			}
-			negativeTncSubaccountSeenAtBlock, exists := tApp.App.SubaccountsKeeper.GetNegativeTncSubaccountSeenAtBlock(ctx)
+			negativeTncSubaccountSeenAtBlock, exists, err := tApp.App.SubaccountsKeeper.GetNegativeTncSubaccountSeenAtBlock(
+				ctx,
+				constants.BtcUsd_NoMarginRequirement.Params.Id,
+			)
+			require.NoError(t, err)
 			require.Equal(t, tc.expectedWithdrawalsGated, exists)
 			require.Equal(t, tc.expectedNegativeTncSubaccountSeenAtBlock, negativeTncSubaccountSeenAtBlock)
 

diff --git a/protocol/x/clob/keeper/process_operations.go b/protocol/x/clob/keeper/process_operations.go
@@ -694,7 +694,13 @@ func (k Keeper) PersistMatchDeleveragingToState(
 			metrics.GetLabelForBoolValue(metrics.IsLong, position.GetIsLong()),
 			metrics.GetLabelForBoolValue(metrics.DeliverTx, true),
 		)
-		k.subaccountsKeeper.SetNegativeTncSubaccountSeenAtBlock(ctx, lib.MustConvertIntegerToUint32(ctx.BlockHeight()))
+		if err = k.subaccountsKeeper.SetNegativeTncSubaccountSeenAtBlock(
+			ctx,
+			perpetualId,
+			lib.MustConvertIntegerToUint32(ctx.BlockHeight()),
+		); err != nil {
+			return err
+		}
 		return nil
 	}