@across-protocol/sdk 3.0.0

package/dist/esm/utils/FormattingUtils.js

@@ -0,0 +1,167 @@
+import { ethers } from "ethers";
+import { toBN } from "./BigNumberUtils";
+import { fromWei } from "./common";
+import assert from "assert";
+import { BigNumber } from "bignumber.js";
+// Formats the input to round to decimalPlaces number of decimals if the number has a magnitude larger than 1 and fixes
+// precision to minPrecision if the number has a magnitude less than 1.
+export var formatWithMaxDecimals = function (num, decimalPlaces, minPrecision, roundUp, showSign) {
+    if (roundUp) {
+        BigNumber.set({ ROUNDING_MODE: BigNumber.ROUND_UP });
+    }
+    else {
+        BigNumber.set({ ROUNDING_MODE: BigNumber.ROUND_DOWN });
+    }
+    var fullPrecisionFloat = new BigNumber(num);
+    var positiveSign = showSign && fullPrecisionFloat.gt(0) ? "+" : "";
+    var fixedPrecisionFloat;
+    // Convert back to BN to truncate any trailing 0s that the toFixed() output would print. If the number is equal to or larger than
+    // 1 then truncate to `decimalPlaces` number of decimal places. EG 999.999 -> 999.99 with decimalPlaces=2 If the number
+    // is less than 1 then truncate to minPrecision precision. EG: 0.0022183471 -> 0.002218 with minPrecision=4
+    if (fullPrecisionFloat.abs().gte(new BigNumber(1))) {
+        fixedPrecisionFloat = new BigNumber(fullPrecisionFloat).toFixed(decimalPlaces).toString();
+    }
+    else {
+        fixedPrecisionFloat = new BigNumber(fullPrecisionFloat).toPrecision(minPrecision).toString();
+    }
+    // This puts commas in the thousands places, but only before the decimal point.
+    var fixedPrecisionFloatParts = fixedPrecisionFloat.split(".");
+    fixedPrecisionFloatParts[0] = fixedPrecisionFloatParts[0].replace(/\B(?=(\d{3})+(?!\d))/g, ",");
+    return positiveSign + fixedPrecisionFloatParts.join(".");
+};
+export var createFormatFunction = function (numDisplayedDecimals, minDisplayedPrecision, showSign, decimals) {
+    if (showSign === void 0) { showSign = false; }
+    if (decimals === void 0) { decimals = 18; }
+    return function (valInWei) {
+        return formatWithMaxDecimals(formatWei(ConvertDecimals(decimals, 18)(valInWei)), numDisplayedDecimals, minDisplayedPrecision, false, showSign);
+    };
+};
+export var formatFeePct = function (relayerFeePct) {
+    // 1e18 = 100% so 1e16 = 1%.
+    return createFormatFunction(2, 4, false, 16)(toBN(relayerFeePct).toString());
+};
+/**
+ * Shortens a lengthy hexadecimal string to a shorter version with an ellipsis in the middle.
+ * @param hex A hexadecimal string to be shortened.
+ * @param maxLength The maximum length of the shortened string. Defaults to 8.
+ * @param delimiter The delimiter to use in the middle of the shortened string. Defaults to "...".
+ * @returns The shortened hexadecimal string.
+ * @example createShortHexString("0x772871a444c6e4e9903d8533a5a13101b74037158123e6709470f0afbf6e7d94") -> "0x7787...7d94"
+ */
+export function createShortHexString(hex, maxLength, delimiter) {
+    if (maxLength === void 0) { maxLength = 8; }
+    if (delimiter === void 0) { delimiter = ".."; }
+    // If we have more maxLength then the hex size, we can simply
+    // return the hex directly.
+    if (hex.length <= maxLength) {
+        return hex;
+    }
+    // Resolve the maximum available after we account for the delimiter.
+    var maxAvailable = maxLength - delimiter.length;
+    // Sanity check to make sure we have enough characters to
+    // create a shortened version.
+    if (maxAvailable <= 0) {
+        throw new Error("Invalid max length");
+    }
+    // We can simulate rounding by adding 0.5 to the integer. If
+    // we had an odd division, the floor will add one additional
+    // character to the left side.
+    var leftCharacters = Math.floor(maxAvailable / 2 + 0.5);
+    // A simple floor division between the max character length
+    var rightCharacters = Math.floor(maxAvailable / 2);
+    // Combine the two sides with the delimiter in the middle.
+    return "".concat(hex.substring(0, leftCharacters)).concat(delimiter).concat(hex.substring(hex.length - rightCharacters));
+}
+/**
+ * Converts a utf8 string to a hex string.
+ * @param input The utf8 string to convert.
+ * @returns The hex string.
+ */
+export function utf8ToHex(input) {
+    return ethers.utils.formatBytes32String(input);
+}
+/**
+ * Converts a hexadecimal string to a utf8 string.
+ * @param input The hexadecimal string to convert.
+ * @returns The utf8 string.
+ */
+export function hexToUtf8(input) {
+    return ethers.utils.toUtf8String(input);
+}
+/**
+ * Converts a BigNumber to a 32-byte hexadecimal string.
+ *
+ * @param input - The BigNumber to convert.
+ * @returns The 32-byte hexadecimal string representation of the input.
+ */
+export function bnToHex(input) {
+    return ethers.utils.hexZeroPad(ethers.utils.hexlify(toBN(input)), 32);
+}
+/**
+ * Converts a value from wei to a decimal value with the specified number of decimal places.
+ * @param weiVal - The value in wei to convert.
+ * @param decimals - The number of decimal places to include in the converted value.
+ * @returns The converted value as a string.
+ */
+export function convertFromWei(weiVal, decimals) {
+    var formatFunction = createFormatFunction(2, 4, false, decimals);
+    return formatFunction(weiVal);
+}
+/**
+ * Shortens a list of addresses to a shorter version with only the first 10 characters.
+ * @param addresses A list of addresses to shorten.
+ * @returns A list of shortened addresses.
+ * @see createShortHexString
+ */
+export function shortenHexStrings(addresses) {
+    return addresses.map(function (h) { return createShortHexString(h); });
+}
+// formatWei converts a string or BN instance from Wei to Ether, e.g., 1e19 -> 10.
+export var formatWei = function (num) {
+    // Web3's `fromWei` function doesn't work on BN objects in minified mode (e.g.,
+    // `web3.utils.isBN(web3.utils.fromBN("5"))` is false), so we use a workaround where we always pass in strings.
+    // See https://github.com/ethereum/web3.js/issues/1777.
+    return fromWei(num.toString());
+};
+// Take an amount based on fromDecimals and convert it to an amount based on toDecimals. For example 100 usdt = 100e6,
+// with 6 decimals. If you wanted to convert this to a base 18 decimals you would get:
+// convertDecimals(6,18)(100000000)  => 100000000000000000000 = 100e18.
+// Returns a BigNumber you will need to call toString on
+// fromDecimals: number - decimal value of amount
+// toDecimals: number - decimal value to convert to
+// web3: web3 object to get a big number function.
+// return => (amount:string)=>BN
+export var ConvertDecimals = function (fromDecimals, toDecimals) {
+    assert(fromDecimals >= 0, "requires fromDecimals as an integer >= 0");
+    assert(toDecimals >= 0, "requires toDecimals as an integer >= 0");
+    // amount: string, BN, number - integer amount in fromDecimals smallest unit that want to convert toDecimals
+    // returns: BN with toDecimals in smallest unit
+    return function (amountIn) {
+        var amount = toBN(amountIn.toString());
+        if (amount.isZero())
+            return amount;
+        var diff = fromDecimals - toDecimals;
+        if (diff == 0)
+            return amount;
+        if (diff > 0)
+            return amount.div(toBN("10").pow(toBN(diff.toString())));
+        return amount.mul(toBN("10").pow(toBN((-1 * diff).toString())));
+    };
+};
+/**
+ * Converts a numeric decimal-inclusive string to winston, the base unit of Arweave
+ * @param numericString The numeric string to convert
+ * @returns The winston representation of the numeric string as a BigNumber
+ */
+export function parseWinston(numericString) {
+    return ethers.utils.parseUnits(numericString, 12);
+}
+/**
+ * Converts a winston value to a numeric string
+ * @param winstonValue The winston value to convert
+ * @returns The numeric string representation of the winston value
+ */
+export function formatWinston(winstonValue) {
+    return ethers.utils.formatUnits(winstonValue, 12);
+}
+//# sourceMappingURL=FormattingUtils.js.map

package/dist/esm/utils/FormattingUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"FormattingUtils.js","sourceRoot":"","sources":["../../../src/utils/FormattingUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAChC,OAAO,EAAM,IAAI,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAC;AACnC,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC,uHAAuH;AACvH,uEAAuE;AACvE,MAAM,CAAC,IAAM,qBAAqB,GAAG,UACnC,GAAoB,EACpB,aAAqB,EACrB,YAAoB,EACpB,OAAgB,EAChB,QAAiB;IAEjB,IAAI,OAAO,EAAE;QACX,SAAS,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;KACtD;SAAM;QACL,SAAS,CAAC,GAAG,CAAC,EAAE,aAAa,EAAE,SAAS,CAAC,UAAU,EAAE,CAAC,CAAC;KACxD;IAED,IAAM,kBAAkB,GAAG,IAAI,SAAS,CAAC,GAAG,CAAC,CAAC;IAC9C,IAAM,YAAY,GAAG,QAAQ,IAAI,kBAAkB,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IACrE,IAAI,mBAAmB,CAAC;IACxB,iIAAiI;IACjI,uHAAuH;IACvH,2GAA2G;IAC3G,IAAI,kBAAkB,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE;QAClD,mBAAmB,GAAG,IAAI,SAAS,CAAC,kBAAkB,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC;KAC3F;SAAM;QACL,mBAAmB,GAAG,IAAI,SAAS,CAAC,kBAAkB,CAAC,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC,QAAQ,EAAE,CAAC;KAC9F;IACD,+EAA+E;IAC/E,IAAM,wBAAwB,GAAG,mBAAmB,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IAChE,wBAAwB,CAAC,CAAC,CAAC,GAAG,wBAAwB,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,uBAAuB,EAAE,GAAG,CAAC,CAAC;IAChG,OAAO,YAAY,GAAG,wBAAwB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC3D,CAAC,CAAC;AAEF,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAClC,oBAA4B,EAC5B,qBAA6B,EAC7B,QAAgB,EAChB,QAAa;IADb,yBAAA,EAAA,gBAAgB;IAChB,yBAAA,EAAA,aAAa;IAEb,OAAO,UAAC,QAAqB;QAC3B,OAAA,qBAAqB,CACnB,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAClD,oBAAoB,EACpB,qBAAqB,EACrB,KAAK,EACL,QAAQ,CACT;IAND,CAMC,CAAC;AACN,CAAC,CAAC;AACF,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,aAAiB;IAC5C,4BAA4B;IAC5B,OAAO,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC;AAC/E,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,UAAU,oBAAoB,CAAC,GAAW,EAAE,SAAa,EAAE,SAAgB;IAA/B,0BAAA,EAAA,aAAa;IAAE,0BAAA,EAAA,gBAAgB;IAC/E,6DAA6D;IAC7D,2BAA2B;IAC3B,IAAI,GAAG,CAAC,MAAM,IAAI,SAAS,EAAE;QAC3B,OAAO,GAAG,CAAC;KACZ;IACD,oEAAoE;IACpE,IAAM,YAAY,GAAG,SAAS,GAAG,SAAS,CAAC,MAAM,CAAC;IAClD,yDAAyD;IACzD,8BAA8B;IAC9B,IAAI,YAAY,IAAI,CAAC,EAAE;QACrB,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;KACvC;IACD,4DAA4D;IAC5D,4DAA4D;IAC5D,8BAA8B;IAC9B,IAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC;IAC1D,2DAA2D;IAC3D,IAAM,eAAe,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;IACrD,0DAA0D;IAC1D,OAAO,UAAG,GAAG,CAAC,SAAS,CAAC,CAAC,EAAE,cAAc,CAAC,SAAG,SAAS,SAAG,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,MAAM,GAAG,eAAe,CAAC,CAAE,CAAC;AACzG,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,mBAAmB,CAAC,KAAK,CAAC,CAAC;AACjD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,KAAa;IACrC,OAAO,MAAM,CAAC,KAAK,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;AAC1C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,OAAO,CAAC,KAAS;IAC/B,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,MAAc,EAAE,QAAgB;IAC7D,IAAM,cAAc,GAAG,oBAAoB,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,CAAC;IACnE,OAAO,cAAc,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,iBAAiB,CAAC,SAAmB;IACnD,OAAO,SAAS,CAAC,GAAG,CAAC,UAAC,CAAC,IAAK,OAAA,oBAAoB,CAAC,CAAC,CAAC,EAAvB,CAAuB,CAAC,CAAC;AACvD,CAAC;AAED,kFAAkF;AAClF,MAAM,CAAC,IAAM,SAAS,GAAG,UAAC,GAAgB;IACxC,+EAA+E;IAC/E,+GAA+G;IAC/G,uDAAuD;IACvD,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,CAAC,CAAC;AACjC,CAAC,CAAC;AAEF,sHAAsH;AACtH,sFAAsF;AACtF,uEAAuE;AACvE,wDAAwD;AACxD,iDAAiD;AACjD,mDAAmD;AACnD,kDAAkD;AAClD,gCAAgC;AAChC,MAAM,CAAC,IAAM,eAAe,GAAG,UAAC,YAAoB,EAAE,UAAkB;IACtE,MAAM,CAAC,YAAY,IAAI,CAAC,EAAE,0CAA0C,CAAC,CAAC;IACtE,MAAM,CAAC,UAAU,IAAI,CAAC,EAAE,wCAAwC,CAAC,CAAC;IAClE,4GAA4G;IAC5G,+CAA+C;IAC/C,OAAO,UAAC,QAA8B;QACpC,IAAM,MAAM,GAAG,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC,CAAC;QACzC,IAAI,MAAM,CAAC,MAAM,EAAE;YAAE,OAAO,MAAM,CAAC;QACnC,IAAM,IAAI,GAAG,YAAY,GAAG,UAAU,CAAC;QACvC,IAAI,IAAI,IAAI,CAAC;YAAE,OAAO,MAAM,CAAC;QAC7B,IAAI,IAAI,GAAG,CAAC;YAAE,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;QACvE,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,CAAC;IAClE,CAAC,CAAC;AACJ,CAAC,CAAC;AAEF;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,aAAqB;IAChD,OAAO,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC,aAAa,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,YAA8B;IAC1D,OAAO,MAAM,CAAC,KAAK,CAAC,WAAW,CAAC,YAAY,EAAE,EAAE,CAAC,CAAC;AACpD,CAAC"}

package/dist/esm/utils/IPFSUtils.d.ts

@@ -0,0 +1,24 @@
+import PinataClient from "@pinata/sdk";
+/**
+ * Build an IPFS client for interacting with the IPFS API
+ * @param APIKey The project ID
+ * @param secretAPIKey The project secret
+ * @returns An IPFS client for interacting with Pinata
+ */
+export declare function buildIPFSClient(APIKey: string, secretAPIKey: string): PinataClient;
+/**
+ * Retrieves a value from an IPFS gateway
+ * @param contentHash The content hash of the value to retrieve
+ * @param publicGatewayURL The URL of the public IPFS gateway to use
+ * @returns The value retrieved from the IPFS gateway
+ * @throws Error if the value could not be retrieved
+ */
+export declare function retrieveValueFromIPFS(contentHash: string, publicGatewayURL: string): Promise<string>;
+/**
+ * Pins a value to the IPFS network
+ * @param key A key to use for pinning the value. This is a metadata field.
+ * @param content The value to pin
+ * @param client The IPFS client to use
+ * @returns The content hash of the pinned value
+ */
+export declare function storeValueInIPFS(key: string, content: string, client: PinataClient): Promise<string>;

package/dist/esm/utils/IPFSUtils.js

@@ -0,0 +1,65 @@
+import { __awaiter, __generator } from "tslib";
+import PinataClient from "@pinata/sdk";
+import axios from "axios";
+/**
+ * Build an IPFS client for interacting with the IPFS API
+ * @param APIKey The project ID
+ * @param secretAPIKey The project secret
+ * @returns An IPFS client for interacting with Pinata
+ */
+export function buildIPFSClient(APIKey, secretAPIKey) {
+    return new PinataClient(APIKey, secretAPIKey);
+}
+/**
+ * Retrieves a value from an IPFS gateway
+ * @param contentHash The content hash of the value to retrieve
+ * @param publicGatewayURL The URL of the public IPFS gateway to use
+ * @returns The value retrieved from the IPFS gateway
+ * @throws Error if the value could not be retrieved
+ */
+export function retrieveValueFromIPFS(contentHash, publicGatewayURL) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, axios.get("".concat(publicGatewayURL, "/ipfs/").concat(contentHash), {
+                        // We need to set the Accept header to text/plain to avoid
+                        // any anomalies with the response
+                        headers: {
+                            Accept: "text/plain",
+                        },
+                        // We want just the raw response, not the parsed response
+                        transformResponse: function (r) { return r; },
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result.data];
+            }
+        });
+    });
+}
+/**
+ * Pins a value to the IPFS network
+ * @param key A key to use for pinning the value. This is a metadata field.
+ * @param content The value to pin
+ * @param client The IPFS client to use
+ * @returns The content hash of the pinned value
+ */
+export function storeValueInIPFS(key, content, client) {
+    return __awaiter(this, void 0, void 0, function () {
+        var result;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0: return [4 /*yield*/, client.pinJSONToIPFS(JSON.parse(content), {
+                        pinataMetadata: {
+                            name: key,
+                        },
+                    })];
+                case 1:
+                    result = _a.sent();
+                    return [2 /*return*/, result.IpfsHash];
+            }
+        });
+    });
+}
+//# sourceMappingURL=IPFSUtils.js.map

package/dist/esm/utils/IPFSUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IPFSUtils.js","sourceRoot":"","sources":["../../../src/utils/IPFSUtils.ts"],"names":[],"mappings":";AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AACvC,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc,EAAE,YAAoB;IAClE,OAAO,IAAI,YAAY,CAAC,MAAM,EAAE,YAAY,CAAC,CAAC;AAChD,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,qBAAqB,CAAC,WAAmB,EAAE,gBAAwB;;;;;wBACxE,qBAAM,KAAK,CAAC,GAAG,CAAC,UAAG,gBAAgB,mBAAS,WAAW,CAAE,EAAE;wBACxE,0DAA0D;wBAC1D,kCAAkC;wBAClC,OAAO,EAAE;4BACP,MAAM,EAAE,YAAY;yBACrB;wBACD,yDAAyD;wBACzD,iBAAiB,EAAE,UAAC,CAAC,IAAK,OAAA,CAAC,EAAD,CAAC;qBAC5B,CAAC,EAAA;;oBARI,MAAM,GAAG,SAQb;oBACF,sBAAO,MAAM,CAAC,IAAI,EAAC;;;;CACpB;AAED;;;;;;GAMG;AACH,MAAM,UAAgB,gBAAgB,CAAC,GAAW,EAAE,OAAe,EAAE,MAAoB;;;;;wBACxE,qBAAM,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE;wBAC7D,cAAc,EAAE;4BACd,IAAI,EAAE,GAAG;yBACV;qBACF,CAAC,EAAA;;oBAJI,MAAM,GAAG,SAIb;oBACF,sBAAO,MAAM,CAAC,QAAQ,EAAC;;;;CACxB"}

package/dist/esm/utils/JSONUtils.d.ts

@@ -0,0 +1,31 @@
+/**
+ * This function converts a JSON string into a JSON object. The caveat is that if
+ * the parser detects a number, it will convert it to a string and floor it to
+ * an integer. This function will not throw but instead return an undefined value
+ * if the JSON string is invalid.
+ * @param jsonString The JSON string to parse
+ * @returns The parsed JSON object or undefined if the JSON string is invalid
+ */
+export declare function parseJSONWithNumericString(jsonString: string): unknown | undefined;
+/**
+ * This function converts an object into a JSON string. The caveat is that if
+ * the parser detects a BigNumber or BN, it will convert it to a string.
+ * @param obj The object to stringify
+ * @returns The stringified JSON object
+ * @throws Error if the object cannot be stringified
+ */
+export declare function stringifyJSONWithNumericString(obj: unknown): string;
+/**
+ * A replacer for use in `JSON.stringify` that converts big numbers to numeric strings.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export declare function jsonReplacerWithBigNumbers(_key: string, value: unknown): unknown;
+/**
+ * A reviver for use in `JSON.parse` that converts numeric strings to big numbers.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export declare function jsonReviverWithBigNumbers(_key: string, value: unknown): unknown;

package/dist/esm/utils/JSONUtils.js

@@ -0,0 +1,82 @@
+import { BigNumber } from "ethers";
+import { isDefined } from "./TypeGuards";
+/**
+ * This function converts a JSON string into a JSON object. The caveat is that if
+ * the parser detects a number, it will convert it to a string and floor it to
+ * an integer. This function will not throw but instead return an undefined value
+ * if the JSON string is invalid.
+ * @param jsonString The JSON string to parse
+ * @returns The parsed JSON object or undefined if the JSON string is invalid
+ */
+export function parseJSONWithNumericString(jsonString) {
+    try {
+        return JSON.parse(jsonString, function (_key, value) {
+            if (typeof value === "number") {
+                return String(Math.floor(value));
+            }
+            return value;
+        });
+    }
+    catch (e) {
+        return undefined;
+    }
+}
+/**
+ * This function converts an object into a JSON string. The caveat is that if
+ * the parser detects a BigNumber or BN, it will convert it to a string.
+ * @param obj The object to stringify
+ * @returns The stringified JSON object
+ * @throws Error if the object cannot be stringified
+ */
+export function stringifyJSONWithNumericString(obj) {
+    return JSON.stringify(obj, function (_key, value) {
+        if (typeof value === "object" && value !== null && value.type === "BigNumber") {
+            return BigNumber.from(value).toString();
+        }
+        return value;
+    });
+}
+/**
+ * A replacer for use in `JSON.stringify` that converts big numbers to numeric strings.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export function jsonReplacerWithBigNumbers(_key, value) {
+    // If the value is not defined (null or undefined), return it as is
+    if (!isDefined(value)) {
+        return value;
+    }
+    // We need to check if this is a big number, because the JSON parser
+    // is not aware of BigNumbers and will convert them to the string representation
+    // of the object itself which is not what we want.
+    if (BigNumber.isBigNumber(value)) {
+        return value.toString();
+    }
+    // There's a legacy issues that returns BigNumbers as { type: "BigNumber", hex: "0x..." }
+    // so we need to check for that as well.
+    var recordValue = value;
+    if (recordValue.type === "BigNumber" && isDefined(recordValue.hex)) {
+        return BigNumber.from(recordValue.hex).toString();
+    }
+    // Return the value as is
+    return value;
+}
+/**
+ * A reviver for use in `JSON.parse` that converts numeric strings to big numbers.
+ * @param _key Unused
+ * @param value The value to convert
+ * @returns The converted value
+ */
+export function jsonReviverWithBigNumbers(_key, value) {
+    // We need to check for both strings and big numbers, because the JSON parser
+    // is not aware of BigNumbers.
+    if (typeof value === "string" && /^-?\d+$/.test(value)) {
+        var bigNumber = BigNumber.from(value);
+        if (bigNumber.toString() === value) {
+            return bigNumber;
+        }
+    }
+    return value;
+}
+//# sourceMappingURL=JSONUtils.js.map

package/dist/esm/utils/JSONUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"JSONUtils.js","sourceRoot":"","sources":["../../../src/utils/JSONUtils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACnC,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAEzC;;;;;;;GAOG;AACH,MAAM,UAAU,0BAA0B,CAAC,UAAkB;IAC3D,IAAI;QACF,OAAO,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,UAAC,IAAI,EAAE,KAAK;YACxC,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE;gBAC7B,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;aAClC;YACD,OAAO,KAAK,CAAC;QACf,CAAC,CAAC,CAAC;KACJ;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,SAAS,CAAC;KAClB;AACH,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,8BAA8B,CAAC,GAAY;IACzD,OAAO,IAAI,CAAC,SAAS,CAAC,GAAG,EAAE,UAAC,IAAI,EAAE,KAAK;QACrC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE;YAC7E,OAAO,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;SACzC;QACD,OAAO,KAAK,CAAC;IACf,CAAC,CAAC,CAAC;AACL,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,0BAA0B,CAAC,IAAY,EAAE,KAAc;IACrE,mEAAmE;IACnE,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,EAAE;QACrB,OAAO,KAAK,CAAC;KACd;IAED,oEAAoE;IACpE,gFAAgF;IAChF,kDAAkD;IAClD,IAAI,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,EAAE;QAChC,OAAO,KAAK,CAAC,QAAQ,EAAE,CAAC;KACzB;IACD,yFAAyF;IACzF,wCAAwC;IACxC,IAAM,WAAW,GAAG,KAAsC,CAAC;IAC3D,IAAI,WAAW,CAAC,IAAI,KAAK,WAAW,IAAI,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE;QAClE,OAAO,SAAS,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,CAAC;KACnD;IACD,yBAAyB;IACzB,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,yBAAyB,CAAC,IAAY,EAAE,KAAc;IACpE,6EAA6E;IAC7E,8BAA8B;IAC9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;QACtD,IAAM,SAAS,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,IAAI,SAAS,CAAC,QAAQ,EAAE,KAAK,KAAK,EAAE;YAClC,OAAO,SAAS,CAAC;SAClB;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/esm/utils/LogUtils.d.ts

@@ -0,0 +1,20 @@
+import { Logger } from "winston";
+export type DefaultLogLevels = "debug" | "info" | "warn" | "error";
+type LogParamType = {
+    level: DefaultLogLevels;
+    message: string;
+    at: {
+        location: string;
+        function: string;
+    };
+    data?: Record<string | number, unknown>;
+};
+export declare function formattedLog(logger: Logger | undefined, { level, message, at: { location, function: fnName }, data }: LogParamType): void;
+/**
+ * Asserts the truth of a condition. If the condition is false, an error is thrown with the provided message.
+ * @param condition The condition to assert.
+ * @param message The message to throw if the condition is false.
+ * @throws Error if the condition is false.
+ */
+export declare function assert(condition: boolean, message: string): void;
+export {};

package/dist/esm/utils/LogUtils.js

@@ -0,0 +1,19 @@
+import { __assign } from "tslib";
+export function formattedLog(logger, _a) {
+    var level = _a.level, message = _a.message, _b = _a.at, location = _b.location, fnName = _b.function, data = _a.data;
+    if (logger) {
+        logger[level](__assign({ at: "".concat(location, "#").concat(fnName), message: message }, data));
+    }
+}
+/**
+ * Asserts the truth of a condition. If the condition is false, an error is thrown with the provided message.
+ * @param condition The condition to assert.
+ * @param message The message to throw if the condition is false.
+ * @throws Error if the condition is false.
+ */
+export function assert(condition, message) {
+    if (!condition) {
+        throw new Error(message);
+    }
+}
+//# sourceMappingURL=LogUtils.js.map

package/dist/esm/utils/LogUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"LogUtils.js","sourceRoot":"","sources":["../../../src/utils/LogUtils.ts"],"names":[],"mappings":";AAcA,MAAM,UAAU,YAAY,CAC1B,MAA0B,EAC1B,EAA0E;QAAxE,KAAK,WAAA,EAAE,OAAO,aAAA,EAAE,UAAkC,EAA5B,QAAQ,cAAA,EAAY,MAAM,cAAA,EAAI,IAAI,UAAA;IAE1D,IAAI,MAAM,EAAE;QACV,MAAM,CAAC,KAAK,CAAC,YACX,EAAE,EAAE,UAAG,QAAQ,cAAI,MAAM,CAAE,EAC3B,OAAO,SAAA,IACJ,IAAI,EACP,CAAC;KACJ;AACH,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,MAAM,CAAC,SAAkB,EAAE,OAAe;IACxD,IAAI,CAAC,SAAS,EAAE;QACd,MAAM,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC;KAC1B;AACH,CAAC"}

package/dist/esm/utils/Multicall.d.ts

@@ -0,0 +1,13 @@
+import { Contract, providers, Signer, utils as ethersUtils } from "ethers";
+type Provider = providers.Provider;
+type BlockTag = providers.BlockTag;
+type Result = ethersUtils.Result;
+export type Call3 = {
+    contract: Contract;
+    method: string;
+    args?: any[];
+};
+export declare const multicall3Addresses: Record<number, string>;
+export declare function getMulticall3(chainId: number, signerOrProvider?: Signer | Provider): Promise<Contract | undefined>;
+export declare function aggregate(multicall3: Contract, calls: Call3[], blockTag?: BlockTag): Promise<Result[]>;
+export {};

package/dist/esm/utils/Multicall.js

@@ -0,0 +1,70 @@
+import { __awaiter, __generator } from "tslib";
+import { Contract } from "ethers";
+import { getABI } from "./abi";
+// Multicall3 Constants:
+export var multicall3Addresses = {
+    1: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    10: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    137: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    324: "0xF9cda624FBC7e059355ce98a31693d299FACd963",
+    8453: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    34443: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    42161: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    59144: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    534352: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    // Testnets
+    5: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    300: "0xF9cda624FBC7e059355ce98a31693d299FACd963",
+    59140: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    59141: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    80002: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    84531: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    84532: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    421613: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    534351: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    11155111: "0xcA11bde05977b3631167028862bE2a173976CA11",
+    11155420: "0xcA11bde05977b3631167028862bE2a173976CA11",
+};
+export function getMulticall3(chainId, signerOrProvider) {
+    return __awaiter(this, void 0, void 0, function () {
+        var address, _a, _b;
+        return __generator(this, function (_c) {
+            switch (_c.label) {
+                case 0:
+                    address = multicall3Addresses[chainId];
+                    if (!address) {
+                        return [2 /*return*/, undefined];
+                    }
+                    _a = Contract.bind;
+                    _b = [void 0, address];
+                    return [4 /*yield*/, getABI("Multicall3")];
+                case 1: return [2 /*return*/, new (_a.apply(Contract, _b.concat([_c.sent(), signerOrProvider])))()];
+            }
+        });
+    });
+}
+export function aggregate(multicall3, calls, blockTag) {
+    return __awaiter(this, void 0, void 0, function () {
+        var inputs, _a, results;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    inputs = calls.map(function (_a) {
+                        var contract = _a.contract, method = _a.method, args = _a.args;
+                        return ({
+                            target: contract.address,
+                            callData: contract.interface.encodeFunctionData(method, args),
+                        });
+                    });
+                    return [4 /*yield*/, multicall3.callStatic.aggregate(inputs, { blockTag: blockTag })];
+                case 1:
+                    _a = _b.sent(), results = _a[1];
+                    return [2 /*return*/, results.map(function (result, idx) {
+                            var _a = calls[idx], contract = _a.contract, method = _a.method;
+                            return contract.interface.decodeFunctionResult(method, result);
+                        })];
+            }
+        });
+    });
+}
+//# sourceMappingURL=Multicall.js.map

package/dist/esm/utils/Multicall.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Multicall.js","sourceRoot":"","sources":["../../../src/utils/Multicall.ts"],"names":[],"mappings":";AAAA,OAAO,EAAa,QAAQ,EAA2C,MAAM,QAAQ,CAAC;AACtF,OAAO,EAAE,MAAM,EAAE,MAAM,OAAO,CAAC;AAa/B,wBAAwB;AACxB,MAAM,CAAC,IAAM,mBAAmB,GAA2B;IACzD,CAAC,EAAE,4CAA4C;IAC/C,EAAE,EAAE,4CAA4C;IAChD,GAAG,EAAE,4CAA4C;IACjD,GAAG,EAAE,4CAA4C;IACjD,IAAI,EAAE,4CAA4C;IAClD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,MAAM,EAAE,4CAA4C;IACpD,WAAW;IACX,CAAC,EAAE,4CAA4C;IAC/C,GAAG,EAAE,4CAA4C;IACjD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,KAAK,EAAE,4CAA4C;IACnD,MAAM,EAAE,4CAA4C;IACpD,MAAM,EAAE,4CAA4C;IACpD,QAAQ,EAAE,4CAA4C;IACtD,QAAQ,EAAE,4CAA4C;CACvD,CAAC;AAEF,MAAM,UAAgB,aAAa,CACjC,OAAe,EACf,gBAAoC;;;;;;oBAE9B,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;oBAC7C,IAAI,CAAC,OAAO,EAAE;wBACZ,sBAAO,SAAS,EAAC;qBAClB;yBAEU,QAAQ;kCAAC,OAAO;oBAAE,qBAAM,MAAM,CAAC,YAAY,CAAC,EAAA;wBAAvD,sBAAO,cAAI,QAAQ,aAAU,SAA0B,EAAE,gBAAgB,MAAC,EAAC;;;;CAC5E;AAED,MAAM,UAAgB,SAAS,CAAC,UAAoB,EAAE,KAAc,EAAE,QAAmB;;;;;;oBACjF,MAAM,GAAG,KAAK,CAAC,GAAG,CAAC,UAAC,EAA0B;4BAAxB,QAAQ,cAAA,EAAE,MAAM,YAAA,EAAE,IAAI,UAAA;wBAAO,OAAA,CAAC;4BACxD,MAAM,EAAE,QAAQ,CAAC,OAAO;4BACxB,QAAQ,EAAE,QAAQ,CAAC,SAAS,CAAC,kBAAkB,CAAC,MAAM,EAAE,IAAI,CAAC;yBAC9D,CAAC;oBAHuD,CAGvD,CAAC,CAAC;oBAEgB,qBAAO,UAAU,CAAC,UAAU,CAAC,SAAS,CAAC,MAAM,EAAE,EAAE,QAAQ,UAAA,EAAE,CAAoC,EAAA;;oBAA7G,KAAc,SAA+F,EAA1G,OAAO,QAAA;oBAEhB,sBAAO,OAAO,CAAC,GAAG,CAAC,UAAC,MAAM,EAAE,GAAG;4BACvB,IAAA,KAAuB,KAAK,CAAC,GAAG,CAAC,EAA/B,QAAQ,cAAA,EAAE,MAAM,YAAe,CAAC;4BACxC,OAAO,QAAQ,CAAC,SAAS,CAAC,oBAAoB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;wBACjE,CAAC,CAAC,EAAC;;;;CACJ"}

package/dist/esm/utils/NetworkUtils.d.ts

@@ -0,0 +1,60 @@
+/**
+ * Resolves a network name from a network id.
+ * @param networkId The network id to resolve the name for
+ * @returns The network name for the network id. If the network id is not found, returns "unknown"
+ */
+export declare function getNetworkName(networkId: number | string): string;
+/**
+ * Resolves a native token symbol from a chain id.
+ * @param chainId The chain id to resolve the native token symbol for
+ * @returns The native token symbol for the chain id. If the chain id is not found, returns "ETH"
+ */
+export declare function getNativeTokenSymbol(chainId: number | string): string;
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export declare function chainIsProd(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is part of the production network.
+ * @param chainId Chain ID to query.
+ * @returns true if the chain ID is part of the production network, otherwise false.
+ */
+export declare function chainIsTestnet(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is a Polygon implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Polygon chain (mainnet or testnet), otherwise false.
+ */
+export declare function chainIsMatic(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is an Optimism OP Stack implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an OP stack, otherwise false.
+ */
+export declare function chainIsOPStack(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is an Arbitrum implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is an Arbitrum chain, otherwise false.
+ */
+export declare function chainIsArbitrum(chainId: number): boolean;
+/**
+ * Determines whether a chain ID is a Linea implementation.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a Linea chain, otherwise false.
+ */
+export declare function chainIsLinea(chainId: number): boolean;
+/**
+ * Determines whether a chain ID has the capacity for having its USDC bridged via CCTP.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId is a CCTP-bridging enabled chain, otherwise false.
+ */
+export declare function chainIsCCTPEnabled(chainId: number): boolean;
+/**
+ * Determines if a chain ID requires a manual L1 -> L2 finalization step.
+ * @param chainId Chain ID to evaluate.
+ * @returns True if chainId requires manual L1 -> L2 finalization, otherwise false.
+ */
+export declare function chainRequiresL1ToL2Finalization(chainId: number): boolean;