👔 Handle bignumber in revertedWith.withArgs() (#786)

Author: rzadp

.changeset/polite-fans-arrive.md

@@ -0,0 +1,6 @@
+---
+"@ethereum-waffle/chai": patch
+"@ethereum-waffle/hardhat": patch
+---
+
+👔 revertedWith().withArgs no longer fails for uint values exceeding JavaScript's max int limit

pnpm-lock.yaml

@@ -43,15 +43,17 @@
   },
   "dependencies": {
     "@ethereum-waffle/provider": "workspace:*",
-    "debug": "^4.3.4"
+    "debug": "^4.3.4",
+    "json-bigint": "^1.0.0"
   },
   "devDependencies": {
-    "ethers": "5.6.2",
     "@types/debug": "^4.1.7",
+    "@types/json-bigint": "^1.0.1",
+    "eslint": "^7.14.0",
+    "ethers": "5.6.2",
     "mocha": "^8.2.1",
     "rimraf": "^3.0.2",
-    "typescript": "^4.6.2",
-    "eslint": "^7.14.0"
+    "typescript": "^4.6.2"
   },
   "peerDependencies": {
     "ethers": "*"

waffle-chai/package.json

@@ -1,5 +1,6 @@
 import {decodeRevertString} from '@ethereum-waffle/provider';
 import {callPromise} from '../call-promise';
+import JSONbig from 'json-bigint';
 
 export function supportRevertedWith(Assertion: Chai.AssertionStatic) {
   Assertion.addMethod('revertedWith', function (this: any, revertReason: string | RegExp) {
@@ -65,8 +66,15 @@ const decodeHardhatError = (error: any, context: any) => {
       const regexp = /VM Exception while processing transaction: reverted with custom error '([a-zA-Z0-9$_]+)\((.*)\)'/g;
       const matches = regexp.exec(errorString);
       if (matches && matches.length >= 1) {
-        // needs to be wrapped in list to be consistent with the emit matcher
-        context.args = [JSON.parse(`[${matches[2]}]`)];
+        // Matches is in a format of string: "arg1, arg2, arg3, ..."
+        // So it only makes sense in an array:
+        const matchesList = `[${matches[2]}]`;
+        // Next, it needs to be wrapped in a list to be consistent with the emit matcher:
+        context.args = [
+          // Additionally, we preserve numbers as strings,
+          // otherwise we face an overflow of bignumber.
+          JSONbig({storeAsString: true}).parse(matchesList)
+        ];
         const errorName = matches[1];
         context.txErrorName = errorName;
         return errorName;

waffle-chai/src/matchers/revertedWith.ts

@@ -9,6 +9,10 @@ contract Matchers {
     revert One(0, 'message', 0x00cFBbaF7DDB3a1476767101c12a0162e241fbAD2a0162e2410cFBbaF7162123);
   }
 
+  function doRevertWithBigNumber() public pure {
+    revert One(9007199254740991000000, 'message', 0x00cFBbaF7DDB3a1476767101c12a0162e241fbAD2a0162e2410cFBbaF7162123);
+  }
+
   function doRevertWithTwo() public pure {
     revert Two(
       [

waffle-hardhat/contracts/CustomError.sol

@@ -2,7 +2,7 @@ import {waffle} from 'hardhat';
 import {expect} from 'chai';
 import {MockProvider} from 'ethereum-waffle';
 import {revertedTest, revertedWithTest} from '@ethereum-waffle/chai/test';
-import {ContractFactory} from 'ethers';
+import {BigNumber, ContractFactory} from 'ethers';
 import CustomError from '../build/contracts/CustomError.sol/Matchers.json';
 
 describe('INTEGRATION: Matchers: reverted', () => {
@@ -58,6 +58,37 @@ describe('INTEGRATION: Matchers: revertedWith', () => {
           'message',
           '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
         );
+
+      await expect(matchers.doRevertWithOne())
+        .to.be.revertedWith('One')
+        .withArgs(
+          BigNumber.from('0'), // Check BigNumber instance as well.
+          'message',
+          '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+        );
+    });
+
+    it('With args and big number success', async () => {
+      const matchers = await deploy();
+      await expect(matchers.doRevertWithBigNumber())
+        .to.be.revertedWith('One')
+        .withArgs(
+          BigNumber.from('9007199254740991000000'),
+          'message',
+          '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+        );
+    });
+
+    it('With args and big number failure', async () => {
+      const matchers = await deploy();
+      await expect(expect(matchers.doRevertWithBigNumber())
+        .to.be.revertedWith('One')
+        .withArgs(
+          BigNumber.from('9007199254740991000001'), // different
+          'message',
+          '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+        )
+      ).to.be.eventually.rejectedWith('Expected "9007199254740991000000" to be equal 9007199254740991000001');
     });
 
     it('With args failure', async () => {