return mintedShares in vault deposit keeper method (#2139)

indexer/packages/v4-protos/src/codegen/dydxprotocol/vault/tx.ts

@@ -1,6 +1,7 @@
 import { SubaccountId, SubaccountIdSDKType } from "../subaccounts/subaccount";
 import { QuotingParams, QuotingParamsSDKType, VaultParams, VaultParamsSDKType } from "./params";
 import { VaultId, VaultIdSDKType } from "./vault";
+import { NumShares, NumSharesSDKType } from "./share";
 import * as _m0 from "protobufjs/minimal";
 import { DeepPartial } from "../../helpers";
 /**
@@ -29,10 +30,16 @@ export interface MsgDepositToMegavaultSDKType {
 }
 /** MsgDepositToMegavaultResponse is the Msg/DepositToMegavault response type. */
 
-export interface MsgDepositToMegavaultResponse {}
+export interface MsgDepositToMegavaultResponse {
+  /** The number of shares minted from the deposit. */
+  mintedShares?: NumShares;
+}
 /** MsgDepositToMegavaultResponse is the Msg/DepositToMegavault response type. */
 
-export interface MsgDepositToMegavaultResponseSDKType {}
+export interface MsgDepositToMegavaultResponseSDKType {
+  /** The number of shares minted from the deposit. */
+  minted_shares?: NumSharesSDKType;
+}
 /**
  * MsgUpdateDefaultQuotingParams is the Msg/UpdateDefaultQuotingParams request
  * type.
@@ -152,11 +159,17 @@ export const MsgDepositToMegavault = {
 };
 
 function createBaseMsgDepositToMegavaultResponse(): MsgDepositToMegavaultResponse {
-  return {};
+  return {
+    mintedShares: undefined
+  };
 }
 
 export const MsgDepositToMegavaultResponse = {
-  encode(_: MsgDepositToMegavaultResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+  encode(message: MsgDepositToMegavaultResponse, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
+    if (message.mintedShares !== undefined) {
+      NumShares.encode(message.mintedShares, writer.uint32(10).fork()).ldelim();
+    }
+
     return writer;
   },
 
@@ -169,6 +182,10 @@ export const MsgDepositToMegavaultResponse = {
       const tag = reader.uint32();
 
       switch (tag >>> 3) {
+        case 1:
+          message.mintedShares = NumShares.decode(reader, reader.uint32());
+          break;
+
         default:
           reader.skipType(tag & 7);
           break;
@@ -178,8 +195,9 @@ export const MsgDepositToMegavaultResponse = {
     return message;
   },
 
-  fromPartial(_: DeepPartial<MsgDepositToMegavaultResponse>): MsgDepositToMegavaultResponse {
+  fromPartial(object: DeepPartial<MsgDepositToMegavaultResponse>): MsgDepositToMegavaultResponse {
     const message = createBaseMsgDepositToMegavaultResponse();
+    message.mintedShares = object.mintedShares !== undefined && object.mintedShares !== null ? NumShares.fromPartial(object.mintedShares) : undefined;
     return message;
   }
 

proto/dydxprotocol/vault/tx.proto

@@ -5,6 +5,7 @@ import "cosmos_proto/cosmos.proto";
 import "cosmos/msg/v1/msg.proto";
 import "dydxprotocol/subaccounts/subaccount.proto";
 import "dydxprotocol/vault/params.proto";
+import "dydxprotocol/vault/share.proto";
 import "dydxprotocol/vault/vault.proto";
 import "gogoproto/gogo.proto";
 
@@ -44,7 +45,10 @@ message MsgDepositToMegavault {
 }
 
 // MsgDepositToMegavaultResponse is the Msg/DepositToMegavault response type.
-message MsgDepositToMegavaultResponse {}
+message MsgDepositToMegavaultResponse {
+  // The number of shares minted from the deposit.
+  NumShares minted_shares = 1 [ (gogoproto.nullable) = false ];
+}
 
 // MsgUpdateDefaultQuotingParams is the Msg/UpdateDefaultQuotingParams request
 // type.

protocol/x/vault/keeper/deposit.go

@@ -4,20 +4,60 @@ import (
 	"math/big"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	assettypes "github.com/dydxprotocol/v4-chain/protocol/x/assets/types"
+	sendingtypes "github.com/dydxprotocol/v4-chain/protocol/x/sending/types"
+	satypes "github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
 	"github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
 )
 
+// DepositToMegavault deposits from a subaccount to megavault by
+// 1. Minting shares for owner address of `fromSubaccount`.
+// 2. Transferring `quoteQuantums` from `fromSubaccount` to megavault subaccount 0.
+func (k Keeper) DepositToMegavault(
+	ctx sdk.Context,
+	fromSubaccount satypes.SubaccountId,
+	quoteQuantums *big.Int,
+) (mintedShares *big.Int, err error) {
+	// Mint shares.
+	mintedShares, err = k.MintShares(
+		ctx,
+		fromSubaccount.Owner,
+		quoteQuantums,
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	// Transfer from sender subaccount to megavault.
+	// Note: Transfer should take place after minting shares for
+	// shares calculation to be correct.
+	err = k.sendingKeeper.ProcessTransfer(
+		ctx,
+		&sendingtypes.Transfer{
+			Sender:    fromSubaccount,
+			Recipient: types.MegavaultMainSubaccount,
+			AssetId:   assettypes.AssetUsdc.Id,
+			Amount:    quoteQuantums.Uint64(),
+		},
+	)
+	if err != nil {
+		return nil, err
+	}
+
+	return mintedShares, nil
+}
+
 // MintShares mints shares for `owner` based on `quantumsToDeposit` by:
 // 1. Increasing total shares.
 // 2. Increasing owner shares for given `owner`.
 func (k Keeper) MintShares(
 	ctx sdk.Context,
 	owner string,
 	quantumsToDeposit *big.Int,
-) error {
+) (mintedShares *big.Int, err error) {
 	// Quantums to deposit should be positive.
 	if quantumsToDeposit.Sign() <= 0 {
-		return types.ErrInvalidDepositAmount
+		return nil, types.ErrInvalidDepositAmount
 	}
 	// Get existing TotalShares of the vault.
 	existingTotalShares := k.GetTotalShares(ctx).NumShares.BigInt()
@@ -30,11 +70,11 @@ func (k Keeper) MintShares(
 		// Get megavault equity.
 		equity, err := k.GetMegavaultEquity(ctx)
 		if err != nil {
-			return err
+			return nil, err
 		}
 		// Don't mint shares if equity is non-positive.
 		if equity.Sign() <= 0 {
-			return types.ErrNonPositiveEquity
+			return nil, types.ErrNonPositiveEquity
 		}
 		// Mint `deposit (in quote quantums) * existing shares / vault equity (in quote quantums)`
 		// number of shares.
@@ -48,19 +88,19 @@ func (k Keeper) MintShares(
 
 		// Return error if `sharesToMint` is rounded down to 0.
 		if sharesToMint.Sign() == 0 {
-			return types.ErrZeroSharesToMint
+			return nil, types.ErrZeroSharesToMint
 		}
 	}
 
 	// Increase total shares.
-	err := k.SetTotalShares(
+	err = k.SetTotalShares(
 		ctx,
 		types.BigIntToNumShares(
 			existingTotalShares.Add(existingTotalShares, sharesToMint),
 		),
 	)
 	if err != nil {
-		return err
+		return nil, err
 	}
 
 	// Increase owner shares.
@@ -73,7 +113,7 @@ func (k Keeper) MintShares(
 			types.BigIntToNumShares(sharesToMint),
 		)
 		if err != nil {
-			return err
+			return nil, err
 		}
 	} else {
 		// Increase existing owner shares by sharesToMint.
@@ -86,9 +126,9 @@ func (k Keeper) MintShares(
 			),
 		)
 		if err != nil {
-			return err
+			return nil, err
 		}
 	}
 
-	return nil
+	return sharesToMint, nil
 }

protocol/x/vault/keeper/deposit_test.go

@@ -184,14 +184,15 @@ func TestMintShares(t *testing.T) {
 			}
 
 			// Mint shares.
-			err = tApp.App.VaultKeeper.MintShares(
+			mintedShares, err := tApp.App.VaultKeeper.MintShares(
 				ctx,
 				tc.owner,
 				tc.quantumsToDeposit,
 			)
 			if tc.expectedErr != nil {
 				// Check that error is as expected.
 				require.ErrorContains(t, err, tc.expectedErr.Error())
+				require.Nil(t, mintedShares)
 				// Check that TotalShares is unchanged.
 				totalShares := tApp.App.VaultKeeper.GetTotalShares(ctx)
 				require.Equal(
@@ -204,6 +205,12 @@ func TestMintShares(t *testing.T) {
 				require.Equal(t, vaulttypes.BigIntToNumShares(tc.ownerShares), ownerShares)
 			} else {
 				require.NoError(t, err)
+				// Check that minted shares is as expected.
+				require.Equal(
+					t,
+					new(big.Int).Sub(tc.expectedTotalShares, tc.totalShares),
+					mintedShares,
+				)
 				// Check that TotalShares is as expected.
 				totalShares := tApp.App.VaultKeeper.GetTotalShares(ctx)
 				require.Equal(

protocol/x/vault/keeper/msg_server_deposit_to_megavault.go

@@ -4,8 +4,6 @@ import (
 	"context"
 
 	"github.com/dydxprotocol/v4-chain/protocol/lib"
-	assettypes "github.com/dydxprotocol/v4-chain/protocol/x/assets/types"
-	sendingtypes "github.com/dydxprotocol/v4-chain/protocol/x/sending/types"
 	"github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
 )
 
@@ -17,31 +15,16 @@ func (k msgServer) DepositToMegavault(
 	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 	quoteQuantums := msg.QuoteQuantums.BigInt()
 
-	// Mint shares.
-	err := k.MintShares(
+	mintedShares, err := k.Keeper.DepositToMegavault(
 		ctx,
-		msg.SubaccountId.Owner,
+		*msg.SubaccountId,
 		quoteQuantums,
 	)
 	if err != nil {
 		return nil, err
 	}
 
-	// Transfer from sender subaccount to megavault.
-	// Note: Transfer should take place after minting shares for
-	// shares calculation to be correct.
-	err = k.sendingKeeper.ProcessTransfer(
-		ctx,
-		&sendingtypes.Transfer{
-			Sender:    *msg.SubaccountId,
-			Recipient: types.MegavaultMainSubaccount,
-			AssetId:   assettypes.AssetUsdc.Id,
-			Amount:    quoteQuantums.Uint64(),
-		},
-	)
-	if err != nil {
-		return nil, err
-	}
-
-	return &types.MsgDepositToMegavaultResponse{}, nil
+	return &types.MsgDepositToMegavaultResponse{
+		MintedShares: types.BigIntToNumShares(mintedShares),
+	}, nil
 }