[TRA-572] Add upsert vault event.

proto/dydxprotocol/indexer/events/events.proto

@@ -7,6 +7,7 @@ import "dydxprotocol/indexer/shared/removal_reason.proto";
 import "dydxprotocol/indexer/protocol/v1/clob.proto";
 import "dydxprotocol/indexer/protocol/v1/perpetual.proto";
 import "dydxprotocol/indexer/protocol/v1/subaccount.proto";
+import "dydxprotocol/indexer/protocol/v1/vault.proto";
 
 option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/events";
 
@@ -590,3 +591,15 @@ message RegisterAffiliateEventV1 {
   // Address of the affiliate associated with the referee.
   string affiliate = 2 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
 }
+
+// Event emitted when a vault is created / updated.
+message UpsertVaultEventV1 {
+  // Address of the vault.
+  string address = 1 [ (cosmos_proto.scalar) = "cosmos.AddressString" ];
+
+  // Clob pair Id associated with the vault.
+  uint32 clob_pair_id = 2;
+
+  // Status of the vault.
+  dydxprotocol.indexer.protocol.v1.VaultStatus status = 3;
+}

proto/dydxprotocol/indexer/protocol/v1/vault.proto

@@ -0,0 +1,27 @@
+syntax = "proto3";
+package dydxprotocol.indexer.protocol.v1;
+
+option go_package = "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1/types";
+
+// Initial copy of protos from dYdX chain application state protos for the
+// vault module for use to send Indexer specific messages. Do not make any
+// breaking changes to these protos, a new version should be created if a
+// breaking change is needed.
+
+// VaultStatus represents the status of a vault.
+enum VaultStatus {
+  // Default value, invalid and unused.
+  VAULT_STATUS_UNSPECIFIED = 0;
+
+  // Don’t place orders. Does not count toward global vault balances.
+  VAULT_STATUS_DEACTIVATED = 1;
+
+  // Don’t place orders. Does count towards global vault balances.
+  VAULT_STATUS_STAND_BY = 2;
+
+  // Places orders on both sides of the book.
+  VAULT_STATUS_QUOTING = 3;
+
+  // Only place orders that close the position.
+  VAULT_STATUS_CLOSE_ONLY = 4;
+}

protocol/indexer/events/upsert_vault.go

@@ -0,0 +1,21 @@
+package events
+
+import (
+	v1 "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1"
+	clobtypes "github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
+	"github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
+)
+
+// NewUpsertVaultEvent creates a UpsertVaultEventV1
+// representing an create / update of a vault.
+func NewUpsertVaultEvent(
+	vaultAddress string,
+	clobPairId clobtypes.ClobPairId,
+	status types.VaultStatus,
+) *UpsertVaultEventV1 {
+	return &UpsertVaultEventV1{
+		Address:    vaultAddress,
+		ClobPairId: uint32(clobPairId),
+		Status:     v1.VaultStatusToIndexerVaultStatus(status),
+	}
+}

protocol/indexer/events/upsert_vault_test.go

@@ -0,0 +1,26 @@
+package events_test
+
+import (
+	"testing"
+
+	"github.com/dydxprotocol/v4-chain/protocol/indexer/events"
+	v1types "github.com/dydxprotocol/v4-chain/protocol/indexer/protocol/v1/types"
+	"github.com/dydxprotocol/v4-chain/protocol/testutil/constants"
+	vaulttypes "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestNewUpsertVaultEvent_Success(t *testing.T) {
+	upsertVaultEvent := events.NewUpsertVaultEvent(
+		constants.Alice_Num0.Owner,
+		0,
+		vaulttypes.VaultStatus_VAULT_STATUS_QUOTING,
+	)
+	expectedUpsertVaultEventProto := &events.UpsertVaultEventV1{
+		Address:    constants.Alice_Num0.Owner,
+		ClobPairId: 0,
+		Status:     v1types.VaultStatus_VAULT_STATUS_QUOTING,
+	}
+	require.Equal(t, expectedUpsertVaultEventProto, upsertVaultEvent)
+}

protocol/indexer/protocol/v1/v1_mappers.go

@@ -8,6 +8,7 @@ import (
 	clobtypes "github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	perptypes "github.com/dydxprotocol/v4-chain/protocol/x/perpetuals/types"
 	satypes "github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
+	vaulttypes "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
 )
 
 func SubaccountIdToIndexerSubaccountId(
@@ -205,3 +206,7 @@ func ConvertToPerpetualMarketType(marketType perptypes.PerpetualMarketType) v1ty
 		)
 	}
 }
+
+func VaultStatusToIndexerVaultStatus(vaultStatus vaulttypes.VaultStatus) v1types.VaultStatus {
+	return v1types.VaultStatus(vaultStatus)
+}

protocol/indexer/protocol/v1/v1_mappers_test.go

@@ -11,6 +11,7 @@ import (
 	clobtypes "github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	perptypes "github.com/dydxprotocol/v4-chain/protocol/x/perpetuals/types"
 	satypes "github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
+	vaulttypes "github.com/dydxprotocol/v4-chain/protocol/x/vault/types"
 	"github.com/stretchr/testify/require"
 )
 
@@ -473,3 +474,33 @@ func TestConvertToPerpetualMarketType(t *testing.T) {
 		})
 	}
 }
+
+func TestVaultStatusToVaultStatus(t *testing.T) {
+	tests := map[string]struct {
+		// Input
+		vaultStatus vaulttypes.VaultStatus
+
+		// Expectations
+		expectedVaultStatus v1types.VaultStatus
+	}{}
+	// Iterate through all the values for VaultStatus to create test cases.
+	for name, value := range vaulttypes.VaultStatus_value {
+		testName := fmt.Sprintf("Converts VaultStatus %s to IndexerVaultStatus", name)
+		tests[testName] = struct {
+			vaultStatus         vaulttypes.VaultStatus
+			expectedVaultStatus v1types.VaultStatus
+		}{
+			vaultStatus:         vaulttypes.VaultStatus(value),
+			expectedVaultStatus: v1types.VaultStatus(v1types.VaultStatus_value[name]),
+		}
+	}
+	for name, tc := range tests {
+		t.Run(name, func(t *testing.T) {
+			require.Equal(
+				t,
+				tc.expectedVaultStatus,
+				v1.VaultStatusToIndexerVaultStatus(tc.vaultStatus),
+			)
+		})
+	}
+}