remove panic when getting quantums from zero position (#1964)

dydxprotocol · Jul 26, 2024 · cd9380f · cd9380f
1 parent 7542acc
commit cd9380f
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 51 deletions.
diff --git a/protocol/x/subaccounts/lib/updates.go b/protocol/x/subaccounts/lib/updates.go
@@ -58,6 +58,7 @@ func GetSettledSubaccountWithPerpetuals(
 			newPerpetualPositions, &types.PerpetualPosition{
 				PerpetualId:  p.PerpetualId,
 				Quantums:     p.Quantums,
+				QuoteBalance: p.QuoteBalance,
 				FundingIndex: dtypes.NewIntFromBigInt(newFundingIndex),
 			},
 		)

diff --git a/protocol/x/subaccounts/types/genesis_test.go b/protocol/x/subaccounts/types/genesis_test.go
@@ -4,8 +4,6 @@ import (
 	"math/big"
 	"testing"
 
-	errorsmod "cosmossdk.io/errors"
-
 	"github.com/dydxprotocol/v4-chain/protocol/testutil/sample"
 	testutil "github.com/dydxprotocol/v4-chain/protocol/testutil/util"
 	"github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
@@ -173,11 +171,8 @@ func TestGenesisState_Validate(t *testing.T) {
 					},
 				},
 			},
-			shouldPanic: true,
-			expectedError: errorsmod.Wrapf(
-				types.ErrAssetPositionZeroQuantum,
-				"asset position (asset Id: 0) has zero quantum",
-			),
+			shouldPanic:   false,
+			expectedError: types.ErrAssetPositionZeroQuantum,
 		},
 		"invalid: perpetual positions out of order": {
 			genState: &types.GenesisState{
@@ -225,11 +220,8 @@ func TestGenesisState_Validate(t *testing.T) {
 					},
 				},
 			},
-			shouldPanic: true,
-			expectedError: errorsmod.Wrapf(
-				types.ErrPerpPositionZeroQuantum,
-				"perpetual position (perpetual Id: 0) has zero quantum",
-			),
+			shouldPanic:   false,
+			expectedError: types.ErrPerpPositionZeroQuantum,
 		},
 	}
 

diff --git a/protocol/x/subaccounts/types/position_size.go b/protocol/x/subaccounts/types/position_size.go
@@ -3,8 +3,6 @@ package types
 import (
 	"math/big"
 
-	errorsmod "cosmossdk.io/errors"
-
 	"github.com/dydxprotocol/v4-chain/protocol/dtypes"
 )
 
@@ -43,20 +41,12 @@ func (m *AssetPosition) GetId() uint32 {
 	return m.GetAssetId()
 }
 
-// Get the asset position quantum size in big.Int. Panics if the size is zero.
+// Get the asset position quantum size in big.Int.
 func (m *AssetPosition) GetBigQuantums() *big.Int {
-	if m == nil {
+	if m == nil || m.Quantums.IsNil() {
 		return new(big.Int)
 	}
 
-	if m.Quantums.Sign() == 0 {
-		panic(errorsmod.Wrapf(
-			ErrAssetPositionZeroQuantum,
-			"asset position (asset Id: %v) has zero quantum",
-			m.AssetId,
-		))
-	}
-
 	return m.Quantums.BigInt()
 }
 
@@ -75,20 +65,12 @@ func (m *PerpetualPosition) SetQuantums(sizeQuantums int64) {
 	m.Quantums = dtypes.NewInt(sizeQuantums)
 }
 
-// Get the perpetual position quantum size in big.Int. Panics if the size is zero.
+// Get the perpetual position quantum size in big.Int.
 func (m *PerpetualPosition) GetBigQuantums() *big.Int {
-	if m == nil {
+	if m == nil || m.Quantums.IsNil() {
 		return new(big.Int)
 	}
 
-	if m.Quantums.Sign() == 0 {
-		panic(errorsmod.Wrapf(
-			ErrPerpPositionZeroQuantum,
-			"perpetual position (perpetual Id: %v) has zero quantum",
-			m.PerpetualId,
-		))
-	}
-
 	return m.Quantums.BigInt()
 }
 

diff --git a/protocol/x/subaccounts/types/position_size_test.go b/protocol/x/subaccounts/types/position_size_test.go
@@ -1,7 +1,6 @@
 package types_test
 
 import (
-	errorsmod "cosmossdk.io/errors"
 	"math/big"
 	"testing"
 
@@ -43,14 +42,8 @@ func TestPerpetualPosition_GetIsLong(t *testing.T) {
 	require.True(t,
 		longPosition.GetIsLong(),
 	)
-	require.PanicsWithError(t,
-		errorsmod.Wrapf(
-			types.ErrPerpPositionZeroQuantum,
-			"perpetual position (perpetual Id: 0) has zero quantum",
-		).Error(),
-		func() {
-			zeroPosition.GetIsLong()
-		},
+	require.False(t,
+		zeroPosition.GetIsLong(),
 	)
 	require.False(t,
 		shortPosition.GetIsLong(),
@@ -75,14 +68,8 @@ func TestAssetPosition_GetIsLong(t *testing.T) {
 	require.True(t,
 		longPosition.GetIsLong(),
 	)
-	require.PanicsWithError(t,
-		errorsmod.Wrapf(
-			types.ErrAssetPositionZeroQuantum,
-			"asset position (asset Id: 0) has zero quantum",
-		).Error(),
-		func() {
-			zeroPosition.GetIsLong()
-		},
+	require.False(t,
+		zeroPosition.GetIsLong(),
 	)
 	require.False(t,
 		shortPosition.GetIsLong(),