From 42b403713b45eeca2537391144b18193da85c203 Mon Sep 17 00:00:00 2001
From: youben11 <ayoub.benaissa@zama.ai>
Date: Fri, 27 Oct 2023 11:04:20 +0100
Subject: [PATCH] feat: support registering errors from another package

this is useful in scenarios where we want to return errors expected by
the users of the package, which is often the case when integrating
fhevm-go with other blockchain frameworks
---
 fhevm/errors.go | 66 +++++++++++++++++++++++++++++++++++++++++++------
 1 file changed, 59 insertions(+), 7 deletions(-)

diff --git a/fhevm/errors.go b/fhevm/errors.go
index 4a54da4..26a5d2d 100644
--- a/fhevm/errors.go
+++ b/fhevm/errors.go
@@ -1,11 +1,63 @@
 package fhevm
 
-import (
-	"errors"
-)
-
-// List of EVM execution errors needed by the fhEVM.
-// TODO: initialize errors from erros passed by users. That would make fhevm-go errors match the EVM environment's errors.
+// List of EVM execution errors needed by the fhEVM
 var (
-	ErrExecutionReverted = errors.New("execution reverted")
+	ErrOutOfGas                    error
+	ErrCodeStoreOutOfGas           error
+	ErrDepth                       error
+	ErrInsufficientBalance         error
+	ErrContractAddressCollision    error
+	ErrExecutionReverted           error
+	ErrMaxInitCodeSizeExceeded     error
+	ErrMaxCodeSizeExceeded         error
+	ErrInvalidJump                 error
+	ErrWriteProtection             error
+	ErrReturnDataOutOfBounds       error
+	ErrGasUintOverflow             error
+	ErrInvalidCode                 error
+	ErrNonceUintOverflow           error
+	ErrAddrProhibited              error
+	ErrInvalidCoinbase             error
+	ErrSenderAddressNotAllowListed error
 )
+
+// Register package errors with other custom errors.
+//
+// This is useful in cases where returned errors need to be recognized by the framework
+// using fhevm-go, without much code changes in the framework.
+func RegisterErrors(
+	outOfGasError error,
+	codeStoreOutOfGasError error,
+	depthError error,
+	insufficientBalanceError error,
+	contractAddressCollisionError error,
+	executionRevertedError error,
+	maxInitCodeSizeExceededError error,
+	maxCodeSizeExceededError error,
+	invalidJumpError error,
+	writeProtectionError error,
+	returnDataOutOfBoundsError error,
+	gasUintOverflowError error,
+	invalidCodeError error,
+	nonceUintOverflowError error,
+	addrProhibitedError error,
+	invalidCoinbaseError error,
+	senderAddressNotAllowListedError error) {
+	ErrOutOfGas = outOfGasError
+	ErrCodeStoreOutOfGas = codeStoreOutOfGasError
+	ErrDepth = depthError
+	ErrInsufficientBalance = insufficientBalanceError
+	ErrContractAddressCollision = contractAddressCollisionError
+	ErrExecutionReverted = executionRevertedError
+	ErrMaxInitCodeSizeExceeded = maxInitCodeSizeExceededError
+	ErrMaxCodeSizeExceeded = maxCodeSizeExceededError
+	ErrInvalidJump = invalidJumpError
+	ErrWriteProtection = writeProtectionError
+	ErrReturnDataOutOfBounds = returnDataOutOfBoundsError
+	ErrGasUintOverflow = gasUintOverflowError
+	ErrInvalidCode = invalidCodeError
+	ErrNonceUintOverflow = nonceUintOverflowError
+	ErrAddrProhibited = addrProhibitedError
+	ErrInvalidCoinbase = invalidCoinbaseError
+	ErrSenderAddressNotAllowListed = senderAddressNotAllowListedError
+}