🧅 Allow special characters in revertedWith regex (#784)

Author: iconofsin

.changeset/silent-plums-exercise.md

@@ -0,0 +1,5 @@
+---
+"@ethereum-waffle/chai": patch
+---
+
+Allow special characters in revertedWith regex

waffle-chai/src/matchers/revertedWith.ts

@@ -61,7 +61,8 @@ const decodeHardhatError = (error: any, context: any) => {
     }
     const errorString = String(error);
     {
-      const regexp = /VM Exception while processing transaction: reverted with custom error '([a-zA-Z0-9]+)\((.*)\)'/g;
+      // eslint-disable-next-line max-len
+      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

waffle-hardhat/contracts/CustomError.sol

@@ -2,6 +2,7 @@ pragma solidity ^0.8.0;
 
 error One(uint value, string msg, bytes32 encoded);
 error Two(uint256[3] value, bytes32[2] encoded);
+error $__DecoratedCustomErrorName(uint value, string msg, bytes32 encoded);
 
 contract Matchers {
   function doRevertWithOne() public pure {
@@ -21,4 +22,8 @@ contract Matchers {
       ]
     );
   }
+
+  function doRevertWithDecoratedCustomErrorName() public pure {
+    revert $__DecoratedCustomErrorName(0, 'message', 0x00cFBbaF7DDB3a1476767101c12a0162e241fbAD2a0162e2410cFBbaF7162123);
+  }
 }

waffle-hardhat/test/reverted.test.ts

@@ -133,4 +133,61 @@ describe('INTEGRATION: Matchers: revertedWith', () => {
       );
     });
   });
+
+  it('Revert success (decorated)', async () => {
+    const matchers = await deploy();
+    await expect(matchers.doRevertWithDecoratedCustomErrorName()).to.be.revertedWith('$__DecoratedCustomErrorName');
+  });
+
+  it('Revert fail (decorated)', async () => {
+    const matchers = await deploy();
+    await expect(expect(matchers.doRevertWithDecoratedCustomErrorName())
+      .to.be.revertedWith('Two')
+    ).to.be.eventually.rejectedWith(
+      'Expected transaction to be reverted with "Two", but other reason was found: "$__DecoratedCustomErrorName"'
+    );
+  });
+
+  it('With args success (decorated)', async () => {
+    const matchers = await deploy();
+    await expect(matchers.doRevertWithDecoratedCustomErrorName())
+      .to.be.revertedWith('$__DecoratedCustomErrorName')
+      .withArgs(
+        0,
+        'message',
+        '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+      );
+  });
+
+  it('With args failure (decorated)', async () => {
+    const matchers = await deploy();
+    await expect(expect(matchers.doRevertWithDecoratedCustomErrorName())
+      .to.be.revertedWith('$__DecoratedCustomErrorName')
+      .withArgs(
+        1,
+        'message',
+        '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+      )
+    ).to.be.eventually.rejectedWith(/Expected (")?0(")? to (be )?equal 1/i); // It may or may not have the quote marks
+    await expect(expect(matchers.doRevertWithDecoratedCustomErrorName())
+      .to.be.revertedWith('$__DecoratedCustomErrorName')
+      .withArgs(
+        0,
+        'messagr',
+        '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123'
+      )
+    ).to.be.eventually.rejectedWith('expected \'message\' to equal \'messagr\'');
+    await expect(expect(matchers.doRevertWithDecoratedCustomErrorName())
+      .to.be.revertedWith('$__DecoratedCustomErrorName')
+      .withArgs(
+        0,
+        'message',
+        '0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162124'
+      )
+    ).to.be.eventually.rejectedWith('expected ' +
+      '\'0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162123\'' +
+      ' to equal ' +
+      '\'0x00cfbbaf7ddb3a1476767101c12a0162e241fbad2a0162e2410cfbbaf7162124\''
+    );
+  });
 });