Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: error for reverted transactions #3

Merged
merged 5 commits into from
Jan 24, 2024
Merged

feat: error for reverted transactions #3

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a144a30
feat: error for reverted tx
superical Jan 23, 2024
70c9761
feat: add RpcError type
superical Jan 23, 2024
083c4f8
test: add tests for reverted tx
superical Jan 24, 2024
66cda60
refactor: error handlers
superical Jan 24, 2024
36fced5
docs: update readme
superical Jan 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 30 additions & 14 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,23 +50,39 @@ After creating the instance, you can repeatedly use the `decode` method througho
try {
// Send a transaction that will revert
} catch (err) {
const decodedError: DecodedError = errorDecoder.decode(err)
const decodedError: decodedError = await errorDecoder.decode(err)
console.log(`Revert reason: ${decodedError.reason}`)
}
```

The `DecodedError` object is the result of the decoded error, which contains the following properties for handling errors:
### Decoded Error

| Property | Value Type | Remarks |
| ----------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `ErrorType` | The type of the error. For eg, a revert due to custom error will have `ErrorType.CustomError`. |
| `reason` | `string \| null` | The decoded error message, or `null` if error is unknown or has no message. |
| `data` | `string \| null` | The raw data bytes returned from the contract error, or `null` if error is unknown or empty. |
| `args` | `Array` | The parameter values of the error if exists. For custom errors, the `args` will always be empty if no ABI or interface is supplied for decoding. |
| `name` | `string \| null` | The name of the error. This can be used to identify the custom error emitted. For eg, `InvalidTokenSwap`. If no ABI is supplied for custom error, this will be the selector hex. `null` if error is `EmptyError`. |
| `selector` | `string \| null` | The hexidecimal value of the selector. `null` if error is `EmptyError`. |
| `signature` | `string \| null` | The signature of the error. `null` if error is `EmptyError` or no specified ABI for custom error. |
| `fragment` | `string \| null` | The ABI fragment of the error. `null` if error is `EmptyError` or no specified ABI for custom error. |
The `DecodedError` object is the result of the decoded error, which contains the following properties for handling the error occurred:

| Property | Value Type | Remarks |
| ----------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `type` | `ErrorType` | The type of the error. See [Error Types](#error-types). |
| `reason` | `string \| null` | The decoded error message, or `null` if error is unknown or has no message. |
| `data` | `string \| null` | The raw data bytes returned from the contract error, or `null` if error is unknown or empty. |
| `args` | `Array` | The parameter values of the error if exists. For custom errors, the `args` will always be empty if no ABI or interface is supplied for decoding. |
| `name` | `string \| null` | The name of the error. This can be used to identify the custom error emitted. If no ABI is supplied for custom error, this will be the selector hex. If error is `RpcError`, this will be the error code. `null` if error is `EmptyError`. |
| `selector` | `string \| null` | The hexidecimal value of the selector. `null` if error is `EmptyError`. |
| `signature` | `string \| null` | The signature of the error. `null` if error is `EmptyError` or no specified ABI for custom error. |
| `fragment` | `string \| null` | The ABI fragment of the error. `null` if error is `EmptyError` or no specified ABI for custom error. |

### Error Types

These are the possible `ErrorType` that could be returned for the `type` property in the `DecodedError` object:

| Type | Description |
| --------------------------- | ----------------------------------------- |
| `ErrorType.EmptyError` | Contract reverted without reason provided |
| `ErrorType.RevertError` | Contract reverted with reason provided |
| `ErrorType.PanicError` | Contract reverted due to a panic error |
| `ErrorType.CustomError` | Contract reverted due to a custom error |
| `ErrorType.UserRejectError` | User rejected the transaction |
| `ErrorType.RpcError` | An error from the JSON RPC |
| `ErrorType.UnknownError` | An unknown error was thrown |

## Examples

Expand Down Expand Up @@ -132,7 +148,7 @@ try {
const tx = await MyCustomErrorContract.swap('0xabcd', 123)
await tx.wait()
} catch (err) {
const decodedError = errorDecoder.decode(err)
const decodedError = await errorDecoder.decode(err)
const reason = customReasonMapper(decodedError)
// Prints "Invalid swap with token contract address 0xabcd."
console.log('Custom error reason:', reason)
Expand Down Expand Up @@ -168,7 +184,7 @@ const errorDecoder = ErrorDecoder.create([myContractAbi, externalContractAbi])

try {...} catch (err) {
// It's aware of errors from MyContract, ExternalContract and ExternalContract errors emitted from MyContract.
const decodedError = errorDecoder.decode(err)
const decodedError = await errorDecoder.decode(err)
// ...
}
```
Expand Down
20 changes: 14 additions & 6 deletions contracts/MockContract.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,28 +7,36 @@ contract MockContract {
error CustomErrorNoParam();
error CustomErrorWithParams(address param1, uint256 param2);

function revertWithReason(string memory message) pure public {
uint256 public value;

function revertWithReason(string memory message) public {
value++;
revert(message);
}

function revertWithoutReason() pure public {
function revertWithoutReason() public {
value++;
revert();
}

function panicUnderflow() pure public {
function panicUnderflow() public {
value++;
uint8 num = 0;
num--;
}

function revertWithCustomErrorNoParam() pure public {
function revertWithCustomErrorNoParam() public {
value++;
revert CustomErrorNoParam();
}

function revertWithCustomErrorWithParams(address param1, uint256 param2) pure public {
function revertWithCustomErrorWithParams(address param1, uint256 param2) public {
value++;
revert CustomErrorWithParams(param1, param2);
}

function revertWithCustomNestedError(address target, uint256 param) pure public {
function revertWithCustomNestedError(address target, uint256 param) public {
value++;
MockNestedContract(target).revertNestedError(param);
}
}
Loading