@nomicfoundation/hardhat-ethers-chai-matchers 3.0.0-next.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024 Nomic Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,52 @@
+# Hardhat Ethers Chai Matchers plugin
+
+This plugin adds Ethereum-specific matchers to the [Chai](https://chaijs.com/) assertion library that integrate with [ethers.js](https://ethers.org/), making your smart contract tests easy to write and read.
+
+## Installation
+
+To install this plugin, run the following command:
+
+```bash
+npm install --save-dev @nomicfoundation/hardhat-ethers-chai-matchers@next
+```
+
+and add the following statements to your `hardhat.config.ts` file:
+
+```typescript
+// ...
+import ethersChaiMatchersPlugin from "@nomicfoundation/hardhat-ethers-chai-matchers";
+
+// ...
+
+export default {
+  // ...
+  plugins: [
+    // ...
+    ethersChaiMatchersPlugin,
+  ],
+
+  // ...
+};
+```
+
+## Usage
+
+You don't need to do anything else to use this plugin. Whenever you run your tests with Hardhat, it will automatically add the matchers.
+
+Here is an example of using the `changeEtherBalances` matcher:
+
+```ts
+import { expect } from "chai";
+
+// ...
+// ...
+
+const amount = ethers.utils.parseEther("1");
+
+await expect(() =>
+  sender.sendTransaction({
+    to: contract,
+    value: AMOUNT,
+  }),
+).to.changeEtherBalances(provider, [sender, contract], [-AMOUNT, AMOUNT]);
+```

package/dist/src/index.d.ts

@@ -0,0 +1,5 @@
+import type { HardhatPlugin } from "hardhat/types/plugins";
+import "./type-extensions.js";
+declare const hardhatChaiMatchersPlugin: HardhatPlugin;
+export default hardhatChaiMatchersPlugin;
+//# sourceMappingURL=index.d.ts.map

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,uBAAuB,CAAC;AAE3D,OAAO,sBAAsB,CAAC;AAE9B,QAAA,MAAM,yBAAyB,EAAE,aAchC,CAAC;AAEF,eAAe,yBAAyB,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,16 @@
+import "./type-extensions.js";
+const hardhatChaiMatchersPlugin = {
+    id: "hardhat-ethers-chai-matchers",
+    hookHandlers: {
+        network: import.meta.resolve("./internal/hook-handlers/network.js"),
+    },
+    npmPackage: "@nomicfoundation/hardhat-ethers-chai-matchers",
+    dependencies: [
+        async () => {
+            const { default: hardhatEthersPlugin } = await import("@nomicfoundation/hardhat-ethers");
+            return hardhatEthersPlugin;
+        },
+    ],
+};
+export default hardhatChaiMatchersPlugin;
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAEA,OAAO,sBAAsB,CAAC;AAE9B,MAAM,yBAAyB,GAAkB;IAC/C,EAAE,EAAE,8BAA8B;IAClC,YAAY,EAAE;QACZ,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,qCAAqC,CAAC;KACpE;IACD,UAAU,EAAE,+CAA+C;IAC3D,YAAY,EAAE;QACZ,KAAK,IAAI,EAAE;YACT,MAAM,EAAE,OAAO,EAAE,mBAAmB,EAAE,GAAG,MAAM,MAAM,CACnD,iCAAiC,CAClC,CAAC;YACF,OAAO,mBAAmB,CAAC;QAC7B,CAAC;KACF;CACF,CAAC;AAEF,eAAe,yBAAyB,CAAC"}

package/dist/src/internal/add-chai-matchers.d.ts

@@ -0,0 +1,2 @@
+export declare function addChaiMatchers(): void;
+//# sourceMappingURL=add-chai-matchers.d.ts.map

package/dist/src/internal/add-chai-matchers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-chai-matchers.d.ts","sourceRoot":"","sources":["../../../src/internal/add-chai-matchers.ts"],"names":[],"mappings":"AAoBA,wBAAgB,eAAe,IAAI,IAAI,CAGtC"}

package/dist/src/internal/add-chai-matchers.js

@@ -0,0 +1,41 @@
+import { use } from "chai";
+import chaiAsPromised from "chai-as-promised";
+import { supportAddressable } from "./matchers/addressable.js";
+import { supportBigNumber } from "./matchers/big-number.js";
+import { supportChangeEtherBalance } from "./matchers/changeEtherBalance.js";
+import { supportChangeEtherBalances } from "./matchers/changeEtherBalances.js";
+import { supportChangeTokenBalance } from "./matchers/changeTokenBalance.js";
+import { supportEmit } from "./matchers/emit.js";
+import { supportHexEqual } from "./matchers/hexEqual.js";
+import { supportProperAddress } from "./matchers/properAddress.js";
+import { supportProperHex } from "./matchers/properHex.js";
+import { supportProperPrivateKey } from "./matchers/properPrivateKey.js";
+import { supportReverted } from "./matchers/reverted/reverted.js";
+import { supportRevertedWith } from "./matchers/reverted/revertedWith.js";
+import { supportRevertedWithCustomError } from "./matchers/reverted/revertedWithCustomError.js";
+import { supportRevertedWithPanic } from "./matchers/reverted/revertedWithPanic.js";
+import { supportRevertedWithoutReason } from "./matchers/reverted/revertedWithoutReason.js";
+import { supportWithArgs } from "./matchers/withArgs.js";
+export function addChaiMatchers() {
+    use(hardhatChaiMatchers);
+    use(chaiAsPromised);
+}
+function hardhatChaiMatchers(chai, chaiUtils) {
+    supportAddressable(chai.Assertion, chaiUtils);
+    supportBigNumber(chai.Assertion, chaiUtils);
+    supportEmit(chai.Assertion, chaiUtils);
+    supportHexEqual(chai.Assertion);
+    supportProperAddress(chai.Assertion);
+    supportProperHex(chai.Assertion);
+    supportProperPrivateKey(chai.Assertion);
+    supportChangeEtherBalance(chai.Assertion, chaiUtils);
+    supportChangeEtherBalances(chai.Assertion, chaiUtils);
+    supportChangeTokenBalance(chai.Assertion, chaiUtils);
+    supportReverted(chai.Assertion, chaiUtils);
+    supportRevertedWith(chai.Assertion, chaiUtils);
+    supportRevertedWithCustomError(chai.Assertion, chaiUtils);
+    supportRevertedWithPanic(chai.Assertion, chaiUtils);
+    supportRevertedWithoutReason(chai.Assertion, chaiUtils);
+    supportWithArgs(chai.Assertion, chaiUtils);
+}
+//# sourceMappingURL=add-chai-matchers.js.map

package/dist/src/internal/add-chai-matchers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-chai-matchers.js","sourceRoot":"","sources":["../../../src/internal/add-chai-matchers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,MAAM,CAAC;AAC3B,OAAO,cAAc,MAAM,kBAAkB,CAAC;AAE9C,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAE,0BAA0B,EAAE,MAAM,mCAAmC,CAAC;AAC/E,OAAO,EAAE,yBAAyB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,oBAAoB,EAAE,MAAM,6BAA6B,CAAC;AACnE,OAAO,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,qCAAqC,CAAC;AAC1E,OAAO,EAAE,8BAA8B,EAAE,MAAM,gDAAgD,CAAC;AAChG,OAAO,EAAE,wBAAwB,EAAE,MAAM,0CAA0C,CAAC;AACpF,OAAO,EAAE,4BAA4B,EAAE,MAAM,8CAA8C,CAAC;AAC5F,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAEzD,MAAM,UAAU,eAAe;IAC7B,GAAG,CAAC,mBAAmB,CAAC,CAAC;IACzB,GAAG,CAAC,cAAc,CAAC,CAAC;AACtB,CAAC;AAED,SAAS,mBAAmB,CAC1B,IAAqB,EACrB,SAAyB;IAEzB,kBAAkB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC9C,gBAAgB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC5C,WAAW,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACvC,eAAe,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IAChC,oBAAoB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACrC,gBAAgB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACjC,uBAAuB,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;IACxC,yBAAyB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACrD,0BAA0B,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACtD,yBAAyB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACrD,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC3C,mBAAmB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC/C,8BAA8B,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1D,wBAAwB,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACpD,4BAA4B,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IACxD,eAAe,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AAC7C,CAAC"}

package/dist/src/internal/constants.d.ts

@@ -0,0 +1,13 @@
+export declare const ASSERTION_ABORTED = "hh-ethers-chai-matchers-assertion-aborted";
+export declare const PREVIOUS_MATCHER_NAME = "previousMatcherName";
+export declare const CHANGE_ETHER_BALANCE_MATCHER = "changeEtherBalance";
+export declare const CHANGE_ETHER_BALANCES_MATCHER = "changeEtherBalances";
+export declare const CHANGE_TOKEN_BALANCE_MATCHER = "changeTokenBalance";
+export declare const CHANGE_TOKEN_BALANCES_MATCHER = "changeTokenBalances";
+export declare const EMIT_MATCHER = "emit";
+export declare const REVERTED_MATCHER = "reverted";
+export declare const REVERTED_WITH_MATCHER = "revertedWith";
+export declare const REVERTED_WITH_CUSTOM_ERROR_MATCHER = "revertedWithCustomError";
+export declare const REVERTED_WITH_PANIC_MATCHER = "revertedWithPanic";
+export declare const REVERTED_WITHOUT_REASON_MATCHER = "revertedWithoutReason";
+//# sourceMappingURL=constants.d.ts.map

package/dist/src/internal/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../../src/internal/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,iBAAiB,8CAA8C,CAAC;AAC7E,eAAO,MAAM,qBAAqB,wBAAwB,CAAC;AAE3D,eAAO,MAAM,4BAA4B,uBAAuB,CAAC;AACjE,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AACnE,eAAO,MAAM,4BAA4B,uBAAuB,CAAC;AACjE,eAAO,MAAM,6BAA6B,wBAAwB,CAAC;AACnE,eAAO,MAAM,YAAY,SAAS,CAAC;AACnC,eAAO,MAAM,gBAAgB,aAAa,CAAC;AAC3C,eAAO,MAAM,qBAAqB,iBAAiB,CAAC;AACpD,eAAO,MAAM,kCAAkC,4BAA4B,CAAC;AAC5E,eAAO,MAAM,2BAA2B,sBAAsB,CAAC;AAC/D,eAAO,MAAM,+BAA+B,0BAA0B,CAAC"}

package/dist/src/internal/constants.js

@@ -0,0 +1,13 @@
+export const ASSERTION_ABORTED = "hh-ethers-chai-matchers-assertion-aborted";
+export const PREVIOUS_MATCHER_NAME = "previousMatcherName";
+export const CHANGE_ETHER_BALANCE_MATCHER = "changeEtherBalance";
+export const CHANGE_ETHER_BALANCES_MATCHER = "changeEtherBalances";
+export const CHANGE_TOKEN_BALANCE_MATCHER = "changeTokenBalance";
+export const CHANGE_TOKEN_BALANCES_MATCHER = "changeTokenBalances";
+export const EMIT_MATCHER = "emit";
+export const REVERTED_MATCHER = "reverted";
+export const REVERTED_WITH_MATCHER = "revertedWith";
+export const REVERTED_WITH_CUSTOM_ERROR_MATCHER = "revertedWithCustomError";
+export const REVERTED_WITH_PANIC_MATCHER = "revertedWithPanic";
+export const REVERTED_WITHOUT_REASON_MATCHER = "revertedWithoutReason";
+//# sourceMappingURL=constants.js.map

package/dist/src/internal/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.js","sourceRoot":"","sources":["../../../src/internal/constants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,iBAAiB,GAAG,2CAA2C,CAAC;AAC7E,MAAM,CAAC,MAAM,qBAAqB,GAAG,qBAAqB,CAAC;AAE3D,MAAM,CAAC,MAAM,4BAA4B,GAAG,oBAAoB,CAAC;AACjE,MAAM,CAAC,MAAM,6BAA6B,GAAG,qBAAqB,CAAC;AACnE,MAAM,CAAC,MAAM,4BAA4B,GAAG,oBAAoB,CAAC;AACjE,MAAM,CAAC,MAAM,6BAA6B,GAAG,qBAAqB,CAAC;AACnE,MAAM,CAAC,MAAM,YAAY,GAAG,MAAM,CAAC;AACnC,MAAM,CAAC,MAAM,gBAAgB,GAAG,UAAU,CAAC;AAC3C,MAAM,CAAC,MAAM,qBAAqB,GAAG,cAAc,CAAC;AACpD,MAAM,CAAC,MAAM,kCAAkC,GAAG,yBAAyB,CAAC;AAC5E,MAAM,CAAC,MAAM,2BAA2B,GAAG,mBAAmB,CAAC;AAC/D,MAAM,CAAC,MAAM,+BAA+B,GAAG,uBAAuB,CAAC"}

package/dist/src/internal/hook-handlers/network.d.ts

@@ -0,0 +1,4 @@
+import type { NetworkHooks } from "hardhat/types/hooks";
+declare const _default: () => Promise<Partial<NetworkHooks>>;
+export default _default;
+//# sourceMappingURL=network.d.ts.map

package/dist/src/internal/hook-handlers/network.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.d.ts","sourceRoot":"","sources":["../../../../src/internal/hook-handlers/network.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,YAAY,EAAE,MAAM,qBAAqB,CAAC;8BAO5C,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;AAAvD,wBAgBE"}

package/dist/src/internal/hook-handlers/network.js

@@ -0,0 +1,15 @@
+import { addChaiMatchers } from "../add-chai-matchers.js";
+let isInitialized = false;
+export default async () => {
+    const handlers = {
+        async newConnection(context, next) {
+            if (!isInitialized) {
+                addChaiMatchers();
+                isInitialized = true;
+            }
+            return next(context);
+        },
+    };
+    return handlers;
+};
+//# sourceMappingURL=network.js.map

package/dist/src/internal/hook-handlers/network.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"network.js","sourceRoot":"","sources":["../../../../src/internal/hook-handlers/network.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,IAAI,aAAa,GAAG,KAAK,CAAC;AAE1B,eAAe,KAAK,IAAoC,EAAE;IACxD,MAAM,QAAQ,GAA0B;QACtC,KAAK,CAAC,aAAa,CACjB,OAAoB,EACpB,IAAsE;YAEtE,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,eAAe,EAAE,CAAC;gBAClB,aAAa,GAAG,IAAI,CAAC;YACvB,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,CAAC,CAAC;QACvB,CAAC;KACF,CAAC;IAEF,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC"}

package/dist/src/internal/matchers/addressable.d.ts

@@ -0,0 +1,2 @@
+export declare function supportAddressable(Assertion: Chai.AssertionStatic, chaiUtils: Chai.ChaiUtils): void;
+//# sourceMappingURL=addressable.d.ts.map

package/dist/src/internal/matchers/addressable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressable.d.ts","sourceRoot":"","sources":["../../../../src/internal/matchers/addressable.ts"],"names":[],"mappings":"AAKA,wBAAgB,kBAAkB,CAChC,SAAS,EAAE,IAAI,CAAC,eAAe,EAC/B,SAAS,EAAE,IAAI,CAAC,SAAS,GACxB,IAAI,CAKN"}

package/dist/src/internal/matchers/addressable.js

@@ -0,0 +1,53 @@
+import { assertHardhatInvariant } from "@nomicfoundation/hardhat-errors";
+import { isAddress, isAddressable } from "ethers";
+import { tryDereference } from "../utils/typed.js";
+export function supportAddressable(Assertion, chaiUtils) {
+    const equalsFunction = override("eq", "equal", "not equal", chaiUtils);
+    Assertion.overwriteMethod("equals", equalsFunction);
+    Assertion.overwriteMethod("equal", equalsFunction);
+    Assertion.overwriteMethod("eq", equalsFunction);
+}
+function override(method, name, negativeName, chaiUtils) {
+    return (_super) => overwriteAddressableFunction(method, name, negativeName, _super, chaiUtils);
+}
+// ethers's Addressable have a .getAddress() that returns a Promise<string>. We don't want to deal with async here,
+// so we are looking for a sync way of getting the address. If an address was recovered, it is returned as a string,
+// otherwise undefined is returned.
+function tryGetAddressSync(value) {
+    value = tryDereference(value, "address");
+    if (isAddressable(value)) {
+        if ("address" in value) {
+            value = value.address;
+        }
+        else {
+            assertHardhatInvariant("target" in value, "target property should exist in value");
+            value = value.target;
+        }
+    }
+    if (isAddress(value)) {
+        return value;
+    }
+    else {
+        return undefined;
+    }
+}
+function overwriteAddressableFunction(functionName, readableName, readableNegativeName, _super, chaiUtils) {
+    return function (...args) {
+        const [actualArg, message] = args;
+        const expectedFlag = chaiUtils.flag(this, "object");
+        if (message !== undefined) {
+            chaiUtils.flag(this, "message", message);
+        }
+        const actual = tryGetAddressSync(actualArg);
+        const expected = tryGetAddressSync(expectedFlag);
+        if (functionName === "eq" &&
+            expected !== undefined &&
+            actual !== undefined) {
+            this.assert(expected === actual, `expected '${expected}' to ${readableName} '${actual}'.`, `expected '${expected}' to ${readableNegativeName} '${actual}'.`, actual.toString(), expected.toString());
+        }
+        else {
+            _super.apply(this, args);
+        }
+    };
+}
+//# sourceMappingURL=addressable.js.map

package/dist/src/internal/matchers/addressable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addressable.js","sourceRoot":"","sources":["../../../../src/internal/matchers/addressable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,MAAM,QAAQ,CAAC;AAElD,OAAO,EAAE,cAAc,EAAE,MAAM,mBAAmB,CAAC;AAEnD,MAAM,UAAU,kBAAkB,CAChC,SAA+B,EAC/B,SAAyB;IAEzB,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACvE,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IACpD,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACnD,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;AAClD,CAAC;AAID,SAAS,QAAQ,CACf,MAAe,EACf,IAAY,EACZ,YAAoB,EACpB,SAAyB;IAEzB,OAAO,CAAC,MAA+B,EAAE,EAAE,CACzC,4BAA4B,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAChF,CAAC;AAED,mHAAmH;AACnH,oHAAoH;AACpH,mCAAmC;AACnC,SAAS,iBAAiB,CAAC,KAAU;IACnC,KAAK,GAAG,cAAc,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;IAEzC,IAAI,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,IAAI,SAAS,IAAI,KAAK,EAAE,CAAC;YACvB,KAAK,GAAG,KAAK,CAAC,OAAO,CAAC;QACxB,CAAC;aAAM,CAAC;YACN,sBAAsB,CACpB,QAAQ,IAAI,KAAK,EACjB,uCAAuC,CACxC,CAAC;YACF,KAAK,GAAG,KAAK,CAAC,MAAM,CAAC;QACvB,CAAC;IACH,CAAC;IAED,IAAI,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACf,CAAC;SAAM,CAAC;QACN,OAAO,SAAS,CAAC;IACnB,CAAC;AACH,CAAC;AAED,SAAS,4BAA4B,CACnC,YAAqB,EACrB,YAAoB,EACpB,oBAA4B,EAC5B,MAA+B,EAC/B,SAAyB;IAEzB,OAAO,UAAsC,GAAG,IAAW;QACzD,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAClC,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,MAAM,MAAM,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QAC5C,MAAM,QAAQ,GAAG,iBAAiB,CAAC,YAAY,CAAC,CAAC;QACjD,IACE,YAAY,KAAK,IAAI;YACrB,QAAQ,KAAK,SAAS;YACtB,MAAM,KAAK,SAAS,EACpB,CAAC;YACD,IAAI,CAAC,MAAM,CACT,QAAQ,KAAK,MAAM,EACnB,aAAa,QAAQ,QAAQ,YAAY,KAAK,MAAM,IAAI,EACxD,aAAa,QAAQ,QAAQ,oBAAoB,KAAK,MAAM,IAAI,EAChE,MAAM,CAAC,QAAQ,EAAE,EACjB,QAAQ,CAAC,QAAQ,EAAE,CACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/internal/matchers/big-number.d.ts

@@ -0,0 +1,2 @@
+export declare function supportBigNumber(Assertion: Chai.AssertionStatic, chaiUtils: Chai.ChaiUtils): void;
+//# sourceMappingURL=big-number.d.ts.map

package/dist/src/internal/matchers/big-number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"big-number.d.ts","sourceRoot":"","sources":["../../../../src/internal/matchers/big-number.ts"],"names":[],"mappings":"AASA,wBAAgB,gBAAgB,CAC9B,SAAS,EAAE,IAAI,CAAC,eAAe,EAC/B,SAAS,EAAE,IAAI,CAAC,SAAS,GACxB,IAAI,CAiCN"}

package/dist/src/internal/matchers/big-number.js

@@ -0,0 +1,178 @@
+import util from "node:util";
+import { HardhatError } from "@nomicfoundation/hardhat-errors";
+import { toBigInt } from "@nomicfoundation/hardhat-utils/bigint";
+import { AssertionError } from "chai";
+import deepEqual from "deep-eql";
+import { isBigInt } from "../utils/bigint.js";
+export function supportBigNumber(Assertion, chaiUtils) {
+    const equalsFunction = override("eq", "equal", "not equal", chaiUtils);
+    Assertion.overwriteMethod("equals", equalsFunction);
+    Assertion.overwriteMethod("equal", equalsFunction);
+    Assertion.overwriteMethod("eq", equalsFunction);
+    const gtFunction = override("gt", "be above", "be at most", chaiUtils);
+    Assertion.overwriteMethod("above", gtFunction);
+    Assertion.overwriteMethod("gt", gtFunction);
+    Assertion.overwriteMethod("greaterThan", gtFunction);
+    const ltFunction = override("lt", "be below", "be at least", chaiUtils);
+    Assertion.overwriteMethod("below", ltFunction);
+    Assertion.overwriteMethod("lt", ltFunction);
+    Assertion.overwriteMethod("lessThan", ltFunction);
+    const gteFunction = override("gte", "be at least", "be below", chaiUtils);
+    Assertion.overwriteMethod("least", gteFunction);
+    Assertion.overwriteMethod("gte", gteFunction);
+    Assertion.overwriteMethod("greaterThanOrEqual", gteFunction);
+    const lteFunction = override("lte", "be at most", "be above", chaiUtils);
+    Assertion.overwriteMethod("most", lteFunction);
+    Assertion.overwriteMethod("lte", lteFunction);
+    Assertion.overwriteMethod("lessThanOrEqual", lteFunction);
+    Assertion.overwriteChainableMethod(...createLengthOverride("length"));
+    Assertion.overwriteChainableMethod(...createLengthOverride("lengthOf"));
+    Assertion.overwriteMethod("within", overrideWithin(chaiUtils));
+    Assertion.overwriteMethod("closeTo", overrideCloseTo(chaiUtils));
+    Assertion.overwriteMethod("approximately", overrideCloseTo(chaiUtils));
+}
+function createLengthOverride(method) {
+    return [
+        method,
+        function (_super) {
+            return function (value) {
+                const actual = this._obj;
+                if (isBigInt(value)) {
+                    const sizeOrLength = actual instanceof Map || actual instanceof Set ? "size" : "length";
+                    const actualLength = toBigInt(actual[sizeOrLength]);
+                    const expectedLength = toBigInt(value);
+                    this.assert(actualLength === expectedLength, `expected #{this} to have a ${sizeOrLength} of ${expectedLength.toString()} but got ${actualLength.toString()}`, `expected #{this} not to have a ${sizeOrLength} of ${expectedLength.toString()} but got ${actualLength.toString()}`, actualLength.toString(), expectedLength.toString());
+                }
+                else {
+                    _super.apply(this, arguments);
+                }
+            };
+        },
+        function (_super) {
+            return function () {
+                _super.apply(this, arguments);
+            };
+        },
+    ];
+}
+function override(method, name, negativeName, chaiUtils) {
+    return (_super) => overwriteBigNumberFunction(method, name, negativeName, _super, chaiUtils);
+}
+function overwriteBigNumberFunction(functionName, readableName, readableNegativeName, _super, chaiUtils) {
+    return function (...args) {
+        const [actualArg, message] = args;
+        const expectedFlag = chaiUtils.flag(this, "object");
+        if (message !== undefined) {
+            chaiUtils.flag(this, "message", message);
+        }
+        function compare(method, lhs, rhs) {
+            if (method === "eq") {
+                return lhs === rhs;
+            }
+            else if (method === "gt") {
+                return lhs > rhs;
+            }
+            else if (method === "lt") {
+                return lhs < rhs;
+            }
+            else if (method === "gte") {
+                return lhs >= rhs;
+            }
+            else if (method === "lte") {
+                return lhs <= rhs;
+            }
+            else {
+                throw new HardhatError(HardhatError.ERRORS.CHAI_MATCHERS.UNKNOWN_COMPARISON_OPERATION, {
+                    method,
+                });
+            }
+        }
+        if (Boolean(chaiUtils.flag(this, "doLength")) && isBigInt(actualArg)) {
+            const sizeOrLength = expectedFlag instanceof Map || expectedFlag instanceof Set
+                ? "size"
+                : "length";
+            if (expectedFlag[sizeOrLength] === undefined) {
+                _super.apply(this, args);
+                return;
+            }
+            const expected = toBigInt(expectedFlag[sizeOrLength]);
+            const actual = toBigInt(actualArg);
+            this.assert(compare(functionName, expected, actual), `expected #{this} to have a ${sizeOrLength} ${readableName.replace("be ", "")} ${actual.toString()} but got ${expected}`, `expected #{this} to have a ${sizeOrLength} ${readableNegativeName} ${actual.toString()}`, expected, actual);
+        }
+        else if (functionName === "eq" && Boolean(chaiUtils.flag(this, "deep"))) {
+            // "ssfi" stands for "start stack function indicator", it's a chai concept
+            // used to control which frames are included in the stack trace
+            // this pattern here was taken from chai's implementation of .deep.equal
+            const prevLockSsfi = chaiUtils.flag(this, "lockSsfi");
+            chaiUtils.flag(this, "lockSsfi", true);
+            this.assert(deepEqual(actualArg, expectedFlag, { comparator: deepEqualComparator }), `expected ${util.inspect(expectedFlag)} to deeply equal ${util.inspect(actualArg)}`, `expected ${util.inspect(expectedFlag)} to not deeply equal ${util.inspect(actualArg)}`, null);
+            chaiUtils.flag(this, "lockSsfi", prevLockSsfi);
+        }
+        else if (isBigInt(expectedFlag) || isBigInt(actualArg)) {
+            const expected = toBigInt(expectedFlag);
+            const actual = toBigInt(actualArg);
+            this.assert(compare(functionName, expected, actual), `expected ${expected} to ${readableName} ${actual}.`, `expected ${expected} to ${readableNegativeName} ${actual}.`, actual.toString(), expected.toString());
+        }
+        else {
+            _super.apply(this, args);
+        }
+    };
+}
+function overrideWithin(chaiUtils) {
+    return (_super) => overwriteBigNumberWithin(_super, chaiUtils);
+}
+function overwriteBigNumberWithin(_super, chaiUtils) {
+    return function (...args) {
+        const [startArg, finishArg] = args;
+        const expectedFlag = chaiUtils.flag(this, "object");
+        if (isBigInt(expectedFlag) || isBigInt(startArg) || isBigInt(finishArg)) {
+            const expected = toBigInt(expectedFlag);
+            const start = toBigInt(startArg);
+            const finish = toBigInt(finishArg);
+            this.assert(start <= expected && expected <= finish, `expected ${expected} to be within ${start}..${finish}`, `expected ${expected} to not be within ${start}..${finish}`, expected, [start, finish]);
+        }
+        else {
+            _super.apply(this, args);
+        }
+    };
+}
+function overrideCloseTo(chaiUtils) {
+    return (_super) => overwriteBigNumberCloseTo(_super, chaiUtils);
+}
+function overwriteBigNumberCloseTo(_super, chaiUtils) {
+    return function (...args) {
+        const [actualArg, deltaArg] = args;
+        const expectedFlag = chaiUtils.flag(this, "object");
+        if (isBigInt(expectedFlag) ||
+            isBigInt(actualArg) ||
+            isBigInt(deltaArg) ||
+            typeof actualArg === "number") {
+            if (deltaArg === undefined) {
+                // eslint-disable-next-line no-restricted-syntax -- keep the original chai error structure
+                throw new AssertionError("the arguments to closeTo or approximately must be numbers, and a delta is required");
+            }
+            const expected = toBigInt(expectedFlag);
+            const actual = toBigInt(actualArg);
+            const delta = toBigInt(deltaArg);
+            function abs(i) {
+                return i < 0 ? BigInt(-1) * i : i;
+            }
+            this.assert(abs(expected - actual) <= delta, `expected ${expected} to be close to ${actual} +/- ${delta}`, `expected ${expected} not to be close to ${actual} +/- ${delta}`, expected, `A number between ${actual - delta} and ${actual + delta}`);
+        }
+        else {
+            _super.apply(this, args);
+        }
+    };
+}
+function deepEqualComparator(a, b) {
+    try {
+        const normalizedA = toBigInt(a);
+        const normalizedB = toBigInt(b);
+        return normalizedA === normalizedB;
+    }
+    catch (e) {
+        // use default comparator
+        return null;
+    }
+}
+//# sourceMappingURL=big-number.js.map

package/dist/src/internal/matchers/big-number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"big-number.js","sourceRoot":"","sources":["../../../../src/internal/matchers/big-number.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAE7B,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,MAAM,CAAC;AACtC,OAAO,SAAS,MAAM,UAAU,CAAC;AAEjC,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,MAAM,UAAU,gBAAgB,CAC9B,SAA+B,EAC/B,SAAyB;IAEzB,MAAM,cAAc,GAAG,QAAQ,CAAC,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,SAAS,CAAC,CAAC;IACvE,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC;IACpD,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;IACnD,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,cAAc,CAAC,CAAC;IAEhD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,EAAE,SAAS,CAAC,CAAC;IACvE,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5C,SAAS,CAAC,eAAe,CAAC,aAAa,EAAE,UAAU,CAAC,CAAC;IAErD,MAAM,UAAU,GAAG,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,aAAa,EAAE,SAAS,CAAC,CAAC;IACxE,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;IAC/C,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;IAC5C,SAAS,CAAC,eAAe,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAElD,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IAC1E,SAAS,CAAC,eAAe,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC;IAChD,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9C,SAAS,CAAC,eAAe,CAAC,oBAAoB,EAAE,WAAW,CAAC,CAAC;IAE7D,MAAM,WAAW,GAAG,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,UAAU,EAAE,SAAS,CAAC,CAAC;IACzE,SAAS,CAAC,eAAe,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;IAC/C,SAAS,CAAC,eAAe,CAAC,KAAK,EAAE,WAAW,CAAC,CAAC;IAC9C,SAAS,CAAC,eAAe,CAAC,iBAAiB,EAAE,WAAW,CAAC,CAAC;IAE1D,SAAS,CAAC,wBAAwB,CAAC,GAAG,oBAAoB,CAAC,QAAQ,CAAC,CAAC,CAAC;IACtE,SAAS,CAAC,wBAAwB,CAAC,GAAG,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC;IAExE,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;IAE/D,SAAS,CAAC,eAAe,CAAC,SAAS,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;IACjE,SAAS,CAAC,eAAe,CAAC,eAAe,EAAE,eAAe,CAAC,SAAS,CAAC,CAAC,CAAC;AACzE,CAAC;AAED,SAAS,oBAAoB,CAC3B,MAAc;IAEd,OAAO;QACL,MAAM;QACN,UAAU,MAAW;YACnB,OAAO,UAAyC,KAAU;gBACxD,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC;gBAEzB,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;oBACpB,MAAM,YAAY,GAChB,MAAM,YAAY,GAAG,IAAI,MAAM,YAAY,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,QAAQ,CAAC;oBAErE,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC;oBACpD,MAAM,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAEvC,IAAI,CAAC,MAAM,CACT,YAAY,KAAK,cAAc,EAC/B,8BAA8B,YAAY,OAAO,cAAc,CAAC,QAAQ,EAAE,YAAY,YAAY,CAAC,QAAQ,EAAE,EAAE,EAC/G,kCAAkC,YAAY,OAAO,cAAc,CAAC,QAAQ,EAAE,YAAY,YAAY,CAAC,QAAQ,EAAE,EAAE,EACnH,YAAY,CAAC,QAAQ,EAAE,EACvB,cAAc,CAAC,QAAQ,EAAE,CAC1B,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;gBAChC,CAAC;YACH,CAAC,CAAC;QACJ,CAAC;QACD,UAAU,MAAW;YACnB,OAAO;gBACL,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;YAChC,CAAC,CAAC;QACJ,CAAC;KACF,CAAC;AACJ,CAAC;AAID,SAAS,QAAQ,CACf,MAAe,EACf,IAAY,EACZ,YAAoB,EACpB,SAAyB;IAEzB,OAAO,CAAC,MAA+B,EAAE,EAAE,CACzC,0BAA0B,CAAC,MAAM,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,0BAA0B,CACjC,YAAqB,EACrB,YAAoB,EACpB,oBAA4B,EAC5B,MAA+B,EAC/B,SAAyB;IAEzB,OAAO,UAAsC,GAAG,IAAW;QACzD,MAAM,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;QAClC,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;YAC1B,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QAC3C,CAAC;QAED,SAAS,OAAO,CAAC,MAAe,EAAE,GAAW,EAAE,GAAW;YACxD,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBACpB,OAAO,GAAG,KAAK,GAAG,CAAC;YACrB,CAAC;iBAAM,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAC3B,OAAO,GAAG,GAAG,GAAG,CAAC;YACnB,CAAC;iBAAM,IAAI,MAAM,KAAK,IAAI,EAAE,CAAC;gBAC3B,OAAO,GAAG,GAAG,GAAG,CAAC;YACnB,CAAC;iBAAM,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC5B,OAAO,GAAG,IAAI,GAAG,CAAC;YACpB,CAAC;iBAAM,IAAI,MAAM,KAAK,KAAK,EAAE,CAAC;gBAC5B,OAAO,GAAG,IAAI,GAAG,CAAC;YACpB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,YAAY,CACpB,YAAY,CAAC,MAAM,CAAC,aAAa,CAAC,4BAA4B,EAC9D;oBACE,MAAM;iBACP,CACF,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACrE,MAAM,YAAY,GAChB,YAAY,YAAY,GAAG,IAAI,YAAY,YAAY,GAAG;gBACxD,CAAC,CAAC,MAAM;gBACR,CAAC,CAAC,QAAQ,CAAC;YAEf,IAAI,YAAY,CAAC,YAAY,CAAC,KAAK,SAAS,EAAE,CAAC;gBAC7C,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBACzB,OAAO;YACT,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,YAAY,CAAC,CAAC,CAAC;YACtD,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YAEnC,IAAI,CAAC,MAAM,CACT,OAAO,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,EACvC,8BAA8B,YAAY,IAAI,YAAY,CAAC,OAAO,CAChE,KAAK,EACL,EAAE,CACH,IAAI,MAAM,CAAC,QAAQ,EAAE,YAAY,QAAQ,EAAE,EAC5C,8BAA8B,YAAY,IAAI,oBAAoB,IAAI,MAAM,CAAC,QAAQ,EAAE,EAAE,EACzF,QAAQ,EACR,MAAM,CACP,CAAC;QACJ,CAAC;aAAM,IAAI,YAAY,KAAK,IAAI,IAAI,OAAO,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;YAC1E,0EAA0E;YAC1E,+DAA+D;YAC/D,wEAAwE;YACxE,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;YAEtD,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC;YAEvC,IAAI,CAAC,MAAM,CACT,SAAS,CAAC,SAAS,EAAE,YAAY,EAAE,EAAE,UAAU,EAAE,mBAAmB,EAAE,CAAC,EACvE,YAAY,IAAI,CAAC,OAAO,CAAC,YAAY,CAAC,oBAAoB,IAAI,CAAC,OAAO,CACpE,SAAS,CACV,EAAE,EACH,YAAY,IAAI,CAAC,OAAO,CACtB,YAAY,CACb,wBAAwB,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,EAClD,IAAI,CACL,CAAC;YAEF,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACzD,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;YACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YAEnC,IAAI,CAAC,MAAM,CACT,OAAO,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,EACvC,YAAY,QAAQ,OAAO,YAAY,IAAI,MAAM,GAAG,EACpD,YAAY,QAAQ,OAAO,oBAAoB,IAAI,MAAM,GAAG,EAC5D,MAAM,CAAC,QAAQ,EAAE,EACjB,QAAQ,CAAC,QAAQ,EAAE,CACpB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,cAAc,CAAC,SAAyB;IAC/C,OAAO,CAAC,MAA+B,EAAE,EAAE,CACzC,wBAAwB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,wBAAwB,CAC/B,MAA+B,EAC/B,SAAyB;IAEzB,OAAO,UAAsC,GAAG,IAAW;QACzD,MAAM,CAAC,QAAQ,EAAE,SAAS,CAAC,GAAG,IAAI,CAAC;QACnC,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEpD,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;YACxE,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;YACxC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YACjC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YACnC,IAAI,CAAC,MAAM,CACT,KAAK,IAAI,QAAQ,IAAI,QAAQ,IAAI,MAAM,EACvC,YAAY,QAAQ,iBAAiB,KAAK,KAAK,MAAM,EAAE,EACvD,YAAY,QAAQ,qBAAqB,KAAK,KAAK,MAAM,EAAE,EAC3D,QAAQ,EACR,CAAC,KAAK,EAAE,MAAM,CAAC,CAChB,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,SAAyB;IAChD,OAAO,CAAC,MAA+B,EAAE,EAAE,CACzC,yBAAyB,CAAC,MAAM,EAAE,SAAS,CAAC,CAAC;AACjD,CAAC;AAED,SAAS,yBAAyB,CAChC,MAA+B,EAC/B,SAAyB;IAEzB,OAAO,UAAsC,GAAG,IAAW;QACzD,MAAM,CAAC,SAAS,EAAE,QAAQ,CAAC,GAAG,IAAI,CAAC;QACnC,MAAM,YAAY,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAEpD,IACE,QAAQ,CAAC,YAAY,CAAC;YACtB,QAAQ,CAAC,SAAS,CAAC;YACnB,QAAQ,CAAC,QAAQ,CAAC;YAClB,OAAO,SAAS,KAAK,QAAQ,EAC7B,CAAC;YACD,IAAI,QAAQ,KAAK,SAAS,EAAE,CAAC;gBAC3B,0FAA0F;gBAC1F,MAAM,IAAI,cAAc,CACtB,oFAAoF,CACrF,CAAC;YACJ,CAAC;YAED,MAAM,QAAQ,GAAG,QAAQ,CAAC,YAAY,CAAC,CAAC;YACxC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,CAAC;YACnC,MAAM,KAAK,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;YAEjC,SAAS,GAAG,CAAC,CAAS;gBACpB,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YACpC,CAAC;YAED,IAAI,CAAC,MAAM,CACT,GAAG,CAAC,QAAQ,GAAG,MAAM,CAAC,IAAI,KAAK,EAC/B,YAAY,QAAQ,mBAAmB,MAAM,QAAQ,KAAK,EAAE,EAC5D,YAAY,QAAQ,uBAAuB,MAAM,QAAQ,KAAK,EAAE,EAChE,QAAQ,EACR,oBAAoB,MAAM,GAAG,KAAK,QAAQ,MAAM,GAAG,KAAK,EAAE,CAC3D,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,MAAM,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QAC3B,CAAC;IACH,CAAC,CAAC;AACJ,CAAC;AAED,SAAS,mBAAmB,CAAC,CAAM,EAAE,CAAM;IACzC,IAAI,CAAC;QACH,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAChC,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC;QAChC,OAAO,WAAW,KAAK,WAAW,CAAC;IACrC,CAAC;IAAC,OAAO,CAAC,EAAE,CAAC;QACX,yBAAyB;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC"}

package/dist/src/internal/matchers/changeEtherBalance.d.ts

@@ -0,0 +1,7 @@
+import type { BalanceChangeOptions } from "../utils/balance.js";
+import type { Addressable } from "ethers/address";
+import type { TransactionResponse } from "ethers/providers";
+import type { EthereumProvider } from "hardhat/types/providers";
+export declare function supportChangeEtherBalance(Assertion: Chai.AssertionStatic, chaiUtils: Chai.ChaiUtils): void;
+export declare function getBalanceChange(provider: EthereumProvider, transaction: TransactionResponse | Promise<TransactionResponse> | (() => Promise<TransactionResponse> | TransactionResponse), account: Addressable | string, options?: BalanceChangeOptions): Promise<bigint>;
+//# sourceMappingURL=changeEtherBalance.d.ts.map

package/dist/src/internal/matchers/changeEtherBalance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeEtherBalance.d.ts","sourceRoot":"","sources":["../../../../src/internal/matchers/changeEtherBalance.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAE5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAgBhE,wBAAgB,yBAAyB,CACvC,SAAS,EAAE,IAAI,CAAC,eAAe,EAC/B,SAAS,EAAE,IAAI,CAAC,SAAS,GACxB,IAAI,CAoDN;AAED,wBAAsB,gBAAgB,CACpC,QAAQ,EAAE,gBAAgB,EAC1B,WAAW,EACP,mBAAmB,GACnB,OAAO,CAAC,mBAAmB,CAAC,GAC5B,CAAC,MAAM,OAAO,CAAC,mBAAmB,CAAC,GAAG,mBAAmB,CAAC,EAC9D,OAAO,EAAE,WAAW,GAAG,MAAM,EAC7B,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,MAAM,CAAC,CAoDjB"}

package/dist/src/internal/matchers/changeEtherBalance.js

@@ -0,0 +1,77 @@
+import { assertHardhatInvariant } from "@nomicfoundation/hardhat-errors";
+import { numberToHexString } from "@nomicfoundation/hardhat-utils/hex";
+import { isObject } from "@nomicfoundation/hardhat-utils/lang";
+import { toBigInt } from "ethers/utils";
+import { CHANGE_ETHER_BALANCE_MATCHER } from "../constants.js";
+import { getAddressOf } from "../utils/account.js";
+import { assertCanBeConvertedToBigint, assertIsNotNull, } from "../utils/asserts.js";
+import { buildAssert } from "../utils/build-assert.js";
+import { preventAsyncMatcherChaining } from "../utils/prevent-chaining.js";
+export function supportChangeEtherBalance(Assertion, chaiUtils) {
+    Assertion.addMethod(CHANGE_ETHER_BALANCE_MATCHER, function (provider, account, balanceChange, options) {
+        // capture negated flag before async code executes; see buildAssert's jsdoc
+        const negated = this.__flags.negate;
+        const subject = this._obj;
+        preventAsyncMatcherChaining(this, CHANGE_ETHER_BALANCE_MATCHER, chaiUtils);
+        const checkBalanceChange = ([actualChange, address]) => {
+            const assert = buildAssert(negated, checkBalanceChange);
+            if (typeof balanceChange === "function") {
+                assert(balanceChange(actualChange), `Expected the ether balance change of "${address}" to satisfy the predicate, but it didn't (balance change: ${actualChange.toString()} wei)`, `Expected the ether balance change of "${address}" to NOT satisfy the predicate, but it did (balance change: ${actualChange.toString()} wei)`);
+            }
+            else {
+                const expectedChange = toBigInt(balanceChange);
+                assert(actualChange === expectedChange, `Expected the ether balance of "${address}" to change by ${balanceChange.toString()} wei, but it changed by ${actualChange.toString()} wei`, `Expected the ether balance of "${address}" NOT to change by ${balanceChange.toString()} wei, but it did`);
+            }
+        };
+        const derivedPromise = Promise.all([
+            getBalanceChange(provider, subject, account, options),
+            getAddressOf(account),
+        ]).then(checkBalanceChange);
+        this.then = derivedPromise.then.bind(derivedPromise);
+        this.catch = derivedPromise.catch.bind(derivedPromise);
+        this.promise = derivedPromise;
+        return this;
+    });
+}
+export async function getBalanceChange(provider, transaction, account, options) {
+    let txResponse;
+    if (typeof transaction === "function") {
+        txResponse = await transaction();
+    }
+    else {
+        txResponse = await transaction;
+    }
+    const txReceipt = await txResponse.wait();
+    assertIsNotNull(txReceipt, "txReceipt");
+    const txBlockNumber = txReceipt.blockNumber;
+    const block = await provider.request({
+        method: "eth_getBlockByHash",
+        params: [txReceipt.blockHash, false],
+    });
+    assertHardhatInvariant(isObject(block) &&
+        Array.isArray(block.transactions) &&
+        block.transactions.length === 1, "There should be only 1 transaction in the block");
+    const address = await getAddressOf(account);
+    const balanceAfterHex = await provider.request({
+        method: "eth_getBalance",
+        params: [address, numberToHexString(txBlockNumber)],
+    });
+    const balanceBeforeHex = await provider.request({
+        method: "eth_getBalance",
+        params: [address, numberToHexString(txBlockNumber - 1)],
+    });
+    assertCanBeConvertedToBigint(balanceAfterHex);
+    assertCanBeConvertedToBigint(balanceBeforeHex);
+    const balanceAfter = BigInt(balanceAfterHex);
+    const balanceBefore = BigInt(balanceBeforeHex);
+    if (options?.includeFee !== true && address === txResponse.from) {
+        const gasPrice = txReceipt.gasPrice;
+        const gasUsed = txReceipt.gasUsed;
+        const txFee = gasPrice * gasUsed;
+        return balanceAfter + txFee - balanceBefore;
+    }
+    else {
+        return balanceAfter - balanceBefore;
+    }
+}
+//# sourceMappingURL=changeEtherBalance.js.map

package/dist/src/internal/matchers/changeEtherBalance.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeEtherBalance.js","sourceRoot":"","sources":["../../../../src/internal/matchers/changeEtherBalance.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,iBAAiB,EAAE,MAAM,oCAAoC,CAAC;AACvE,OAAO,EAAE,QAAQ,EAAE,MAAM,qCAAqC,CAAC;AAC/D,OAAO,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAExC,OAAO,EAAE,4BAA4B,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,EACL,4BAA4B,EAC5B,eAAe,GAChB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,8BAA8B,CAAC;AAE3E,MAAM,UAAU,yBAAyB,CACvC,SAA+B,EAC/B,SAAyB;IAEzB,SAAS,CAAC,SAAS,CACjB,4BAA4B,EAC5B,UAEE,QAA0B,EAC1B,OAA6B,EAC7B,aAA2D,EAC3D,OAA8B;QAE9B,2EAA2E;QAC3E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;QACpC,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC;QAE1B,2BAA2B,CACzB,IAAI,EACJ,4BAA4B,EAC5B,SAAS,CACV,CAAC;QAEF,MAAM,kBAAkB,GAAG,CAAC,CAAC,YAAY,EAAE,OAAO,CAGjD,EAAE,EAAE;YACH,MAAM,MAAM,GAAG,WAAW,CAAC,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAExD,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE,CAAC;gBACxC,MAAM,CACJ,aAAa,CAAC,YAAY,CAAC,EAC3B,yCAAyC,OAAO,8DAA8D,YAAY,CAAC,QAAQ,EAAE,OAAO,EAC5I,yCAAyC,OAAO,+DAA+D,YAAY,CAAC,QAAQ,EAAE,OAAO,CAC9I,CAAC;YACJ,CAAC;iBAAM,CAAC;gBACN,MAAM,cAAc,GAAG,QAAQ,CAAC,aAAa,CAAC,CAAC;gBAC/C,MAAM,CACJ,YAAY,KAAK,cAAc,EAC/B,kCAAkC,OAAO,kBAAkB,aAAa,CAAC,QAAQ,EAAE,2BAA2B,YAAY,CAAC,QAAQ,EAAE,MAAM,EAC3I,kCAAkC,OAAO,sBAAsB,aAAa,CAAC,QAAQ,EAAE,kBAAkB,CAC1G,CAAC;YACJ,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,cAAc,GAAG,OAAO,CAAC,GAAG,CAAC;YACjC,gBAAgB,CAAC,QAAQ,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC;YACrD,YAAY,CAAC,OAAO,CAAC;SACtB,CAAC,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAAC;QAC5B,IAAI,CAAC,IAAI,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACrD,IAAI,CAAC,KAAK,GAAG,cAAc,CAAC,KAAK,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACvD,IAAI,CAAC,OAAO,GAAG,cAAc,CAAC;QAC9B,OAAO,IAAI,CAAC;IACd,CAAC,CACF,CAAC;AACJ,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,gBAAgB,CACpC,QAA0B,EAC1B,WAG8D,EAC9D,OAA6B,EAC7B,OAA8B;IAE9B,IAAI,UAA+B,CAAC;IAEpC,IAAI,OAAO,WAAW,KAAK,UAAU,EAAE,CAAC;QACtC,UAAU,GAAG,MAAM,WAAW,EAAE,CAAC;IACnC,CAAC;SAAM,CAAC;QACN,UAAU,GAAG,MAAM,WAAW,CAAC;IACjC,CAAC;IAED,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,IAAI,EAAE,CAAC;IAC1C,eAAe,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;IACxC,MAAM,aAAa,GAAG,SAAS,CAAC,WAAW,CAAC;IAE5C,MAAM,KAAK,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QACnC,MAAM,EAAE,oBAAoB;QAC5B,MAAM,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,KAAK,CAAC;KACrC,CAAC,CAAC;IAEH,sBAAsB,CACpB,QAAQ,CAAC,KAAK,CAAC;QACb,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,YAAY,CAAC;QACjC,KAAK,CAAC,YAAY,CAAC,MAAM,KAAK,CAAC,EACjC,iDAAiD,CAClD,CAAC;IAEF,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,OAAO,CAAC,CAAC;IAE5C,MAAM,eAAe,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QAC7C,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,aAAa,CAAC,CAAC;KACpD,CAAC,CAAC;IAEH,MAAM,gBAAgB,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC;QAC9C,MAAM,EAAE,gBAAgB;QACxB,MAAM,EAAE,CAAC,OAAO,EAAE,iBAAiB,CAAC,aAAa,GAAG,CAAC,CAAC,CAAC;KACxD,CAAC,CAAC;IAEH,4BAA4B,CAAC,eAAe,CAAC,CAAC;IAC9C,4BAA4B,CAAC,gBAAgB,CAAC,CAAC;IAE/C,MAAM,YAAY,GAAG,MAAM,CAAC,eAAe,CAAC,CAAC;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,gBAAgB,CAAC,CAAC;IAE/C,IAAI,OAAO,EAAE,UAAU,KAAK,IAAI,IAAI,OAAO,KAAK,UAAU,CAAC,IAAI,EAAE,CAAC;QAChE,MAAM,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QACpC,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC;QAClC,MAAM,KAAK,GAAG,QAAQ,GAAG,OAAO,CAAC;QAEjC,OAAO,YAAY,GAAG,KAAK,GAAG,aAAa,CAAC;IAC9C,CAAC;SAAM,CAAC;QACN,OAAO,YAAY,GAAG,aAAa,CAAC;IACtC,CAAC;AACH,CAAC"}

package/dist/src/internal/matchers/changeEtherBalances.d.ts

@@ -0,0 +1,7 @@
+import type { BalanceChangeOptions } from "../utils/balance.js";
+import type { Addressable } from "ethers/address";
+import type { TransactionResponse } from "ethers/providers";
+import type { EthereumProvider } from "hardhat/types/providers";
+export declare function supportChangeEtherBalances(Assertion: Chai.AssertionStatic, chaiUtils: Chai.ChaiUtils): void;
+export declare function getBalanceChanges(provider: EthereumProvider, transaction: TransactionResponse | Promise<TransactionResponse>, accounts: Array<Addressable | string>, options?: BalanceChangeOptions): Promise<bigint[]>;
+//# sourceMappingURL=changeEtherBalances.d.ts.map

package/dist/src/internal/matchers/changeEtherBalances.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"changeEtherBalances.d.ts","sourceRoot":"","sources":["../../../../src/internal/matchers/changeEtherBalances.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAChE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAClD,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,yBAAyB,CAAC;AAahE,wBAAgB,0BAA0B,CACxC,SAAS,EAAE,IAAI,CAAC,eAAe,EAC/B,SAAS,EAAE,IAAI,CAAC,SAAS,GACxB,IAAI,CA2FN;AA4BD,wBAAsB,iBAAiB,CACrC,QAAQ,EAAE,gBAAgB,EAC1B,WAAW,EAAE,mBAAmB,GAAG,OAAO,CAAC,mBAAmB,CAAC,EAC/D,QAAQ,EAAE,KAAK,CAAC,WAAW,GAAG,MAAM,CAAC,EACrC,OAAO,CAAC,EAAE,oBAAoB,GAC7B,OAAO,CAAC,MAAM,EAAE,CAAC,CAmBnB"}