Migrate more logs to new logging lib, add lib.UnwrapSDKContext (#1003)

* migrate memclob file logs * more error log migration * migrate all k.Logger() to new logger lib * Introduce lib.UnwrapSDKContext that adds log tags * add the epoch event back, removed accidentally * fix delay message tests * lint
dydxprotocol · Jan 23, 2024 · 5ee11ed · 5ee11ed
1 parent 0f87843
commit 5ee11ed
Show file tree

Hide file tree

Showing 52 changed files with 364 additions and 223 deletions.
diff --git a/protocol/lib/context.go b/protocol/lib/context.go
@@ -1,12 +1,35 @@
 package lib
 
 import (
+	"context"
 	"fmt"
+
 	"github.com/cometbft/cometbft/crypto/tmhash"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib/log"
 )
 
 type TxHash string
 
 func GetTxHash(tx []byte) TxHash {
 	return TxHash(fmt.Sprintf("%X", tmhash.Sum(tx)))
 }
+
+// UnwrapSDKContext is a thin wrapper around cosmos sdk's unwrap function
+// that extracts the cosmos context from the standard golang context.
+// If moduleName is provided, it appends the persistent log tag with
+// the module name to the logger in the context.
+func UnwrapSDKContext(
+	goCtx context.Context,
+	moduleName string,
+) sdk.Context {
+	ctx := sdk.UnwrapSDKContext(goCtx)
+	if moduleName != "" {
+		ctx = log.AddPersistentTagsToLogger(
+			ctx,
+			log.Module,
+			fmt.Sprintf("x/%s", moduleName),
+		)
+	}
+	return ctx
+}
diff --git a/protocol/lib/log/constants.go b/protocol/lib/log/constants.go
@@ -9,15 +9,19 @@ const (
 // Do not have anything generic in here. For example, `Status` is too vague
 // and can be clarified as `OrderStatus` or `DaemonHealthStatus`.
 const (
+	Address             = "address"
 	Module              = "module"
 	TxMode              = "tx_mode"
+	Operation           = "operation"
 	OperationsQueue     = "operations_queue"
 	Callback            = "callback"
 	BlockHeight         = "block_height"
 	Msg                 = "msg"
 	ProposerConsAddress = "proposer_cons_address"
 	Handler             = "handler"
 	Tx                  = "tx"
+	Order               = "order"
+	OrderId             = "order_id"
 	OrderHash           = "order_hash"
 	OrderStatus         = "order_status"
 	Subaccount          = "subaccount"
@@ -26,6 +30,7 @@ const (
 	StackTrace          = "stack_trace"
 	Proposer            = "proposer"
 	PrunableBlockHeight = "prunable_block_height"
+	StatusCode          = "status_code"
 
 	OrderSizeOptimisticallyFilledFromMatchingQuantums = "order_size_optimistically_filled_from_matching_quantums"
 	NewLocalValidatorOperationsQueue                  = "new_local_validator_operations_queue"

diff --git a/protocol/x/assets/types/genesis.go b/protocol/x/assets/types/genesis.go
@@ -1,8 +1,6 @@
 package types
 
-import (
-	"github.com/dydxprotocol/v4-chain/protocol/lib"
-)
+import "github.com/dydxprotocol/v4-chain/protocol/lib"
 
 const (
 	// UusdcDenom is the precomputed denom for IBC Micro USDC.

diff --git a/protocol/x/clob/keeper/final_settlement.go b/protocol/x/clob/keeper/final_settlement.go
@@ -5,6 +5,7 @@ import (
 	indexerevents "github.com/dydxprotocol/v4-chain/protocol/indexer/events"
 	"github.com/dydxprotocol/v4-chain/protocol/indexer/indexer_manager"
 	indexershared "github.com/dydxprotocol/v4-chain/protocol/indexer/shared"
+	"github.com/dydxprotocol/v4-chain/protocol/lib/log"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
@@ -29,11 +30,14 @@ func (k Keeper) mustCancelStatefulOrdersForFinalSettlement(ctx sdk.Context, clob
 	// rather than halt the chain.
 	removeStatefulOrderWithoutPanicing := func(ctx sdk.Context, orderId types.OrderId) {
 		defer func() {
-			if r := recover(); r != nil {
-				k.Logger(ctx).Error(
-					"mustCancelStatefulOrdersForFinalSettlement: Failed to remove stateful order with OrderId %+v: %v",
+			if err := recover(); err != nil {
+				log.ErrorLog(
+					ctx,
+					"mustCancelStatefulOrdersForFinalSettlement: Failed to remove stateful order",
+					"orderId",
 					orderId,
-					r,
+					"error",
+					err,
 				)
 			}
 		}()

diff --git a/protocol/x/clob/keeper/grpc_query_block_rate_limit_configuration.go b/protocol/x/clob/keeper/grpc_query_block_rate_limit_configuration.go
@@ -2,7 +2,8 @@ package keeper
 
 import (
 	"context"
-	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -16,7 +17,7 @@ func (k Keeper) BlockRateLimitConfiguration(
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
 
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 	blockRateLimitConfig := k.GetBlockRateLimitConfiguration(ctx)
 
 	return &types.QueryBlockRateLimitConfigurationResponse{

diff --git a/protocol/x/clob/keeper/grpc_query_clob_pair.go b/protocol/x/clob/keeper/grpc_query_clob_pair.go
@@ -4,8 +4,8 @@ import (
 	"context"
 
 	"cosmossdk.io/store/prefix"
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/cosmos/cosmos-sdk/types/query"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -20,7 +20,7 @@ func (k Keeper) ClobPairAll(
 	}
 
 	var clobPairs []types.ClobPair
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 
 	store := ctx.KVStore(k.storeKey)
 	clobPairStore := prefix.NewStore(store, []byte(types.ClobPairKeyPrefix))
@@ -46,7 +46,7 @@ func (k Keeper) ClobPair(c context.Context, req *types.QueryGetClobPairRequest)
 	if req == nil {
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 
 	val, found := k.GetClobPair(
 		ctx,

diff --git a/protocol/x/clob/keeper/grpc_query_equity_tier_limit_config.go b/protocol/x/clob/keeper/grpc_query_equity_tier_limit_config.go
@@ -5,7 +5,7 @@ import (
 
 	"google.golang.org/grpc/status"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	"google.golang.org/grpc/codes"
 )
@@ -17,7 +17,7 @@ func (k Keeper) EquityTierLimitConfiguration(
 	if req == nil {
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 
 	return &types.QueryEquityTierLimitConfigurationResponse{
 		EquityTierLimitConfig: k.GetEquityTierLimitConfiguration(ctx),

diff --git a/protocol/x/clob/keeper/grpc_query_liquidations_configuration.go b/protocol/x/clob/keeper/grpc_query_liquidations_configuration.go
@@ -2,7 +2,8 @@ package keeper
 
 import (
 	"context"
-	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	"google.golang.org/grpc/codes"
 	"google.golang.org/grpc/status"
@@ -17,7 +18,7 @@ func (k Keeper) LiquidationsConfiguration(
 		return nil, status.Error(codes.InvalidArgument, "invalid request")
 	}
 
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 	liquidationsConfig := k.GetLiquidationsConfig(ctx)
 	return &types.QueryLiquidationsConfigurationResponse{
 		LiquidationsConfig: liquidationsConfig,

diff --git a/protocol/x/clob/keeper/grpc_query_mev_node_to_node.go b/protocol/x/clob/keeper/grpc_query_mev_node_to_node.go
@@ -5,6 +5,7 @@ import (
 	"math/big"
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/lib/log"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	"google.golang.org/grpc/codes"
@@ -18,7 +19,7 @@ func (k Keeper) MevNodeToNodeCalculation(
 	*types.MevNodeToNodeCalculationResponse,
 	error,
 ) {
-	ctx := sdk.UnwrapSDKContext(c)
+	ctx := lib.UnwrapSDKContext(c, types.ModuleName)
 
 	// Validate that the request is valid.
 	if err := validateMevNodeToNodeRequest(req); err != nil {

diff --git a/protocol/x/clob/keeper/mev.go b/protocol/x/clob/keeper/mev.go
@@ -68,6 +68,11 @@ func (k Keeper) RecordMevMetrics(
 	perpetualKeeper process.ProcessPerpetualKeeper,
 	msgProposedOperations *types.MsgProposedOperations,
 ) {
+	ctx = log.AddPersistentTagsToLogger(
+		ctx,
+		log.Module,
+		"x/clob/mev_telemetry",
+	)
 	defer metrics.ModuleMeasureSince(
 		types.ModuleName,
 		metrics.MevLatency,

diff --git a/protocol/x/clob/keeper/msg_server_cancel_orders.go b/protocol/x/clob/keeper/msg_server_cancel_orders.go
@@ -22,7 +22,7 @@ func (k msgServer) CancelOrder(
 	goCtx context.Context,
 	msg *types.MsgCancelOrder,
 ) (resp *types.MsgCancelOrderResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	// Attach various logging tags relative to this request. These should be static with no changes.
 	ctx = log.AddPersistentTagsToLogger(ctx,

diff --git a/protocol/x/clob/keeper/msg_server_create_clob_pair.go b/protocol/x/clob/keeper/msg_server_create_clob_pair.go
@@ -5,8 +5,8 @@ import (
 
 	errorsmod "cosmossdk.io/errors"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 	satypes "github.com/dydxprotocol/v4-chain/protocol/x/subaccounts/types"
 )
@@ -16,7 +16,7 @@ func (k msgServer) CreateClobPair(
 	goCtx context.Context,
 	msg *types.MsgCreateClobPair,
 ) (resp *types.MsgCreateClobPairResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	if !k.Keeper.HasAuthority(msg.Authority) {
 		return nil, errorsmod.Wrapf(

diff --git a/protocol/x/clob/keeper/msg_server_place_order.go b/protocol/x/clob/keeper/msg_server_place_order.go
@@ -23,7 +23,7 @@ func (k msgServer) PlaceOrder(goCtx context.Context, msg *types.MsgPlaceOrder) (
 	resp *types.MsgPlaceOrderResponse,
 	err error,
 ) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	// Attach various logging tags relative to this request. These should be static with no changes.
 	ctx = log.AddPersistentTagsToLogger(ctx,

diff --git a/protocol/x/clob/keeper/msg_server_proposed_operations.go b/protocol/x/clob/keeper/msg_server_proposed_operations.go
@@ -14,7 +14,7 @@ func (k msgServer) ProposedOperations(
 	goCtx context.Context,
 	msg *types.MsgProposedOperations,
 ) (resp *types.MsgProposedOperationsResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	// Attach various logging tags relative to this request. These should be static with no changes.
 	ctx = log.AddPersistentTagsToLogger(ctx,

diff --git a/protocol/x/clob/keeper/msg_server_update_block_rate_limit_config.go b/protocol/x/clob/keeper/msg_server_update_block_rate_limit_config.go
@@ -4,8 +4,8 @@ import (
 	"context"
 
 	errorsmod "cosmossdk.io/errors"
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
@@ -15,7 +15,7 @@ func (k msgServer) UpdateBlockRateLimitConfiguration(
 	goCtx context.Context,
 	msg *types.MsgUpdateBlockRateLimitConfiguration,
 ) (resp *types.MsgUpdateBlockRateLimitConfigurationResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	if !k.Keeper.HasAuthority(msg.Authority) {
 		return nil, errorsmod.Wrapf(

diff --git a/protocol/x/clob/keeper/msg_server_update_clob_pair.go b/protocol/x/clob/keeper/msg_server_update_clob_pair.go
@@ -5,16 +5,16 @@ import (
 
 	errorsmod "cosmossdk.io/errors"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
 func (k msgServer) UpdateClobPair(
 	goCtx context.Context,
 	msg *types.MsgUpdateClobPair,
 ) (resp *types.MsgUpdateClobPairResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	if !k.Keeper.HasAuthority(msg.Authority) {
 		return nil, errorsmod.Wrapf(

diff --git a/protocol/x/clob/keeper/msg_server_update_equity_tier_limit_config.go b/protocol/x/clob/keeper/msg_server_update_equity_tier_limit_config.go
@@ -4,8 +4,8 @@ import (
 	"context"
 
 	errorsmod "cosmossdk.io/errors"
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
@@ -15,7 +15,7 @@ func (k msgServer) UpdateEquityTierLimitConfiguration(
 	goCtx context.Context,
 	msg *types.MsgUpdateEquityTierLimitConfiguration,
 ) (resp *types.MsgUpdateEquityTierLimitConfigurationResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	if !k.Keeper.HasAuthority(msg.Authority) {
 		return nil, errorsmod.Wrapf(

diff --git a/protocol/x/clob/keeper/msg_server_update_liquidations_config.go b/protocol/x/clob/keeper/msg_server_update_liquidations_config.go
@@ -5,8 +5,8 @@ import (
 
 	errorsmod "cosmossdk.io/errors"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	govtypes "github.com/cosmos/cosmos-sdk/x/gov/types"
+	"github.com/dydxprotocol/v4-chain/protocol/lib"
 	"github.com/dydxprotocol/v4-chain/protocol/x/clob/types"
 )
 
@@ -15,7 +15,7 @@ func (k msgServer) UpdateLiquidationsConfig(
 	goCtx context.Context,
 	msg *types.MsgUpdateLiquidationsConfig,
 ) (resp *types.MsgUpdateLiquidationsConfigResponse, err error) {
-	ctx := sdk.UnwrapSDKContext(goCtx)
+	ctx := lib.UnwrapSDKContext(goCtx, types.ModuleName)
 
 	if !k.Keeper.HasAuthority(msg.Authority) {
 		return nil, errorsmod.Wrapf(