Merge pull request #628 from UnUniFi/feature/withdraw-margin

Impl WithdrawMargin message

proto/ununifi/derivatives/tx.proto

@@ -18,6 +18,7 @@ service Msg {
   rpc ReportLiquidation(MsgReportLiquidation) returns (MsgReportLiquidationResponse);
   rpc ReportLevyPeriod(MsgReportLevyPeriod) returns (MsgReportLevyPeriodResponse);
   rpc AddMargin(MsgAddMargin) returns (MsgAddMarginResponse);
+  rpc WithdrawMargin(MsgWithdrawMargin) returns (MsgWithdrawMarginResponse);
 }
 
 message MsgDepositToPool {
@@ -79,3 +80,11 @@ message MsgAddMargin {
 }
 
 message MsgAddMarginResponse {}
+
+message MsgWithdrawMargin {
+  string                   sender = 1 [(gogoproto.moretags) = "yaml:\"sender\""];
+  cosmos.base.v1beta1.Coin amount = 2 [(gogoproto.moretags) = "yaml:\"amount\"", (gogoproto.nullable) = false];
+  string                   position_id = 3 [(gogoproto.moretags) = "yaml:\"position_id\""];
+}
+
+message MsgWithdrawMarginResponse {}

scripts/commands/derivatives/msgs.sh

@@ -32,6 +32,12 @@ $BINARY tx derivatives withdraw-from-pool 1 ubtc --from=$USER1 $conf | jq .raw_l
 $BINARY tx derivatives open-position perpetual-futures 100ubtc ubtc uusdc long --from=$USER1 $conf | jq .raw_log | sed 's/\\n/\n/g'
 $BINARY tx derivatives open-position perpetual-futures 100uusdc ubtc uusdc short --from=$USER1 $conf | jq .raw_log | sed 's/\\n/\n/g'
 
+# add-margin 
+$BINARY tx derivatives add-margin 1 100ubtc --from=$USER1 $conf | jq .raw_log | sed 's/\\n/\n/g'
+
+# withdraw-margin
+$BINARY tx derivatives withdraw-margin 1 100ubtc --from=$USER1 $conf | jq .raw_log | sed 's/\\n/\n/g'
+
 # query positions
 $BINARY q derivatives positions $USER_ADDRESS_1
 

x/derivatives/keeper/margin.go

@@ -50,6 +50,50 @@ func (k Keeper) AddMargin(ctx sdk.Context, sender sdk.AccAddress, positionId str
 	return nil
 }
 
+func (k Keeper) WithdrawMargin(ctx sdk.Context, withdrawer sdk.AccAddress, positionId string, amount sdk.Coin) error {
+	position := k.GetPositionWithId(ctx, positionId)
+	if position == nil {
+		return types.ErrPositionDoesNotExist
+	}
+
+	// Check withdrawer (sender) matches the owner of the position
+	if position.Address != withdrawer.String() {
+		return types.ErrUnauthorized
+	}
+
+	// Update RemainingMargin
+	position.RemainingMargin = position.RemainingMargin.Sub(amount)
+
+	// Check if the updated margin is positive
+	if position.RemainingMargin.IsNegative() {
+		return types.ErrNegativeMargin
+	}
+
+	// Check if the updated margin is not under liquidation
+	params := k.GetParams(ctx)
+	currentBaseUsdRate, currentQuoteUsdRate, err := k.GetPairUsdPriceFromMarket(ctx, position.Market)
+	if err != nil {
+		return err
+	}
+	quoteTicker := k.GetPoolQuoteTicker(ctx)
+	baseMetricsRate := types.NewMetricsRateType(quoteTicker, position.Market.BaseDenom, currentBaseUsdRate)
+	quoteMetricsRate := types.NewMetricsRateType(quoteTicker, position.Market.QuoteDenom, currentQuoteUsdRate)
+
+	if position.NeedLiquidation(params.PerpetualFutures.MarginMaintenanceRate, baseMetricsRate, quoteMetricsRate) {
+		// Return err as the result of this tx
+		return types.ErrTooMuchMarginToWithdraw
+	}
+
+	// Send margin from the margin manager module account to the withdrawer
+	if err := k.SendBackMargin(ctx, withdrawer, sdk.NewCoins(amount)); err != nil {
+		return err
+	}
+
+	k.SetPosition(ctx, *position)
+
+	return nil
+}
+
 func (k Keeper) SendMarginToMarginManager(ctx sdk.Context, sender sdk.AccAddress, margin sdk.Coins) error {
 	return k.bankKeeper.SendCoinsFromAccountToModule(ctx, sender, types.MarginManager, margin)
 }

x/derivatives/keeper/margin_test.go

@@ -1 +1,7 @@
 package keeper_test
+
+// TODO: Impl unit test
+// func (suite *KeeperTestSuite) TestAddMargin() {}
+
+// TODO: Impl unit test
+// func (suite *KeeperTestSuite) TestWithdrawMargin() {}

x/derivatives/keeper/msg_server.go

@@ -91,3 +91,14 @@ func (k msgServer) AddMargin(c context.Context, msg *types.MsgAddMargin) (*types
 
 	return &types.MsgAddMarginResponse{}, nil
 }
+
+func (k msgServer) WithdrawMargin(c context.Context, msg *types.MsgWithdrawMargin) (*types.MsgWithdrawMarginResponse, error) {
+	ctx := sdk.UnwrapSDKContext(c)
+
+	err := k.Keeper.WithdrawMargin(ctx, sdk.AccAddress(msg.Sender), msg.PositionId, msg.Amount)
+	if err != nil {
+		return nil, err
+	}
+
+	return &types.MsgWithdrawMarginResponse{}, nil
+}

x/derivatives/types/errors.go

@@ -25,4 +25,6 @@ var (
 	ErrPositionDoesNotExist     = sdkerrors.Register(ModuleName, 15, "position does not exist")
 	ErrLiquidationNotNeeded     = sdkerrors.Register(ModuleName, 16, "liquidation is not needed")
 	ErrLiquidationNeeded        = sdkerrors.Register(ModuleName, 17, "liquidation is needed")
+	ErrUnauthorized             = sdkerrors.Register(ModuleName, 18, "unauthorized")
+	ErrTooMuchMarginToWithdraw  = sdkerrors.Register(ModuleName, 19, "too much margin to withdraw")
 )

x/derivatives/types/msgs.go

@@ -176,3 +176,29 @@ func (msg MsgAddMargin) GetSigners() []sdk.AccAddress {
 	addr, _ := sdk.AccAddressFromBech32(msg.Sender)
 	return []sdk.AccAddress{addr}
 }
+
+var _ sdk.Msg = &MsgWithdrawMargin{}
+
+func NewMsgWithdrawMargin(sender string, positionId string, amount sdk.Coin) MsgWithdrawMargin {
+	return MsgWithdrawMargin{
+		Sender:     sender,
+		PositionId: positionId,
+		Amount:     amount,
+	}
+}
+
+// ValidateBasic does a simple validation check that doesn't require access to state.
+func (msg MsgWithdrawMargin) ValidateBasic() error {
+	_, err := sdk.AccAddressFromBech32(msg.Sender)
+	if err != nil {
+		return sdkerrors.Wrap(sdkerrors.ErrInvalidAddress, "sender address is not valid")
+	}
+
+	return nil
+}
+
+// GetSigners returns the addresses of signers that must sign.
+func (msg MsgWithdrawMargin) GetSigners() []sdk.AccAddress {
+	addr, _ := sdk.AccAddressFromBech32(msg.Sender)
+	return []sdk.AccAddress{addr}
+}