Add comments

src/index.ts

@@ -1,6 +1,13 @@
 import { expect } from "chai";
 import { utils } from "ethers";
 
+/**
+ * Tests a contract call if it reverts with a specific custom error.
+ * @param contractInstance The contract artifact compiled with Truffle.
+ * @param contractCall The method call with arguments.
+ * @param errorName The name of the custom error.
+ * @param values The expected arguments of the custom error.
+ */
 export async function expectRevertCustomError(
   contractInstance: any,
   contractCall: Promise<any>,
@@ -12,19 +19,19 @@ export async function expectRevertCustomError(
     expect.fail("Expected promise to throw but it didn't");
   } catch (revert: any) {
     const errorAbi = contractInstance.abi.find((elem: any) => elem.type === "error" && elem.name === errorName);
-      expect(errorAbi, `Expected custom error ${errorName}`).to.exist;
+    expect(errorAbi, `Expected custom error ${errorName}`).to.exist;
 
-      const types = errorAbi.inputs.map((elem: any) => elem.type);
+    const types: string[] = errorAbi.inputs.map((elem: any) => elem.type);
 
-      const errorId = utils
-        .solidityKeccak256(["string"], [`${errorName}(${types ? types.toString() : ""})`])
-        .substring(0, 10);
-      expect(JSON.stringify(revert), `Expected custom error ${errorName} (${errorId})`).to.include(errorId);
+    const errorId = utils
+      .solidityKeccak256(["string"], [`${errorName}(${types ? types.toString() : ""})`])
+      .substring(0, 10);
+    expect(JSON.stringify(revert), `Expected custom error ${errorName} (${errorId})`).to.include(errorId);
 
-      if (values) {
-        expect(values.length, "Expected the number of values to match the number of types").to.eq(types.length);
-        const decodedValues = utils.defaultAbiCoder.decode(types, utils.hexDataSlice(revert.data.result, 4));
-        decodedValues.forEach((elem, index) => expect(elem.toString()).to.eq(values[index].toString()));
+    if (values) {
+      expect(values.length, "Expected the number of values to match the number of types").to.eq(types.length);
+      const decodedValues = utils.defaultAbiCoder.decode(types, utils.hexDataSlice(revert.data.result, 4));
+      decodedValues.forEach((elem, index) => expect(elem.toString()).to.eq(values[index].toString()));
     }
   }
 }