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

Add .on('error') test for reverted contract methods #6194

Merged
merged 6 commits into from
Jun 21, 2023
Merged

Add .on('error') test for reverted contract methods #6194

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2d97af7
Add a test for .on('error') for contract method error
spacesailor24 Jun 13, 2023
ff38941
Add a test for .on('error') for contract method error
spacesailor24 Jun 13, 2023
95f9a3e
Merge branch '4.x' into wyatt/4.x/5670-contract-method-error-tests
jdevcs Jun 20, 2023
51ede01
Update packages/web3-eth-contract/test/integration/contract_methods_e…
spacesailor24 Jun 20, 2023
a7a82c1
Update packages/web3-eth-contract/test/integration/contract_methods_e…
spacesailor24 Jun 20, 2023
0603716
Rename error codes
spacesailor24 Jun 20, 2023
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
43 changes: 43 additions & 0 deletions packages/web3-eth-contract/test/integration/contract_methods_errors.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,27 @@ describe('contract errors', () => {
});
});

it('should catch Unauthorized error PromiEvent.on("error")', async () => {
const expectedThrownError = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice if we have this const expectedThrownError = {... above and we use it inside the 2 related test cases which related to the Unauthorized() error.

name: 'ContractExecutionError',
code: ERR_CONTRACT_EXECUTION_REVERTED,
receipt: undefined,
innerError: {
code: 3,
data: '0x82b42900',
errorName: 'Unauthorized',
errorSignature: 'Unauthorized()',
},
};

await expect(
deployedContract.methods
.unauthorize()
.send(sendOptions)
.on('error', error => expect(error).toMatchObject(expectedThrownError)),
).rejects.toMatchObject(expectedThrownError);
});

it('Error with parameter', async () => {
let error: ContractExecutionError | undefined;
try {
Expand All @@ -101,5 +122,27 @@ describe('contract errors', () => {
},
});
});

it('should catch error with parameter using PromiEvent.on("error")', async () => {
const expectedThrownError = {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be nice if we have this const expectedThrownError = {... above and we use it inside the 2 related test cases which related to the CustomError error.

name: 'ContractExecutionError',
code: ERR_CONTRACT_EXECUTION_REVERTED,
receipt: undefined,
innerError: {
code: 3,
data: '0x8d6ea8be0000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000001b7265766572746564207573696e6720637573746f6d204572726f720000000000',
errorName: 'CustomError',
errorSignature: 'CustomError(string)',
errorArgs: { '0': 'reverted using custom Error' },
},
};

await expect(
deployedContract.methods
.badRequire()
.send(sendOptions)
.on('error', error => expect(error).toMatchObject(expectedThrownError)),
).rejects.toMatchObject(expectedThrownError);
});
});
});