reverts

type ContractRevertMetrics struct {
	// Name is the name of the contract.
	Name string `json:"name"`
	// FunctionRevertMetrics holds the revert metrics for each function in the contract.
	FunctionRevertMetrics map[string]*FunctionRevertMetrics `json:"functionRevertMetrics"`
}

type FunctionRevertMetrics struct {
	// Name is the name of the function.
	Name string `json:"name"`
	// TotalCalls is the total number of calls to the function.
	TotalCalls uint `json:"totalCalls"`
	// TotalReverts is the total number of times the function reverted.
	TotalReverts uint `json:"totalReverts"`
	// Pct is the percent of times a call to this function reverted
	Pct float64 `json:"pct"`
	// PrevPct is the percentage of total calls that reverted in the previous campaign.
	PrevPct float64 `json:"prevPct"`
	// RevertReasonMetrics holds the revert reason metrics for the function.
	RevertReasonMetrics map[string]*RevertReasonMetrics `json:"revertReasonMetrics"`
}

type RevertMetrics struct {
	// ContractRevertMetrics holds the revert metrics for each contract in the fuzzing campaign.
	ContractRevertMetrics map[string]*ContractRevertMetrics `json:"contractRevertMetrics"`
}

type RevertMetricsUpdate struct {
	// ContractName is the name of the contract which was called
	ContractName string
	// FunctionName is the name of the function which was called
	FunctionName string
	// ExecutionResult is the result of the execution
	ExecutionResult *core.ExecutionResult
}

type RevertReasonMetrics struct {
	// Reason is the revert reason.
	Reason string `json:"reason"`
	// Count is the number of times the revert reason occurred.
	Count uint `json:"count"`
	// Pct is the percentage of total calls to that resulted in the revert reason.
	Pct float64 `json:"pct"`
	// PrevPct is the percentage of total calls to that resulted in the revert reason in the previous campaign.
	PrevPct float64 `json:"prevPct"`
}

type RevertReporter struct {
	// Enabled determines if the reporter is enabled
	Enabled bool

	// Path is the path to the directory where the revert metrics and report will be stored from this campaign.
	// We will also look at this directory for the RevertMetricsArtifact from the previous campaign.
	Path string

	// CustomErrors is a map of different error IDs to their custom errors. This is used to resolve the revert reasons
	// when updating the revert metrics.
	CustomErrors map[string]abi.Error

	// RevertMetricsCh is the channel that will receive RevertMetricsUpdate objects from fuzzer workers to update the revert metrics.
	// We will be receiving pointers to the execution result object within the RevertMetricsUpdate object since we are confident that
	// will be no races on that value.
	RevertMetricsCh chan RevertMetricsUpdate

	// RevertMetrics holds the revert metrics for the current campaign.
	RevertMetrics *RevertMetrics

	// PrevRevertMetrics holds the revert metrics for the previous campaign.
	PrevRevertMetrics *RevertMetrics
}