@nomicfoundation/hardhat-utils 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,5 @@
+# Hardhat utils
+
+This package contains utilities used by Hardhat 3 and its plugins.
+
+This package is internal to Hardhat and should not be used directly.

package/dist/src/bigint.d.ts

@@ -0,0 +1,32 @@
+/**
+ * Returns the minimum of two bigints.
+ *
+ * @param x The first number to compare.
+ * @param y The second number to compare.
+ * @returns The smaller of the two numbers.
+ */
+export declare function min(x: bigint, y: bigint): bigint;
+/**
+ * Returns the maximum of two bigints.
+ *
+ * @param x The first number to compare.
+ * @param y The second number to compare.
+ * @returns The larger of the two numbers.
+ */
+export declare function max(x: bigint, y: bigint): bigint;
+/**
+ * Converts a value to a bigint.
+ *
+ * This function supports several types of input:
+ * - `number`: Must be an integer and a safe integer. If it's not, an error is thrown.
+ * - `bigint`: Returned as is.
+ * - `string`: Converted to a bigint using the BigInt constructor.
+ *
+ * If the input is of an unsupported type, an error is thrown.
+ *
+ * @param value The value to convert to a bigint.
+ * @returns The input value converted to a bigint.
+ * @throws InvalidParameterError If the input value cannot be converted to a bigint.
+ */
+export declare function toBigInt(value: number | string | bigint): bigint;
+//# sourceMappingURL=bigint.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bigint.d.ts","sourceRoot":"","sources":["../../src/bigint.ts"],"names":[],"mappings":"AAGA;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;GAMG;AACH,wBAAgB,GAAG,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,CAEhD;AAED;;;;;;;;;;;;;GAaG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,MAAM,CAqBhE"}

package/dist/src/bigint.js

@@ -0,0 +1,54 @@
+import { InvalidParameterError } from "./common-errors.js";
+import { unreachable } from "./error.js";
+/**
+ * Returns the minimum of two bigints.
+ *
+ * @param x The first number to compare.
+ * @param y The second number to compare.
+ * @returns The smaller of the two numbers.
+ */
+export function min(x, y) {
+    return x < y ? x : y;
+}
+/**
+ * Returns the maximum of two bigints.
+ *
+ * @param x The first number to compare.
+ * @param y The second number to compare.
+ * @returns The larger of the two numbers.
+ */
+export function max(x, y) {
+    return x > y ? x : y;
+}
+/**
+ * Converts a value to a bigint.
+ *
+ * This function supports several types of input:
+ * - `number`: Must be an integer and a safe integer. If it's not, an error is thrown.
+ * - `bigint`: Returned as is.
+ * - `string`: Converted to a bigint using the BigInt constructor.
+ *
+ * If the input is of an unsupported type, an error is thrown.
+ *
+ * @param value The value to convert to a bigint.
+ * @returns The input value converted to a bigint.
+ * @throws InvalidParameterError If the input value cannot be converted to a bigint.
+ */
+export function toBigInt(value) {
+    switch (typeof value) {
+        case "number":
+            if (!Number.isInteger(value)) {
+                throw new InvalidParameterError(`${value} is not an integer`);
+            }
+            if (!Number.isSafeInteger(value)) {
+                throw new InvalidParameterError(`Integer ${value} is unsafe. Consider using ${value}n instead. For more details, see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number/isSafeInteger`);
+            }
+        // `break;` intentionally omitted. fallthrough desired.
+        case "string":
+        case "bigint":
+            return BigInt(value);
+        default:
+            unreachable(value, new InvalidParameterError(`Unsupported type: ${typeof value}`));
+    }
+}
+//# sourceMappingURL=bigint.js.map

package/dist/src/bigint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bigint.js","sourceRoot":"","sources":["../../src/bigint.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,CAAS;IACtC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,GAAG,CAAC,CAAS,EAAE,CAAS;IACtC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,QAAQ,CAAC,KAA+B;IACtD,QAAQ,OAAO,KAAK,EAAE,CAAC;QACrB,KAAK,QAAQ;YACX,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,qBAAqB,CAAC,GAAG,KAAK,oBAAoB,CAAC,CAAC;YAChE,CAAC;YACD,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,CAAC;gBACjC,MAAM,IAAI,qBAAqB,CAC7B,WAAW,KAAK,8BAA8B,KAAK,wIAAwI,CAC5L,CAAC;YACJ,CAAC;QACH,uDAAuD;QACvD,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;QACvB;YACE,WAAW,CACT,KAAK,EACL,IAAI,qBAAqB,CAAC,qBAAqB,OAAO,KAAK,EAAE,CAAC,CAC/D,CAAC;IACN,CAAC;AACH,CAAC"}

package/dist/src/bytecode.d.ts

@@ -0,0 +1,27 @@
+import type { PrefixedHexString } from "./hex.js";
+import type { Artifact, LibraryAddresses, LibraryLink } from "./internal/bytecode.js";
+/**
+ * Resolves the linked bytecode for a given contract artifact by substituting
+ * the required library placeholders within the bytecode with the provided
+ * library addresses.
+ *
+ * @param artifact The contract artifact containing the bytecode and link references.
+ * @param providedLibraries An object containing library names as keys and their addresses as values.
+ * @returns The linked bytecode with all required libraries correctly linked.
+ * @throws InvalidLibraryAddressError If any provided library address is invalid.
+ * @throws AmbiguousLibraryNameError If any provided library name matches multiple needed libraries.
+ * @throws UnnecessaryLibraryError If any provided library name is not needed by the contract.
+ * @throws OverlappingLibrariesError If any library is provided more than once.
+ * @throws MissingLibrariesError If any needed library address is missing.
+ */
+export declare function resolveLinkedBytecode(artifact: Artifact, providedLibraries: LibraryAddresses): PrefixedHexString;
+/**
+ * Links the bytecode of a contract artifact with the provided library addresses.
+ * This function does not perform any validation on the provided libraries.
+ *
+ * @param artifact The contract artifact containing the bytecode and link references.
+ * @param libraries An array of LibraryLink objects representing the libraries to be linked.
+ * @returns The linked bytecode with all provided libraries correctly linked.
+ */
+export declare function linkBytecode(artifact: Artifact, libraries: LibraryLink[]): PrefixedHexString;
+//# sourceMappingURL=bytecode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bytecode.d.ts","sourceRoot":"","sources":["../../src/bytecode.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAClD,OAAO,KAAK,EACV,QAAQ,EACR,gBAAgB,EAChB,WAAW,EACZ,MAAM,wBAAwB,CAAC;AAUhC;;;;;;;;;;;;;GAaG;AACH,wBAAgB,qBAAqB,CACnC,QAAQ,EAAE,QAAQ,EAClB,iBAAiB,EAAE,gBAAgB,GAClC,iBAAiB,CA0BnB;AAED;;;;;;;GAOG;AACH,wBAAgB,YAAY,CAC1B,QAAQ,EAAE,QAAQ,EAClB,SAAS,EAAE,WAAW,EAAE,GACvB,iBAAiB,CAkBnB"}

package/dist/src/bytecode.js

@@ -0,0 +1,60 @@
+import { getPrefixedHexString, getUnprefixedHexString } from "./hex.js";
+import { checkAmbiguousOrUnnecessaryLinks, checkMissingLibraryAddresses, checkOverlappingLibraryNames, checkProvidedLibraryAddresses, } from "./internal/bytecode.js";
+/**
+ * Resolves the linked bytecode for a given contract artifact by substituting
+ * the required library placeholders within the bytecode with the provided
+ * library addresses.
+ *
+ * @param artifact The contract artifact containing the bytecode and link references.
+ * @param providedLibraries An object containing library names as keys and their addresses as values.
+ * @returns The linked bytecode with all required libraries correctly linked.
+ * @throws InvalidLibraryAddressError If any provided library address is invalid.
+ * @throws AmbiguousLibraryNameError If any provided library name matches multiple needed libraries.
+ * @throws UnnecessaryLibraryError If any provided library name is not needed by the contract.
+ * @throws OverlappingLibrariesError If any library is provided more than once.
+ * @throws MissingLibrariesError If any needed library address is missing.
+ */
+export function resolveLinkedBytecode(artifact, providedLibraries) {
+    checkProvidedLibraryAddresses(providedLibraries);
+    const neededLibraries = [];
+    for (const [sourceName, sourceLibraries] of Object.entries(artifact.linkReferences)) {
+        for (const libraryName of Object.keys(sourceLibraries)) {
+            const libraryFqn = `${sourceName}:${libraryName}`;
+            const address = providedLibraries[libraryFqn] ?? providedLibraries[libraryName];
+            neededLibraries.push({
+                sourceName,
+                libraryName,
+                libraryFqn,
+                address,
+            });
+        }
+    }
+    checkAmbiguousOrUnnecessaryLinks(providedLibraries, neededLibraries);
+    checkOverlappingLibraryNames(providedLibraries, neededLibraries);
+    checkMissingLibraryAddresses(neededLibraries);
+    return linkBytecode(artifact, neededLibraries);
+}
+/**
+ * Links the bytecode of a contract artifact with the provided library addresses.
+ * This function does not perform any validation on the provided libraries.
+ *
+ * @param artifact The contract artifact containing the bytecode and link references.
+ * @param libraries An array of LibraryLink objects representing the libraries to be linked.
+ * @returns The linked bytecode with all provided libraries correctly linked.
+ */
+export function linkBytecode(artifact, libraries) {
+    const { bytecode, linkReferences } = artifact;
+    let linkedBytecode = bytecode;
+    for (const { sourceName, libraryName, address } of libraries) {
+        const contractLinkReferences = linkReferences[sourceName]?.[libraryName] ?? [];
+        const unprefixedAddress = getUnprefixedHexString(address);
+        for (const { start, length } of contractLinkReferences) {
+            linkedBytecode =
+                linkedBytecode.substring(0, 2 + start * 2) +
+                    unprefixedAddress +
+                    linkedBytecode.substring(2 + (start + length) * 2);
+        }
+    }
+    return getPrefixedHexString(linkedBytecode);
+}
+//# sourceMappingURL=bytecode.js.map

package/dist/src/bytecode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytecode.js","sourceRoot":"","sources":["../../src/bytecode.ts"],"names":[],"mappings":"AAOA,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAC;AACxE,OAAO,EACL,gCAAgC,EAChC,4BAA4B,EAC5B,4BAA4B,EAC5B,6BAA6B,GAC9B,MAAM,wBAAwB,CAAC;AAEhC;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,qBAAqB,CACnC,QAAkB,EAClB,iBAAmC;IAEnC,6BAA6B,CAAC,iBAAiB,CAAC,CAAC;IAEjD,MAAM,eAAe,GAAkB,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,UAAU,EAAE,eAAe,CAAC,IAAI,MAAM,CAAC,OAAO,CACxD,QAAQ,CAAC,cAAc,CACxB,EAAE,CAAC;QACF,KAAK,MAAM,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;YACvD,MAAM,UAAU,GAAG,GAAG,UAAU,IAAI,WAAW,EAAE,CAAC;YAClD,MAAM,OAAO,GACX,iBAAiB,CAAC,UAAU,CAAC,IAAI,iBAAiB,CAAC,WAAW,CAAC,CAAC;YAElE,eAAe,CAAC,IAAI,CAAC;gBACnB,UAAU;gBACV,WAAW;gBACX,UAAU;gBACV,OAAO;aACR,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,gCAAgC,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;IACrE,4BAA4B,CAAC,iBAAiB,EAAE,eAAe,CAAC,CAAC;IACjE,4BAA4B,CAAC,eAAe,CAAC,CAAC;IAE9C,OAAO,YAAY,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AACjD,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,YAAY,CAC1B,QAAkB,EAClB,SAAwB;IAExB,MAAM,EAAE,QAAQ,EAAE,cAAc,EAAE,GAAG,QAAQ,CAAC;IAC9C,IAAI,cAAc,GAAG,QAAQ,CAAC;IAE9B,KAAK,MAAM,EAAE,UAAU,EAAE,WAAW,EAAE,OAAO,EAAE,IAAI,SAAS,EAAE,CAAC;QAC7D,MAAM,sBAAsB,GAC1B,cAAc,CAAC,UAAU,CAAC,EAAE,CAAC,WAAW,CAAC,IAAI,EAAE,CAAC;QAClD,MAAM,iBAAiB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAE1D,KAAK,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,IAAI,sBAAsB,EAAE,CAAC;YACvD,cAAc;gBACZ,cAAc,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC;oBAC1C,iBAAiB;oBACjB,cAAc,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,KAAK,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;QACvD,CAAC;IACH,CAAC;IAED,OAAO,oBAAoB,CAAC,cAAc,CAAC,CAAC;AAC9C,CAAC"}

package/dist/src/bytes.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Checks if a value is an instance of Uint8Array.
+ *
+ * @param value The value to check.
+ * @returns True if the value is a Uint8Array, false otherwise.
+ */
+export declare function isBytes(value: unknown): value is Uint8Array;
+/**
+ * Pads a Uint8Array with zeros on the left to a specified length, or truncates
+ * it from the left if it's too long.
+ *
+ * @param bytes The Uint8Array to pad or truncate.
+ * @param length The desired length of the Uint8Array.
+ * @returns The padded or truncated Uint8Array.
+ */
+export declare function setLengthLeft(bytes: Uint8Array, length: number): Uint8Array;
+/**
+ * Checks if two Uint8Arrays are equal.
+ *
+ * @param x The first Uint8Array to compare.
+ * @param y The second Uint8Array to compare.
+ * @returns True if the Uint8Arrays are equal, false otherwise.
+ */
+export declare function equalsBytes(x: Uint8Array, y: Uint8Array): boolean;
+/**
+ * Converts a UTF-8 encoded string into a byte array.
+ *
+ * @param utf8String The UTF-8 encoded string to convert to bytes.
+ * @returns A Uint8Array representing the byte sequence of the input UTF-8 string.
+ */
+export declare function utf8StringToBytes(utf8String: string): Uint8Array;
+export { bytesToBigInt, bytesToNumber, numberToBytes } from "./number.js";
+export { bytesToHexString, hexStringToBytes } from "./hex.js";
+//# sourceMappingURL=bytes.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.d.ts","sourceRoot":"","sources":["../../src/bytes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,OAAO,CAAC,KAAK,EAAE,OAAO,GAAG,KAAK,IAAI,UAAU,CAE3D;AAED;;;;;;;GAOG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,GAAG,UAAU,CAQ3E;AAED;;;;;;GAMG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,UAAU,EAAE,CAAC,EAAE,UAAU,GAAG,OAAO,CAEjE;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,CAEhE;AAED,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/src/bytes.js

@@ -0,0 +1,47 @@
+/**
+ * Checks if a value is an instance of Uint8Array.
+ *
+ * @param value The value to check.
+ * @returns True if the value is a Uint8Array, false otherwise.
+ */
+export function isBytes(value) {
+    return value instanceof Uint8Array;
+}
+/**
+ * Pads a Uint8Array with zeros on the left to a specified length, or truncates
+ * it from the left if it's too long.
+ *
+ * @param bytes The Uint8Array to pad or truncate.
+ * @param length The desired length of the Uint8Array.
+ * @returns The padded or truncated Uint8Array.
+ */
+export function setLengthLeft(bytes, length) {
+    if (bytes.length < length) {
+        const padded = new Uint8Array(length);
+        padded.set(bytes, length - bytes.length);
+        return padded;
+    }
+    return bytes.subarray(-length);
+}
+/**
+ * Checks if two Uint8Arrays are equal.
+ *
+ * @param x The first Uint8Array to compare.
+ * @param y The second Uint8Array to compare.
+ * @returns True if the Uint8Arrays are equal, false otherwise.
+ */
+export function equalsBytes(x, y) {
+    return x.length === y.length && x.every((xVal, i) => xVal === y[i]);
+}
+/**
+ * Converts a UTF-8 encoded string into a byte array.
+ *
+ * @param utf8String The UTF-8 encoded string to convert to bytes.
+ * @returns A Uint8Array representing the byte sequence of the input UTF-8 string.
+ */
+export function utf8StringToBytes(utf8String) {
+    return new TextEncoder().encode(utf8String);
+}
+export { bytesToBigInt, bytesToNumber, numberToBytes } from "./number.js";
+export { bytesToHexString, hexStringToBytes } from "./hex.js";
+//# sourceMappingURL=bytes.js.map

package/dist/src/bytes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bytes.js","sourceRoot":"","sources":["../../src/bytes.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAc;IACpC,OAAO,KAAK,YAAY,UAAU,CAAC;AACrC,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,KAAiB,EAAE,MAAc;IAC7D,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,EAAE,CAAC;QAC1B,MAAM,MAAM,GAAG,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC;QACtC,MAAM,CAAC,GAAG,CAAC,KAAK,EAAE,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC;QACzC,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC,CAAC;AACjC,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,WAAW,CAAC,CAAa,EAAE,CAAa;IACtD,OAAO,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACtE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,UAAkB;IAClD,OAAO,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;AAC9C,CAAC;AAED,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,aAAa,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC"}

package/dist/src/ci.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Checks whether the current process is running in a CI environment.
+ *
+ * @returns True if the current process is running in a CI environment.
+ */
+export declare function isCi(): boolean;
+//# sourceMappingURL=ci.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"ci.d.ts","sourceRoot":"","sources":["../../src/ci.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,wBAAgB,IAAI,IAAI,OAAO,CAa9B"}

package/dist/src/ci.js

@@ -0,0 +1,18 @@
+/**
+ * Checks whether the current process is running in a CI environment.
+ *
+ * @returns True if the current process is running in a CI environment.
+ */
+export function isCi() {
+    const env = process.env;
+    return (env.GITHUB_ACTIONS !== undefined || // GitHub Actions
+        env.NOW !== undefined || // Vercel Now
+        env.DEPLOYMENT_ID !== undefined || // Vercel Now
+        env.CODEBUILD_BUILD_NUMBER !== undefined || // AWS CodeBuild
+        env.CI !== undefined || // Travis CI, CircleCI, Cirrus CI, GitLab CI, Appveyor, CodeShip, dsari
+        env.CONTINUOUS_INTEGRATION !== undefined || // Travis CI, Cirrus CI
+        env.BUILD_NUMBER !== undefined || // Jenkins, TeamCity
+        env.RUN_ID !== undefined // TaskCluster, dsari
+    );
+}
+//# sourceMappingURL=ci.js.map

package/dist/src/ci.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci.js","sourceRoot":"","sources":["../../src/ci.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,MAAM,UAAU,IAAI;IAClB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,OAAO,CACL,GAAG,CAAC,cAAc,KAAK,SAAS,IAAI,iBAAiB;QACrD,GAAG,CAAC,GAAG,KAAK,SAAS,IAAI,aAAa;QACtC,GAAG,CAAC,aAAa,KAAK,SAAS,IAAI,aAAa;QAChD,GAAG,CAAC,sBAAsB,KAAK,SAAS,IAAI,gBAAgB;QAC5D,GAAG,CAAC,EAAE,KAAK,SAAS,IAAI,uEAAuE;QAC/F,GAAG,CAAC,sBAAsB,KAAK,SAAS,IAAI,uBAAuB;QACnE,GAAG,CAAC,YAAY,KAAK,SAAS,IAAI,oBAAoB;QACtD,GAAG,CAAC,MAAM,KAAK,SAAS,CAAC,qBAAqB;KAC/C,CAAC;AACJ,CAAC"}

package/dist/src/common-errors.d.ts

@@ -0,0 +1,5 @@
+import { CustomError } from "./error.js";
+export declare class InvalidParameterError extends CustomError {
+    constructor(message: string, cause?: Error);
+}
+//# sourceMappingURL=common-errors.d.ts.map

package/dist/src/common-errors.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-errors.d.ts","sourceRoot":"","sources":["../../src/common-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,qBAAa,qBAAsB,SAAQ,WAAW;gBACxC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;CAG3C"}

package/dist/src/common-errors.js

@@ -0,0 +1,7 @@
+import { CustomError } from "./error.js";
+export class InvalidParameterError extends CustomError {
+    constructor(message, cause) {
+        super(message, cause);
+    }
+}
+//# sourceMappingURL=common-errors.js.map

package/dist/src/common-errors.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"common-errors.js","sourceRoot":"","sources":["../../src/common-errors.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAEzC,MAAM,OAAO,qBAAsB,SAAQ,WAAW;IACpD,YAAY,OAAe,EAAE,KAAa;QACxC,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IACxB,CAAC;CACF"}

package/dist/src/crypto.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Computes the Keccak-256 hash of the input bytes.
+ *
+ * @param bytes The input bytes to hash.
+ * @returns The Keccak-256 hash of the input bytes.
+ */
+export declare function keccak256(bytes: Uint8Array): Promise<Uint8Array>;
+/**
+ * Creates a non-cryptographic hash-based identifier for the given input.
+ *
+ * This function is primarily intended for generating unique identifiers from
+ * a given input string.
+ * It uses the SHA-1 hash algorithm, which is not cryptographically secure, but
+ * is sufficient for this use case as long as the input is not generated by an
+ * attacker.
+ *
+ * Note: The exact algorithm used (SHA-1) is not crucial for the function's
+ * purpose of generating unique identifiers, and could be replaced if needed.
+ *
+ * @param data The input string to be hashed.
+ * @returns The SHA-1 hash of the input string, represented as a
+ * hexadecimal string.
+ */
+export declare function createNonCryptographicHashId(data: string): Promise<string>;
+//# sourceMappingURL=crypto.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.d.ts","sourceRoot":"","sources":["../../src/crypto.ts"],"names":[],"mappings":"AAEA;;;;;GAKG;AACH,wBAAsB,SAAS,CAAC,KAAK,EAAE,UAAU,GAAG,OAAO,CAAC,UAAU,CAAC,CAEtE;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAsB,4BAA4B,CAChD,IAAI,EAAE,MAAM,GACX,OAAO,CAAC,MAAM,CAAC,CAIjB"}

package/dist/src/crypto.js

@@ -0,0 +1,32 @@
+import { keccak256 as keccak256Impl } from "ethereum-cryptography/keccak";
+/**
+ * Computes the Keccak-256 hash of the input bytes.
+ *
+ * @param bytes The input bytes to hash.
+ * @returns The Keccak-256 hash of the input bytes.
+ */
+export async function keccak256(bytes) {
+    return keccak256Impl(bytes);
+}
+/**
+ * Creates a non-cryptographic hash-based identifier for the given input.
+ *
+ * This function is primarily intended for generating unique identifiers from
+ * a given input string.
+ * It uses the SHA-1 hash algorithm, which is not cryptographically secure, but
+ * is sufficient for this use case as long as the input is not generated by an
+ * attacker.
+ *
+ * Note: The exact algorithm used (SHA-1) is not crucial for the function's
+ * purpose of generating unique identifiers, and could be replaced if needed.
+ *
+ * @param data The input string to be hashed.
+ * @returns The SHA-1 hash of the input string, represented as a
+ * hexadecimal string.
+ */
+export async function createNonCryptographicHashId(data) {
+    const message = new TextEncoder().encode(data);
+    const buffer = await crypto.subtle.digest("SHA-1", message);
+    return Buffer.from(buffer).toString("hex");
+}
+//# sourceMappingURL=crypto.js.map

package/dist/src/crypto.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"crypto.js","sourceRoot":"","sources":["../../src/crypto.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,IAAI,aAAa,EAAE,MAAM,8BAA8B,CAAC;AAE1E;;;;;GAKG;AACH,MAAM,CAAC,KAAK,UAAU,SAAS,CAAC,KAAiB;IAC/C,OAAO,aAAa,CAAC,KAAK,CAAC,CAAC;AAC9B,CAAC;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,CAAC,KAAK,UAAU,4BAA4B,CAChD,IAAY;IAEZ,MAAM,OAAO,GAAG,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAC5D,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;AAC7C,CAAC"}

package/dist/src/date.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Converts a string, number, or Date object to a Unix timestamp (seconds since the Unix Epoch).
+ *
+ * @param value The string to convert.
+ * @returns The Unix timestamp.
+ */
+export declare function toSeconds(value: string | number | Date): number;
+/**
+ * Converts a Unix timestamp to a Date object.
+ *
+ * @param timestamp The Unix timestamp to convert.
+ * @returns The Date object.
+ */
+export declare function secondsToDate(timestamp: number): Date;
+/**
+ * Gets the current Unix timestamp (seconds since the Unix Epoch).
+ *
+ * @returns The current Unix timestamp.
+ */
+export declare function now(): number;
+//# sourceMappingURL=date.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"date.d.ts","sourceRoot":"","sources":["../../src/date.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,SAAS,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,IAAI,GAAG,MAAM,CAE/D;AAED;;;;;GAKG;AACH,wBAAgB,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,CAErD;AAED;;;;GAIG;AACH,wBAAgB,GAAG,IAAI,MAAM,CAE5B"}

package/dist/src/date.js

@@ -0,0 +1,27 @@
+/**
+ * Converts a string, number, or Date object to a Unix timestamp (seconds since the Unix Epoch).
+ *
+ * @param value The string to convert.
+ * @returns The Unix timestamp.
+ */
+export function toSeconds(value) {
+    return Math.floor(new Date(value).getTime() / 1000);
+}
+/**
+ * Converts a Unix timestamp to a Date object.
+ *
+ * @param timestamp The Unix timestamp to convert.
+ * @returns The Date object.
+ */
+export function secondsToDate(timestamp) {
+    return new Date(timestamp * 1000);
+}
+/**
+ * Gets the current Unix timestamp (seconds since the Unix Epoch).
+ *
+ * @returns The current Unix timestamp.
+ */
+export function now() {
+    return Math.floor(Date.now() / 1000);
+}
+//# sourceMappingURL=date.js.map

package/dist/src/date.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"date.js","sourceRoot":"","sources":["../../src/date.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,SAAS,CAAC,KAA6B;IACrD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,OAAO,EAAE,GAAG,IAAI,CAAC,CAAC;AACtD,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,SAAiB;IAC7C,OAAO,IAAI,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,CAAC;AACpC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,GAAG;IACjB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC"}

package/dist/src/debug.d.ts

@@ -0,0 +1,16 @@
+/**
+ * A simple decorator that adds debug logging for when a method is entered and exited.
+ *
+ * This decorator is meant to be used for debugging purposes only. It should not be committed in runtime code.
+ *
+ * Example usage:
+ *
+ * ```
+ * class MyClass {
+ *   @withDebugLogs("MyClass:exampleClassMethod")
+ *   public function exampleClassMethod(...)
+ * }
+ * ```
+ */
+export declare function withDebugLogs<This, Args extends any[], Return>(tag?: string): (originalMethod: (this: This, ...args: Args) => Return, _context: ClassMethodDecoratorContext<This, (this: This, ...args: Args) => Return>) => (this: This, ...args: Args) => Return;
+//# sourceMappingURL=debug.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"debug.d.ts","sourceRoot":"","sources":["../../src/debug.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,aAAa,CAAC,IAAI,EAAE,IAAI,SAAS,GAAG,EAAE,EAAE,MAAM,EAC5D,GAAG,GAAE,MAAW,oBAGE,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,YAC3C,2BAA2B,CACnC,IAAI,EACJ,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,CACtC,KACA,CAAC,IAAI,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,IAAI,KAAK,MAAM,CAYzC"}

package/dist/src/debug.js

@@ -0,0 +1,28 @@
+import debugLib from "debug";
+/**
+ * A simple decorator that adds debug logging for when a method is entered and exited.
+ *
+ * This decorator is meant to be used for debugging purposes only. It should not be committed in runtime code.
+ *
+ * Example usage:
+ *
+ * ```
+ * class MyClass {
+ *   @withDebugLogs("MyClass:exampleClassMethod")
+ *   public function exampleClassMethod(...)
+ * }
+ * ```
+ */
+export function withDebugLogs(tag = "") {
+    return function actualDecorator(originalMethod, _context) {
+        const log = debugLib(`hardhat:dev:core${tag === "" ? "" : `:${tag}`}`);
+        function replacementMethod(...args) {
+            log(`Entering method with args:`, args);
+            const result = originalMethod.call(this, ...args);
+            log(`Exiting method.`);
+            return result;
+        }
+        return replacementMethod;
+    };
+}
+//# sourceMappingURL=debug.js.map

package/dist/src/debug.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"debug.js","sourceRoot":"","sources":["../../src/debug.ts"],"names":[],"mappings":"AAAA,OAAO,QAAQ,MAAM,OAAO,CAAC;AAE7B;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,aAAa,CAC3B,MAAc,EAAE;IAEhB,OAAO,SAAS,eAAe,CAC7B,cAAqD,EACrD,QAGC;QAED,MAAM,GAAG,GAAG,QAAQ,CAAC,mBAAmB,GAAG,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,EAAE,EAAE,CAAC,CAAC;QAEvE,SAAS,iBAAiB,CAAa,GAAG,IAAU;YAClD,GAAG,CAAC,4BAA4B,EAAE,IAAI,CAAC,CAAC;YACxC,MAAM,MAAM,GAAG,cAAc,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,CAAC,CAAC;YAClD,GAAG,CAAC,iBAAiB,CAAC,CAAC;YACvB,OAAO,MAAM,CAAC;QAChB,CAAC;QAED,OAAO,iBAAiB,CAAC;IAC3B,CAAC,CAAC;AACJ,CAAC"}

package/dist/src/error.d.ts

@@ -0,0 +1,80 @@
+/**
+ * Abstract custom error class, which inherits from the built-in Error class,
+ * making sure that the standard errror properties are set, and the stack trace
+ * is not polluted with the custom error class' code.
+ *
+ * This class supports the `cause` property, which can be used to pass the
+ * original error that caused the custom error to be thrown. Note that it needs
+ * to be an instance of the built-in Error class, or a subclass of it. See `ensureError`
+ * for a convinient way of using it.
+ *
+ * @example
+ * ```ts
+ * class MyCustomError extends CustomError {
+ * }
+ *
+ * try {
+ *   mayThrow();
+ * } catch (error) {
+ *   ensureError(error);
+ *   throw new MyCustomError('Something went wrong', error);
+ * }
+ * ```
+ */
+export declare abstract class CustomError extends Error {
+    stack: string;
+    constructor(message: string, cause?: Error);
+}
+/**
+ * Ensures that the provided value is an instance of an error.
+ *
+ * @example
+ * This function is meant to be used in a catch block to ensure that you caught the right error.
+ *
+ * ```ts
+ * // Ensuring that you got an Error
+ * try {
+ *   mayThrow();
+ * } catch (error) {
+ *   ensureError(error);
+ *   console.err(error.message);
+ * }
+ *
+ * // Ensuring that you got a specific error
+ * try {
+ *   mayThrow();
+ * } catch (error) {
+ *   ensureError(error, MyError);
+ *   console.err(error.myMessage());
+ * }
+ * ```
+ *
+ * @param thrown The value to check.
+ * @param ErrorType The error type to check against.
+ * @throws The value if its not an instance of the specified error type.
+ */
+export declare function ensureError<ErrorT extends Error>(thrown: unknown, ErrorType?: new (...args: any[]) => ErrorT): asserts thrown is ErrorT;
+/**
+ * Throws an error for an unreachable code path. This function is typically
+ * used in a default case of a switch statement where all possible values of
+ * the switched variable should be handled in other cases. If the default case
+ * is reached, it means that an unexpected value was encountered, so an error
+ * is thrown.
+ *
+ * Note: The `@typescript-eslint/switch-exhaustiveness-check` rule checks for
+ * exhaustiveness in switch statements by comparing the types of the switch
+ * expression and the case clauses. However, it only works with union types and
+ * enum types. If you're switching on the result of the `typeof` operator or
+ * any other expression that doesn't return a union type or an enum type, this
+ * rule cannot enforce exhaustiveness. In such cases, you can use this function
+ * in the default case to ensure that an error is thrown if an unexpected value
+ * is encountered.
+ *
+ * @param _value The unexpected value. This parameter is unused and is only for
+ * the purpose of type checking.
+ * @param error The error to throw.
+ * @returns This function never returns normally. It always throws an error.
+ * @throws Will throw an error when called.
+ */
+export declare function unreachable(_value: never, error: Error): never;
+//# sourceMappingURL=error.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"error.d.ts","sourceRoot":"","sources":["../../src/error.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,8BAAsB,WAAY,SAAQ,KAAK;IAC7B,KAAK,EAAG,MAAM,CAAC;gBAEnB,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,KAAK;CAK3C;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,wBAAgB,WAAW,CAAC,MAAM,SAAS,KAAK,EAC9C,MAAM,EAAE,OAAO,EACf,SAAS,CAAC,EAAE,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,MAAM,GACzC,OAAO,CAAC,MAAM,IAAI,MAAM,CAc1B;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,wBAAgB,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,GAAG,KAAK,CAE9D"}