skip-mev · nivasan1 · Jan 26, 2024 · Jan 23, 2024 · Jan 23, 2024 · Jan 24, 2024
@@ -108,17 +108,7 @@ func (h *ProposalHandler) PrepareProposalHandler() sdk.PrepareProposalHandler {
 				"slinky prepare proposal latency", (totalLatency - wrappedPrepareProposalLatency).Seconds(),
 			)
 
-			// record latency
-			h.metrics.ObserveABCIMethodLatency(servicemetrics.PrepareProposal, totalLatency-wrappedPrepareProposalLatency)
-
-			// record success/failure
-			var label servicemetrics.Labeller
-			if err != nil {
-				label, _ = err.(servicemetrics.Labeller)
-			} else {
-				label = servicemetrics.Success{}
-			}
-			h.metrics.AddABCIRequest(servicemetrics.PrepareProposal, label)
+			types.RecordLatencyAndStatus(h.metrics, totalLatency-wrappedPrepareProposalLatency, err, servicemetrics.PrepareProposal)
 		}()
 
 		if req == nil {
@@ -261,16 +251,7 @@ func (h *ProposalHandler) ProcessProposalHandler() sdk.ProcessProposalHandler {
 				"wrapped prepare proposal latency", wrappedProcessProposalLatency.Seconds(),
 				"slinky prepare proposal latency", (totalLatency - wrappedProcessProposalLatency).Seconds(),
 			)
-			h.metrics.ObserveABCIMethodLatency(servicemetrics.ProcessProposal, totalLatency-wrappedProcessProposalLatency)
-
-			// record success/failure
-			var label servicemetrics.Labeller
-			if err != nil {
-				label, _ = err.(servicemetrics.Labeller)
-			} else {
-				label = servicemetrics.Success{}
-			}
-			h.metrics.AddABCIRequest(servicemetrics.ProcessProposal, label)
+			types.RecordLatencyAndStatus(h.metrics, totalLatency-wrappedProcessProposalLatency, err, servicemetrics.ProcessProposal)
 		}()
 
 		// this should never happen, but just in case

@@ -976,7 +976,6 @@ func (s *ProposalsTestSuite) TestProposalLatency() {
 			s.Require().True(latency >= 100*time.Millisecond) // shld have included validate vote extensions latency
 			s.Require().True(latency < 300*time.Millisecond)  // shld have ignored the wrapped processProposal latency
 		}).Once()
-
 		metricsmocks.On("AddABCIRequest", servicemetrics.ProcessProposal, servicemetrics.Success{}).Once()
 		_, err = propHandler.ProcessProposalHandler()(s.ctx, req)
 		s.Require().NoError(err)
@@ -1075,7 +1074,6 @@ func (s *ProposalsTestSuite) TestPrepareProposalStatus() {
 		metricsMocks.On("AddABCIRequest", servicemetrics.PrepareProposal, expErr).Once()
 
 		metricsMocks.On("ObserveABCIMethodLatency", servicemetrics.PrepareProposal, mock.Anything).Return()
-
 		// make vote-extensions not enabled to skip validate vote extensions
 		s.ctx = s.ctx.WithBlockHeight(1)
 		s.ctx = testutils.UpdateContextWithVEHeight(s.ctx, 3)

@@ -17,6 +17,8 @@ var (
 )
 
 // VoteExtensionCodec is the interface for encoding / decoding vote extensions.
+//
+//go:generate mockery --name VoteExtensionCodec --filename vote_extension_codec.go
 type VoteExtensionCodec interface {
 	// Encode encodes the vote extension into a byte array.
 	Encode(ve vetypes.OracleVoteExtension) ([]byte, error)
@@ -26,6 +28,8 @@ type VoteExtensionCodec interface {
 }
 
 // ExtendedCommitCodec is the interface for encoding / decoding extended commit info.
+//
+//go:generate mockery --name ExtendedCommitCodec --filename extended_commit_codec.go
 type ExtendedCommitCodec interface {
 	// Encode encodes the extended commit info into a byte array.
 	Encode(cometabci.ExtendedCommitInfo) ([]byte, error)
@@ -35,6 +39,7 @@ type ExtendedCommitCodec interface {
 }
 
 // NewDefaultVoteExtensionCodec returns a new DefaultVoteExtensionCodec.
+
 func NewDefaultVoteExtensionCodec() *DefaultVoteExtensionCodec {
 	return &DefaultVoteExtensionCodec{}
 }

@@ -0,0 +1,25 @@
+package types
+
+import (
+	"time"
+
+	servicemetrics "github.com/skip-mev/slinky/service/metrics"
+)
+
+// RecordLatencyAndStatus is used by the ABCI handlers to record their e2e latency, and the status of the request
+// to their corresponding metrics objects.
+func RecordLatencyAndStatus(
+	metrics servicemetrics.Metrics, latency time.Duration, err error, method servicemetrics.ABCIMethod,
+) {
+	// observe latency
+	metrics.ObserveABCIMethodLatency(method, latency)
+
+	// increment the number of extend vote requests
+	var label servicemetrics.Labeller
+	if err != nil {
+		label, _ = err.(servicemetrics.Labeller)
+	} else {
+		label = servicemetrics.Success{}
+	}
+	metrics.AddABCIRequest(method, label)
+}
@@ -0,0 +1,71 @@
+package ve
+
+import (
+	"fmt"
+)
+
+// PreBlockError is an error that is returned when the pre-block simulation fails.
+type PreBlockError struct {
+	Err error
+}
+
+func (e PreBlockError) Error() string {
+	return fmt.Sprintf("finalize block error: %s", e.Err.Error())
+}
+
+func (e PreBlockError) Label() string {
+	return "PreBlockError"
+}
+
+// Panic is an error that is returned when a panic occurs in the ABCI handler.
+type Panic struct {
+	Err error
+}
+
+func (e Panic) Error() string {
+	return fmt.Sprintf("panic: %s", e.Err.Error())
+}
+
+func (e Panic) Label() string {
+	return "Panic"
+}
+
+// OracleClientError is an error that is returned when the oracle client's response is invalid.
+type OracleClientError struct {
+	Err error
+}
+
+func (e OracleClientError) Error() string {
+	return fmt.Sprintf("oracle client error: %s", e.Err.Error())
+}
+
+func (e OracleClientError) Label() string {
+	return "OracleClientError"
+}
+
+// TransformPricesError is an error that is returned when there is a failure in attempting to transform the prices returned
+// from the oracle server to the format expected by the validator set.
+type TransformPricesError struct {
+	Err error
+}
+
+func (e TransformPricesError) Error() string {
+	return fmt.Sprintf("prices transform error: %s", e.Err.Error())
+}
+
+func (e TransformPricesError) Label() string {
+	return "TransformPricesError"
+}
+
+// ValidateVoteExtensionError is an error that is returned when there is a failure in validating a vote extension.
+type ValidateVoteExtensionError struct {
+	Err error
+}
+
+func (e ValidateVoteExtensionError) Error() string {
+	return fmt.Sprintf("validate vote extension error: %s", e.Err.Error())
+}
+
+func (e ValidateVoteExtensionError) Label() string {
+	return "ValidateVoteExtensionError"
+}