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

Jump to bottom

Handle common cases for smart contract errors according to EIP 838 #7155

Merged
merged 8 commits into from
Sep 5, 2024
Merged

Handle common cases for smart contract errors according to EIP 838 #7155

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
c67c310
handle smart contracts errors `Error(string)` and `Panic(uint256)`
Muhammad-Altabba Jul 16, 2024
693e9ba
add tests
Muhammad-Altabba Jul 16, 2024
759a7b0
fix linting errors
Muhammad-Altabba Jul 16, 2024
53c5da2
revert an unnecessary change
Muhammad-Altabba Jul 16, 2024
b5babdb
Merge branch '4.x' into 7143-an-issue-when-calling-a-method-on-diamon…
Muhammad-Altabba Jul 17, 2024
43efc92
Merge branch '4.x' into 7143-an-issue-when-calling-a-method-on-diamon…
Muhammad-Altabba Aug 19, 2024
09b683c
update CHANGELOG.md
Muhammad-Altabba Sep 5, 2024
d446964
Merge branch '4.x' into 7143-an-issue-when-calling-a-method-on-diamon…
Muhammad-Altabba Sep 5, 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
30 changes: 30 additions & 0 deletions packages/web3-eth-abi/src/decode_contract_error_data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,36 @@
errorSignature = jsonInterfaceMethodToString(errorAbi);
// decode abi.inputs according to EIP-838
errorArgs = decodeParameters([...errorAbi.inputs], error.data.substring(10));
} else if (error.data.startsWith('0x08c379a0')) {
// If ABI was not provided, check for the 2 famous errors: 'Error(string)' or 'Panic(uint256)'

errorName = 'Error';
errorSignature = 'Error(string)';
// decode abi.inputs according to EIP-838
errorArgs = decodeParameters(
[
{
name: 'message',
type: 'string',
},
],
error.data.substring(10),
);
} else if (error.data.startsWith('0x4e487b71')) {
errorName = 'Panic';
errorSignature = 'Panic(uint256)';
// decode abi.inputs according to EIP-838
errorArgs = decodeParameters(
[
{
name: 'code',
type: 'uint256',
},
],
error.data.substring(10),
);
} else {
console.error('No matching error abi found for error data', error.data);

Check warning on line 71 in packages/web3-eth-abi/src/decode_contract_error_data.ts

View check run for this annotation

Codecov / codecov/patch

packages/web3-eth-abi/src/decode_contract_error_data.ts#L70-L71 

Added lines #L70 - L71 were not covered by tests
}
} catch (err) {
console.error(err);
Expand Down
34 changes: 34 additions & 0 deletions packages/web3-eth-abi/test/fixtures/data.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -974,6 +974,40 @@ export const validDecodeContractErrorData: {
input: any[];
output: any;
}[] = [
{
input: [
[],
{
code: 12,
message: 'message',
data: '0x08c379a0000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000155468697320697320612063616c6c207265766572740000000000000000000000',
},
],
output: {
errorName: 'Error',
errorSignature: 'Error(string)',
errorArgs: {
message: 'This is a call revert',
},
},
},
{
input: [
[],
{
code: 12,
message: 'message',
data: '0x4e487b71000000000000000000000000000000000000000000000000000000000000002a00000000000000000000000000000000000000000000000000000000000000',
},
],
output: {
errorName: 'Panic',
errorSignature: 'Panic(uint256)',
errorArgs: {
code: 42,
},
},
},
{
input: [
[
Expand Down
8 changes: 7 additions & 1 deletion packages/web3-eth-abi/test/unit/decodeContractErrorData.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,13 @@ describe('decodeContractErrorData', () => {
expect(err.errorName).toEqual(output.errorName);
expect(err.errorSignature).toEqual(output.errorSignature);
expect(err.errorArgs?.message).toEqual(output.errorArgs?.message);
expect(Number(err.errorArgs?.code)).toEqual(output.errorArgs?.code);

// This ensures they are equal if one was provided
// It also skips if both are not provided
if (err.errorArgs?.code || output.errorArgs?.code) {
// eslint-disable-next-line jest/no-conditional-expect
expect(Number(err.errorArgs?.code)).toEqual(output.errorArgs?.code);
}
expect(err.cause?.code).toEqual(output.cause?.code);
},
);
Expand Down
Loading