@opensea/sdk 9.0.0

package/lib/src/utils/protocol.d.ts

@@ -0,0 +1,75 @@
+import type { Seaport } from "@opensea/seaport-js";
+import { ItemType } from "@opensea/seaport-js/lib/constants";
+import type { TokenStandard } from "../types";
+/**
+ * Gets the appropriate ItemType for a given token standard.
+ * @param tokenStandard The token standard (ERC20, ERC721, ERC1155)
+ * @returns The corresponding ItemType from Seaport
+ */
+export declare const getAssetItemType: (tokenStandard: TokenStandard) => ItemType.ERC20 | ItemType.ERC721 | ItemType.ERC1155;
+/**
+ * Remaps shared storefront token addresses to the lazy mint adapter address.
+ *
+ * OpenSea's shared storefront contracts require special handling - when a token
+ * is from a shared storefront address, it must be remapped to the lazy mint
+ * adapter address for proper Seaport order creation.
+ *
+ * @param tokenAddress The token contract address to check
+ * @returns The lazy mint adapter address if the input is a shared storefront address,
+ *          otherwise returns the original address unchanged
+ */
+export declare const remapSharedStorefrontAddress: (tokenAddress: string) => string;
+/**
+ * Returns if a protocol address is valid.
+ * @param protocolAddress The protocol address
+ */
+export declare const isValidProtocol: (protocolAddress: string) => boolean;
+/**
+ * Throws an error if the protocol address is not valid.
+ * @param protocolAddress The protocol address
+ */
+export declare const requireValidProtocol: (protocolAddress: string) => void;
+/**
+ * Get the Seaport instance for a given protocol address.
+ * This is a shared utility to avoid duplicating the logic across multiple SDK manager classes.
+ * @param protocolAddress The protocol address
+ * @param seaport The Seaport instance
+ * @returns The Seaport instance for the given protocol address
+ * @throws Error if the protocol address is not supported
+ */
+export declare const getSeaportInstance: (protocolAddress: string, seaport: Seaport) => Seaport;
+/**
+ * Get the Seaport version string for a given protocol address.
+ * @param protocolAddress The protocol address
+ * @returns The version string (e.g., "1.6")
+ * @throws Error if the protocol address is not supported
+ */
+export declare const getSeaportVersion: (protocolAddress: string) => string;
+/**
+ * Decodes an encoded string of token IDs into an array of individual token IDs using bigint for precise calculations.
+ *
+ * The encoded token IDs can be in the following formats:
+ * 1. Single numbers: '123' => ['123']
+ * 2. Comma-separated numbers: '1,2,3,4' => ['1', '2', '3', '4']
+ * 3. Ranges of numbers: '5:8' => ['5', '6', '7', '8']
+ * 4. Combinations of single numbers and ranges: '1,3:5,8' => ['1', '3', '4', '5', '8']
+ * 5. Wildcard '*' (matches all token IDs): '*' => ['*']
+ *
+ * @param encodedTokenIds - The encoded string of token IDs to be decoded.
+ * @returns An array of individual token IDs after decoding the input.
+ *
+ * @throws {Error} If the input is not correctly formatted or if bigint operations fail.
+ *
+ * @example
+ * const encoded = '1,3:5,8';
+ * const decoded = decodeTokenIds(encoded); // Output: ['1', '3', '4', '5', '8']
+ *
+ * @example
+ * const encodedWildcard = '*';
+ * const decodedWildcard = decodeTokenIds(encodedWildcard); // Output: ['*']
+ *
+ * @example
+ * const emptyEncoded = '';
+ * const decodedEmpty = decodeTokenIds(emptyEncoded); // Output: []
+ */
+export declare const decodeTokenIds: (encodedTokenIds: string) => string[];

package/lib/src/utils/protocol.js

@@ -0,0 +1,161 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decodeTokenIds = exports.getSeaportVersion = exports.getSeaportInstance = exports.requireValidProtocol = exports.isValidProtocol = exports.remapSharedStorefrontAddress = exports.getAssetItemType = void 0;
+const constants_1 = require("@opensea/seaport-js/lib/constants");
+const ethers_1 = require("ethers");
+const constants_2 = require("../constants");
+// Pre-compute checksummed protocol addresses for consistent comparisons
+const VALID_PROTOCOL_ADDRESSES = new Set([
+    ethers_1.ethers.getAddress(constants_1.CROSS_CHAIN_SEAPORT_V1_6_ADDRESS),
+    ethers_1.ethers.getAddress(constants_2.ALTERNATE_SEAPORT_V1_6_ADDRESS),
+]);
+/**
+ * Gets the appropriate ItemType for a given token standard.
+ * @param tokenStandard The token standard (ERC20, ERC721, ERC1155)
+ * @returns The corresponding ItemType from Seaport
+ */
+const getAssetItemType = (tokenStandard) => {
+    const normalizedStandard = tokenStandard.toUpperCase();
+    switch (normalizedStandard) {
+        case "ERC20":
+            return constants_1.ItemType.ERC20;
+        case "ERC721":
+            return constants_1.ItemType.ERC721;
+        case "ERC1155":
+            return constants_1.ItemType.ERC1155;
+        default:
+            throw new Error(`Unknown schema name: ${tokenStandard}`);
+    }
+};
+exports.getAssetItemType = getAssetItemType;
+/**
+ * Remaps shared storefront token addresses to the lazy mint adapter address.
+ *
+ * OpenSea's shared storefront contracts require special handling - when a token
+ * is from a shared storefront address, it must be remapped to the lazy mint
+ * adapter address for proper Seaport order creation.
+ *
+ * @param tokenAddress The token contract address to check
+ * @returns The lazy mint adapter address if the input is a shared storefront address,
+ *          otherwise returns the original address unchanged
+ */
+const remapSharedStorefrontAddress = (tokenAddress) => {
+    if (constants_2.SHARED_STOREFRONT_ADDRESSES.has(tokenAddress.toLowerCase())) {
+        return ethers_1.ethers.getAddress(constants_2.SHARED_STOREFRONT_LAZY_MINT_ADAPTER_CROSS_CHAIN_ADDRESS);
+    }
+    return tokenAddress;
+};
+exports.remapSharedStorefrontAddress = remapSharedStorefrontAddress;
+/**
+ * Returns if a protocol address is valid.
+ * @param protocolAddress The protocol address
+ */
+const isValidProtocol = (protocolAddress) => {
+    try {
+        return VALID_PROTOCOL_ADDRESSES.has(ethers_1.ethers.getAddress(protocolAddress));
+    }
+    catch {
+        return false;
+    }
+};
+exports.isValidProtocol = isValidProtocol;
+/**
+ * Throws an error if the protocol address is not valid.
+ * @param protocolAddress The protocol address
+ */
+const requireValidProtocol = (protocolAddress) => {
+    if (!(0, exports.isValidProtocol)(protocolAddress)) {
+        throw new Error(`Unsupported protocol address: ${protocolAddress}`);
+    }
+};
+exports.requireValidProtocol = requireValidProtocol;
+/**
+ * Get the Seaport instance for a given protocol address.
+ * This is a shared utility to avoid duplicating the logic across multiple SDK manager classes.
+ * @param protocolAddress The protocol address
+ * @param seaport The Seaport instance
+ * @returns The Seaport instance for the given protocol address
+ * @throws Error if the protocol address is not supported
+ */
+const getSeaportInstance = (protocolAddress, seaport) => {
+    (0, exports.requireValidProtocol)(protocolAddress);
+    return seaport;
+};
+exports.getSeaportInstance = getSeaportInstance;
+/**
+ * Get the Seaport version string for a given protocol address.
+ * @param protocolAddress The protocol address
+ * @returns The version string (e.g., "1.6")
+ * @throws Error if the protocol address is not supported
+ */
+const getSeaportVersion = (protocolAddress) => {
+    (0, exports.requireValidProtocol)(protocolAddress);
+    return "1.6";
+};
+exports.getSeaportVersion = getSeaportVersion;
+/**
+ * Decodes an encoded string of token IDs into an array of individual token IDs using bigint for precise calculations.
+ *
+ * The encoded token IDs can be in the following formats:
+ * 1. Single numbers: '123' => ['123']
+ * 2. Comma-separated numbers: '1,2,3,4' => ['1', '2', '3', '4']
+ * 3. Ranges of numbers: '5:8' => ['5', '6', '7', '8']
+ * 4. Combinations of single numbers and ranges: '1,3:5,8' => ['1', '3', '4', '5', '8']
+ * 5. Wildcard '*' (matches all token IDs): '*' => ['*']
+ *
+ * @param encodedTokenIds - The encoded string of token IDs to be decoded.
+ * @returns An array of individual token IDs after decoding the input.
+ *
+ * @throws {Error} If the input is not correctly formatted or if bigint operations fail.
+ *
+ * @example
+ * const encoded = '1,3:5,8';
+ * const decoded = decodeTokenIds(encoded); // Output: ['1', '3', '4', '5', '8']
+ *
+ * @example
+ * const encodedWildcard = '*';
+ * const decodedWildcard = decodeTokenIds(encodedWildcard); // Output: ['*']
+ *
+ * @example
+ * const emptyEncoded = '';
+ * const decodedEmpty = decodeTokenIds(emptyEncoded); // Output: []
+ */
+const decodeTokenIds = (encodedTokenIds) => {
+    if (encodedTokenIds === "*") {
+        return ["*"];
+    }
+    if (encodedTokenIds === "") {
+        return [];
+    }
+    // Check for whitespace and provide helpful error message
+    if (/\s/.test(encodedTokenIds)) {
+        throw new Error("Invalid input format: whitespace is not allowed. Expected format: '1,2,3' or '1:5' or '1,3:5,8' (no spaces).");
+    }
+    const validFormatRegex = /^(\d+(:\d+)?)(,\d+(:\d+)?)*$/;
+    if (!validFormatRegex.test(encodedTokenIds)) {
+        throw new Error("Invalid input format. Expected a valid comma-separated list of numbers and ranges.");
+    }
+    const ranges = encodedTokenIds.split(",");
+    const tokenIds = [];
+    for (const range of ranges) {
+        if (range.includes(":")) {
+            const [startStr, endStr] = range.split(":");
+            const start = BigInt(startStr);
+            const end = BigInt(endStr);
+            const diff = end - start + 1n;
+            if (diff <= 0) {
+                throw new Error(`Invalid range. End value: ${end} must be greater than or equal to the start value: ${start}.`);
+            }
+            for (let i = 0n; i < diff; i += 1n) {
+                tokenIds.push((start + i).toString());
+            }
+        }
+        else {
+            const tokenId = BigInt(range);
+            tokenIds.push(tokenId.toString());
+        }
+    }
+    return tokenIds;
+};
+exports.decodeTokenIds = decodeTokenIds;
+//# sourceMappingURL=protocol.js.map

package/lib/src/utils/protocol.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"protocol.js","sourceRoot":"","sources":["../../../src/utils/protocol.ts"],"names":[],"mappings":";;;AACA,iEAG0C;AAC1C,mCAA+B;AAC/B,4CAIqB;AAGrB,wEAAwE;AACxE,MAAM,wBAAwB,GAAG,IAAI,GAAG,CAAC;IACvC,eAAM,CAAC,UAAU,CAAC,4CAAgC,CAAC;IACnD,eAAM,CAAC,UAAU,CAAC,0CAA8B,CAAC;CAClD,CAAC,CAAA;AAEF;;;;GAIG;AACI,MAAM,gBAAgB,GAAG,CAAC,aAA4B,EAAE,EAAE;IAC/D,MAAM,kBAAkB,GAAG,aAAa,CAAC,WAAW,EAAE,CAAA;IACtD,QAAQ,kBAAkB,EAAE,CAAC;QAC3B,KAAK,OAAO;YACV,OAAO,oBAAQ,CAAC,KAAK,CAAA;QACvB,KAAK,QAAQ;YACX,OAAO,oBAAQ,CAAC,MAAM,CAAA;QACxB,KAAK,SAAS;YACZ,OAAO,oBAAQ,CAAC,OAAO,CAAA;QACzB;YACE,MAAM,IAAI,KAAK,CAAC,wBAAwB,aAAa,EAAE,CAAC,CAAA;IAC5D,CAAC;AACH,CAAC,CAAA;AAZY,QAAA,gBAAgB,oBAY5B;AAED;;;;;;;;;;GAUG;AACI,MAAM,4BAA4B,GAAG,CAAC,YAAoB,EAAU,EAAE;IAC3E,IAAI,uCAA2B,CAAC,GAAG,CAAC,YAAY,CAAC,WAAW,EAAE,CAAC,EAAE,CAAC;QAChE,OAAO,eAAM,CAAC,UAAU,CACtB,mEAAuD,CACxD,CAAA;IACH,CAAC;IACD,OAAO,YAAY,CAAA;AACrB,CAAC,CAAA;AAPY,QAAA,4BAA4B,gCAOxC;AAED;;;GAGG;AACI,MAAM,eAAe,GAAG,CAAC,eAAuB,EAAW,EAAE;IAClE,IAAI,CAAC;QACH,OAAO,wBAAwB,CAAC,GAAG,CAAC,eAAM,CAAC,UAAU,CAAC,eAAe,CAAC,CAAC,CAAA;IACzE,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAA;IACd,CAAC;AACH,CAAC,CAAA;AANY,QAAA,eAAe,mBAM3B;AAED;;;GAGG;AACI,MAAM,oBAAoB,GAAG,CAAC,eAAuB,EAAE,EAAE;IAC9D,IAAI,CAAC,IAAA,uBAAe,EAAC,eAAe,CAAC,EAAE,CAAC;QACtC,MAAM,IAAI,KAAK,CAAC,iCAAiC,eAAe,EAAE,CAAC,CAAA;IACrE,CAAC;AACH,CAAC,CAAA;AAJY,QAAA,oBAAoB,wBAIhC;AAED;;;;;;;GAOG;AACI,MAAM,kBAAkB,GAAG,CAChC,eAAuB,EACvB,OAAgB,EACP,EAAE;IACX,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;IACrC,OAAO,OAAO,CAAA;AAChB,CAAC,CAAA;AANY,QAAA,kBAAkB,sBAM9B;AAED;;;;;GAKG;AACI,MAAM,iBAAiB,GAAG,CAAC,eAAuB,EAAU,EAAE;IACnE,IAAA,4BAAoB,EAAC,eAAe,CAAC,CAAA;IACrC,OAAO,KAAK,CAAA;AACd,CAAC,CAAA;AAHY,QAAA,iBAAiB,qBAG7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACI,MAAM,cAAc,GAAG,CAAC,eAAuB,EAAY,EAAE;IAClE,IAAI,eAAe,KAAK,GAAG,EAAE,CAAC;QAC5B,OAAO,CAAC,GAAG,CAAC,CAAA;IACd,CAAC;IAED,IAAI,eAAe,KAAK,EAAE,EAAE,CAAC;QAC3B,OAAO,EAAE,CAAA;IACX,CAAC;IAED,yDAAyD;IACzD,IAAI,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAC/B,MAAM,IAAI,KAAK,CACb,8GAA8G,CAC/G,CAAA;IACH,CAAC;IAED,MAAM,gBAAgB,GAAG,8BAA8B,CAAA;IAEvD,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,eAAe,CAAC,EAAE,CAAC;QAC5C,MAAM,IAAI,KAAK,CACb,oFAAoF,CACrF,CAAA;IACH,CAAC;IAED,MAAM,MAAM,GAAG,eAAe,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;IACzC,MAAM,QAAQ,GAAa,EAAE,CAAA;IAE7B,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACxB,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,GAAG,CAAC,CAAA;YAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,CAAA;YAC9B,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,CAAC,CAAA;YAC1B,MAAM,IAAI,GAAG,GAAG,GAAG,KAAK,GAAG,EAAE,CAAA;YAE7B,IAAI,IAAI,IAAI,CAAC,EAAE,CAAC;gBACd,MAAM,IAAI,KAAK,CACb,6BAA6B,GAAG,sDAAsD,KAAK,GAAG,CAC/F,CAAA;YACH,CAAC;YAED,KAAK,IAAI,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC;gBACnC,QAAQ,CAAC,IAAI,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAA;YACvC,CAAC;QACH,CAAC;aAAM,CAAC;YACN,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAA;YAC7B,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,EAAE,CAAC,CAAA;QACnC,CAAC;IACH,CAAC;IAED,OAAO,QAAQ,CAAA;AACjB,CAAC,CAAA;AAlDY,QAAA,cAAc,kBAkD1B"}

package/lib/src/utils/rateLimit.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Options for handling rate-limited operations with retries.
+ * This is exported for SDK consumers who may want to use executeWithRateLimit
+ * for their own OpenSea API integrations.
+ */
+export interface RateLimitOptions {
+    /** Logger function for logging progress */
+    logger?: (message: string) => void;
+    /** Maximum number of retry attempts for rate limit errors */
+    maxRetries?: number;
+    /** Base delay in ms to wait after a rate limit error if retry-after header is not present */
+    baseRetryDelay?: number;
+}
+/**
+ * Execute an async operation with automatic retry on rate limit errors.
+ * Respects the retry-after header when present, otherwise uses exponential backoff.
+ *
+ * @param operation The async operation to execute
+ * @param options Configuration for rate limit handling
+ * @returns The result of the operation
+ * @throws The last error encountered if all retries are exhausted
+ */
+export declare function executeWithRateLimit<T>(operation: () => Promise<T>, options?: RateLimitOptions): Promise<T>;
+/**
+ * Execute an array of async operations sequentially with rate limit handling.
+ * Logs progress after each operation.
+ *
+ * @param operations Array of async operations to execute
+ * @param options Configuration for rate limit handling and progress logging
+ * @returns Array of results from each operation
+ */
+export declare function executeSequentialWithRateLimit<T>(operations: Array<() => Promise<T>>, options?: RateLimitOptions & {
+    operationName?: string;
+}): Promise<T[]>;

package/lib/src/utils/rateLimit.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.executeWithRateLimit = executeWithRateLimit;
+exports.executeSequentialWithRateLimit = executeSequentialWithRateLimit;
+const stringHelper_1 = require("./stringHelper");
+/**
+ * Default configuration for rate limit handling
+ */
+const DEFAULT_MAX_RETRIES = 3;
+const DEFAULT_BASE_RETRY_DELAY_MS = 1000;
+const EXPONENTIAL_BACKOFF_BASE = 2;
+const MILLISECONDS_PER_SECOND = 1000;
+/**
+ * HTTP status codes that indicate rate limiting
+ */
+const RATE_LIMIT_STATUS_CODE = 429;
+const CUSTOM_RATE_LIMIT_STATUS_CODE = 599;
+/**
+ * Sleep for a specified duration
+ * @param ms Duration in milliseconds
+ */
+function sleep(ms) {
+    return new Promise(resolve => setTimeout(resolve, ms));
+}
+/**
+ * Execute an async operation with automatic retry on rate limit errors.
+ * Respects the retry-after header when present, otherwise uses exponential backoff.
+ *
+ * @param operation The async operation to execute
+ * @param options Configuration for rate limit handling
+ * @returns The result of the operation
+ * @throws The last error encountered if all retries are exhausted
+ */
+async function executeWithRateLimit(operation, options = {}) {
+    const { logger = () => { }, maxRetries = DEFAULT_MAX_RETRIES, baseRetryDelay = DEFAULT_BASE_RETRY_DELAY_MS, } = options;
+    let lastError;
+    for (let attempt = 0; attempt <= maxRetries; attempt++) {
+        try {
+            return await operation();
+        }
+        catch (error) {
+            lastError = error;
+            const rateLimitError = error;
+            // Check if this is a rate limit error by status code (robust) or retry-after header
+            const isRateLimitError = rateLimitError.statusCode === RATE_LIMIT_STATUS_CODE ||
+                rateLimitError.statusCode === CUSTOM_RATE_LIMIT_STATUS_CODE ||
+                rateLimitError.retryAfter !== undefined;
+            if (!isRateLimitError || attempt === maxRetries) {
+                // Not a rate limit error or out of retries, throw the error
+                throw error;
+            }
+            // Calculate delay
+            let delayMs;
+            if (rateLimitError.retryAfter !== undefined) {
+                delayMs = rateLimitError.retryAfter * MILLISECONDS_PER_SECOND;
+                logger(`Rate limit hit. Waiting ${rateLimitError.retryAfter} seconds before retry (attempt ${attempt + 1}/${maxRetries})...`);
+            }
+            else {
+                // Exponential backoff
+                delayMs = baseRetryDelay * EXPONENTIAL_BACKOFF_BASE ** attempt;
+                const delaySeconds = delayMs / MILLISECONDS_PER_SECOND;
+                logger(`Rate limit hit. Waiting ${delaySeconds} seconds before retry (attempt ${attempt + 1}/${maxRetries})...`);
+            }
+            await sleep(delayMs);
+            logger(`Retrying operation...`);
+        }
+    }
+    // Should never reach here, but TypeScript needs this
+    throw lastError;
+}
+/**
+ * Execute an array of async operations sequentially with rate limit handling.
+ * Logs progress after each operation.
+ *
+ * @param operations Array of async operations to execute
+ * @param options Configuration for rate limit handling and progress logging
+ * @returns Array of results from each operation
+ */
+async function executeSequentialWithRateLimit(operations, options = {}) {
+    const { logger = () => { }, operationName = "operation", ...rateLimitOptions } = options;
+    const results = [];
+    const total = operations.length;
+    logger(`Starting ${total} ${(0, stringHelper_1.pluralize)(total, operationName)}...`);
+    for (let i = 0; i < operations.length; i++) {
+        const operation = operations[i];
+        logger(`Executing ${operationName} ${i + 1}/${total}...`);
+        const result = await executeWithRateLimit(operation, {
+            ...rateLimitOptions,
+            logger,
+        });
+        results.push(result);
+        logger(`Completed ${operationName} ${i + 1}/${total}`);
+    }
+    logger(`All ${total} ${(0, stringHelper_1.pluralize)(total, operationName)} completed successfully`);
+    return results;
+}
+//# sourceMappingURL=rateLimit.js.map

package/lib/src/utils/rateLimit.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rateLimit.js","sourceRoot":"","sources":["../../../src/utils/rateLimit.ts"],"names":[],"mappings":";;AAgDA,oDAqDC;AAUD,wEAmCC;AAjJD,iDAA0C;AAE1C;;GAEG;AACH,MAAM,mBAAmB,GAAG,CAAC,CAAA;AAC7B,MAAM,2BAA2B,GAAG,IAAI,CAAA;AACxC,MAAM,wBAAwB,GAAG,CAAC,CAAA;AAClC,MAAM,uBAAuB,GAAG,IAAI,CAAA;AAEpC;;GAEG;AACH,MAAM,sBAAsB,GAAG,GAAG,CAAA;AAClC,MAAM,6BAA6B,GAAG,GAAG,CAAA;AAgBzC;;;GAGG;AACH,SAAS,KAAK,CAAC,EAAU;IACvB,OAAO,IAAI,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC,UAAU,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAA;AACxD,CAAC;AAED;;;;;;;;GAQG;AACI,KAAK,UAAU,oBAAoB,CACxC,SAA2B,EAC3B,UAA4B,EAAE;IAE9B,MAAM,EACJ,MAAM,GAAG,GAAG,EAAE,GAAE,CAAC,EACjB,UAAU,GAAG,mBAAmB,EAChC,cAAc,GAAG,2BAA2B,GAC7C,GAAG,OAAO,CAAA;IAEX,IAAI,SAA4B,CAAA;IAEhC,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,IAAI,UAAU,EAAE,OAAO,EAAE,EAAE,CAAC;QACvD,IAAI,CAAC;YACH,OAAO,MAAM,SAAS,EAAE,CAAA;QAC1B,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,SAAS,GAAG,KAAc,CAAA;YAC1B,MAAM,cAAc,GAAG,KAA8B,CAAA;YAErD,oFAAoF;YACpF,MAAM,gBAAgB,GACpB,cAAc,CAAC,UAAU,KAAK,sBAAsB;gBACpD,cAAc,CAAC,UAAU,KAAK,6BAA6B;gBAC3D,cAAc,CAAC,UAAU,KAAK,SAAS,CAAA;YAEzC,IAAI,CAAC,gBAAgB,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;gBAChD,4DAA4D;gBAC5D,MAAM,KAAK,CAAA;YACb,CAAC;YAED,kBAAkB;YAClB,IAAI,OAAe,CAAA;YACnB,IAAI,cAAc,CAAC,UAAU,KAAK,SAAS,EAAE,CAAC;gBAC5C,OAAO,GAAG,cAAc,CAAC,UAAU,GAAG,uBAAuB,CAAA;gBAC7D,MAAM,CACJ,2BAA2B,cAAc,CAAC,UAAU,kCAAkC,OAAO,GAAG,CAAC,IAAI,UAAU,MAAM,CACtH,CAAA;YACH,CAAC;iBAAM,CAAC;gBACN,sBAAsB;gBACtB,OAAO,GAAG,cAAc,GAAG,wBAAwB,IAAI,OAAO,CAAA;gBAC9D,MAAM,YAAY,GAAG,OAAO,GAAG,uBAAuB,CAAA;gBACtD,MAAM,CACJ,2BAA2B,YAAY,kCAAkC,OAAO,GAAG,CAAC,IAAI,UAAU,MAAM,CACzG,CAAA;YACH,CAAC;YAED,MAAM,KAAK,CAAC,OAAO,CAAC,CAAA;YACpB,MAAM,CAAC,uBAAuB,CAAC,CAAA;QACjC,CAAC;IACH,CAAC;IAED,qDAAqD;IACrD,MAAM,SAAS,CAAA;AACjB,CAAC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,8BAA8B,CAClD,UAAmC,EACnC,UAEI,EAAE;IAEN,MAAM,EACJ,MAAM,GAAG,GAAG,EAAE,GAAE,CAAC,EACjB,aAAa,GAAG,WAAW,EAC3B,GAAG,gBAAgB,EACpB,GAAG,OAAO,CAAA;IAEX,MAAM,OAAO,GAAQ,EAAE,CAAA;IACvB,MAAM,KAAK,GAAG,UAAU,CAAC,MAAM,CAAA;IAE/B,MAAM,CAAC,YAAY,KAAK,IAAI,IAAA,wBAAS,EAAC,KAAK,EAAE,aAAa,CAAC,KAAK,CAAC,CAAA;IAEjE,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,UAAU,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QAC3C,MAAM,SAAS,GAAG,UAAU,CAAC,CAAC,CAAC,CAAA;QAC/B,MAAM,CAAC,aAAa,aAAa,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,CAAC,CAAA;QAEzD,MAAM,MAAM,GAAG,MAAM,oBAAoB,CAAC,SAAS,EAAE;YACnD,GAAG,gBAAgB;YACnB,MAAM;SACP,CAAC,CAAA;QAEF,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAA;QACpB,MAAM,CAAC,aAAa,aAAa,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,EAAE,CAAC,CAAA;IACxD,CAAC;IAED,MAAM,CACJ,OAAO,KAAK,IAAI,IAAA,wBAAS,EAAC,KAAK,EAAE,aAAa,CAAC,yBAAyB,CACzE,CAAA;IAED,OAAO,OAAO,CAAA;AAChB,CAAC"}

package/lib/src/utils/stringHelper.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Utility functions for string formatting and manipulation.
+ */
+/**
+ * Pluralizes a word based on count.
+ *
+ * @param count The number of items
+ * @param singular The singular form of the word
+ * @param plural Optional custom plural form. If not provided, adds 's' to singular
+ * @returns The appropriately pluralized word
+ *
+ * @example
+ * pluralize(1, 'listing') // 'listing'
+ * pluralize(5, 'listing') // 'listings'
+ * pluralize(1, 'query', 'queries') // 'query'
+ * pluralize(3, 'query', 'queries') // 'queries'
+ */
+export declare function pluralize(count: number, singular: string, plural?: string): string;

package/lib/src/utils/stringHelper.js

@@ -0,0 +1,24 @@
+"use strict";
+/**
+ * Utility functions for string formatting and manipulation.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pluralize = pluralize;
+/**
+ * Pluralizes a word based on count.
+ *
+ * @param count The number of items
+ * @param singular The singular form of the word
+ * @param plural Optional custom plural form. If not provided, adds 's' to singular
+ * @returns The appropriately pluralized word
+ *
+ * @example
+ * pluralize(1, 'listing') // 'listing'
+ * pluralize(5, 'listing') // 'listings'
+ * pluralize(1, 'query', 'queries') // 'query'
+ * pluralize(3, 'query', 'queries') // 'queries'
+ */
+function pluralize(count, singular, plural) {
+    return count === 1 ? singular : plural || `${singular}s`;
+}
+//# sourceMappingURL=stringHelper.js.map

package/lib/src/utils/stringHelper.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"stringHelper.js","sourceRoot":"","sources":["../../../src/utils/stringHelper.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAgBH,8BAMC;AApBD;;;;;;;;;;;;;GAaG;AACH,SAAgB,SAAS,CACvB,KAAa,EACb,QAAgB,EAChB,MAAe;IAEf,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAI,GAAG,QAAQ,GAAG,CAAA;AAC1D,CAAC"}

package/lib/src/utils/utils.d.ts

@@ -0,0 +1,18 @@
+import type { ethers } from "ethers";
+export * from "./chain";
+export * from "./converters";
+export * from "./fees";
+export * from "./protocol";
+/**
+ * Estimate gas usage for a transaction.
+ * @param provider The Provider
+ * @param from Address sending transaction
+ * @param to Destination contract address
+ * @param data Data to send to contract
+ * @param value Value in ETH to send with data
+ */
+export declare function estimateGas(provider: ethers.Provider, { from, to, data, value }: ethers.Transaction): Promise<bigint>;
+interface ErrorWithCode extends Error {
+    code: string;
+}
+export declare const hasErrorCode: (error: unknown) => error is ErrorWithCode;

package/lib/src/utils/utils.js

@@ -0,0 +1,45 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.hasErrorCode = void 0;
+exports.estimateGas = estimateGas;
+__exportStar(require("./chain"), exports);
+// Re-export all utilities from specialized modules
+__exportStar(require("./converters"), exports);
+__exportStar(require("./fees"), exports);
+__exportStar(require("./protocol"), exports);
+/**
+ * Estimate gas usage for a transaction.
+ * @param provider The Provider
+ * @param from Address sending transaction
+ * @param to Destination contract address
+ * @param data Data to send to contract
+ * @param value Value in ETH to send with data
+ */
+async function estimateGas(provider, { from, to, data, value = 0n }) {
+    return await provider.estimateGas({
+        from,
+        to,
+        value: value.toString(),
+        data,
+    });
+}
+const hasErrorCode = (error) => {
+    const untypedError = error;
+    return !!untypedError.code;
+};
+exports.hasErrorCode = hasErrorCode;
+//# sourceMappingURL=utils.js.map

package/lib/src/utils/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/utils/utils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAgBA,kCAUC;AAxBD,0CAAuB;AACvB,mDAAmD;AACnD,+CAA4B;AAC5B,yCAAsB;AACtB,6CAA0B;AAE1B;;;;;;;GAOG;AACI,KAAK,UAAU,WAAW,CAC/B,QAAyB,EACzB,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,GAAG,EAAE,EAAsB;IAElD,OAAO,MAAM,QAAQ,CAAC,WAAW,CAAC;QAChC,IAAI;QACJ,EAAE;QACF,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;QACvB,IAAI;KACL,CAAC,CAAA;AACJ,CAAC;AAMM,MAAM,YAAY,GAAG,CAAC,KAAc,EAA0B,EAAE;IACrE,MAAM,YAAY,GAAG,KAA+B,CAAA;IACpD,OAAO,CAAC,CAAC,YAAY,CAAC,IAAI,CAAA;AAC5B,CAAC,CAAA;AAHY,QAAA,YAAY,gBAGxB"}