@imtbl/sdk 0.16.0-alpha.1 → 0.17.0

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 /// <reference path="global.d.ts" />
 /// <reference types="node" />
-import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1, ProviderConfiguration as ProviderConfiguration$1, ExchangeContracts } from 'config';
+import { ProviderConfiguration as ProviderConfiguration$1, ExchangeContracts } from 'config';
 
 declare enum Environment {
     PRODUCTION = "production",
@@ -32,6 +32,90 @@ declare namespace config_d {
   };
 }
 
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+interface ConfigurationParameters$1 {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+declare class Configuration$1 {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters$1);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -1689,6 +1773,37 @@ interface CollectionsApiListCollectionsRequest$1 {
      */
     readonly pageSize?: number;
 }
+/**
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
+ */
+interface CollectionsApiListCollectionsByNFTOwnerRequest {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageSize?: number;
+}
 
 /**
  * Request parameters for listNFTOwners operation in NftOwnersApi.
@@ -1886,6 +2001,18 @@ declare class APIError$1 extends Error {
     constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
 }
 
+interface APIConfigurationParams {
+    basePath: string;
+    headers?: Record<string, string>;
+}
+interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
+}
+declare class BlockchainDataConfiguration {
+    readonly apiConfig: Configuration$1;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
+}
+
 declare class BlockchainData {
     readonly config: BlockchainDataConfiguration;
     private readonly activities;
@@ -1894,7 +2021,7 @@ declare class BlockchainData {
     private readonly nfts;
     private readonly nftOwners;
     private readonly tokens;
-    constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
+    constructor(moduleConfig: BlockchainDataModuleConfiguration);
     /**
      * List all activities
      * @param request - the request object containing the parameters to be provided in the API request
@@ -1923,6 +2050,13 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listCollections(request: CollectionsApiListCollectionsRequest$1): Promise<ListCollectionsResult>;
+    /**
+     * List collections by NFT owner
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
     /**
      * Get collection by contract address
      * @param request - the request object containing the parameters to be provided in the API request
@@ -1974,13 +2108,6 @@ declare class BlockchainData {
     getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
 }
 
-interface APIConfigurationParams {
-    basePath: string;
-    headers?: Record<string, string>;
-}
-interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
-}
-
 type ActivityType = ActivityType$1;
 
 type blockchain_data_d_ActivityType = ActivityType;
@@ -14251,6 +14378,68 @@ type ERC20Gas = {
     contractAddress: string;
     limit: BigNumber;
 };
+/**
+ * Represents the result of {@link Checkout.smartCheckout}.
+ * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
+ * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements.
+ */
+interface SmartCheckoutResult {
+    sufficient: boolean;
+    transactionRequirements: TransactionRequirement[];
+}
+/**
+ * Represents the transaction requirement for a transaction.
+ * @property {ItemType} type - The type of the transaction requirement.
+ * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
+ * @property {TransactionRequirementItem} required - The required item balance.
+ * @property {TransactionRequirementItem} current - The current item balance.
+ * @property {TransactionRequirementDelta} delta - The delta between the required and current balances.
+ */
+type TransactionRequirement = {
+    type: ItemType;
+    sufficient: boolean;
+    required: ItemBalance;
+    current: ItemBalance;
+    delta: BalanceDelta;
+};
+/**
+ * Represents the balance for either a native or ERC20 token.
+ * @property {BigNumber} balance - The balance of the item.
+ * @property {string} formattedBalance - The formatted balance of the item.
+ * @property {TokenInfo} token - The token info of the item.
+ */
+type TokenBalance = {
+    type: ItemType.NATIVE | ItemType.ERC20;
+    balance: BigNumber;
+    formattedBalance: string;
+    token: TokenInfo;
+};
+/**
+ * Represents the balance for an ERC20.
+ * @property {BigNumber} balance - The balance of the item.
+ * @property {string} formattedBalance - The formatted balance of the item.
+ * @property {TokenInfo} token - The token info of the item.
+ */
+interface ERC721Balance {
+    type: ItemType.ERC721;
+    balance: BigNumber;
+    formattedBalance: string;
+    contractAddress: string;
+    id: string;
+}
+/**
+ * Type representing the balance of an item.
+ */
+type ItemBalance = ERC721Balance | TokenBalance;
+/**
+ * Represents the delta between two balances.
+ * @property {BigNumber} balance - The delta of the balance.
+ * @property {string} formattedBalance - The formatted balance of the delta.
+ */
+type BalanceDelta = {
+    balance: BigNumber;
+    formattedBalance: string;
+};
 /**
  * Interface representing the parameters for {@link Checkout.buy}
  * @property {Web3Provider} provider - The provider to use for the buy.
@@ -14260,9 +14449,65 @@ interface BuyParams {
     provider: Web3Provider;
     orderId: string;
 }
+/**
+ * Interface representing the result of the buy
+ * @property {SmartCheckoutResult} smartCheckoutResult - The result of smart checkout.
+ * @property {string} orderId - The order ID.
+ * @property {BuyStatus} status - The status of the buy, present when smart checkout balances are sufficient
+ * and the transactions were executed
+ */
+type BuyResult = {
+    smartCheckoutResult: SmartCheckoutResult;
+    orderId: string;
+    status?: BuyStatus;
+};
+/**
+ * Represents the status of the transaction for the Buy
+ */
+type BuyStatus = BuySuccessStatus | BuyFailedStatus;
+/**
+ * Represents the status of a successful Buy
+ * @property {string} type - The success buy status type.
+ */
+interface BuySuccessStatus {
+    type: BuyStatusType.SUCCESS;
+}
+/**
+ * Represents the status of a failed Buy
+ * @property {string} type - The failed buy status type.
+ * @property {string} transactionHash - The transaction hash of the failed transaction.
+ * @property {string} reason - The reason for the failed transaction.
+ */
+interface BuyFailedStatus {
+    type: BuyStatusType.FAILED;
+    transactionHash: string;
+    reason: string;
+}
+/**
+ * A type representing the status of the transaction for the Buy
+ * @enum {string}
+ * @property {string} SUCCESS - All the transactions were successful.
+ * @property {string} FAILED - At least one of the transactions failed.
+ */
+declare enum BuyStatusType {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}
+/**
+ * Interface representing the parameters for {@link Checkout.cancel}
+ * @property {Web3Provider} provider - The provider to use for the cancel.
+ * @property {string} orderId - The order ID.
+ */
+interface CancelParams {
+    provider: Web3Provider;
+    orderId: string;
+}
 interface CheckoutOverrides {
 }
 interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverrides> {
+    isOnRampEnabled?: boolean;
+    isSwapEnabled?: boolean;
+    isBridgeEnabled?: boolean;
 }
 /**
  * A type representing various remotely defined configurations which are
@@ -14497,6 +14742,91 @@ declare enum NetworkFilterTypes {
 interface NetworkFilter {
     chainId: ChainId;
 }
+/**
+ * Interface representing the parameters for {@link Checkout.sell}
+ * @property {Web3Provider} provider - The provider to use for the sell.
+ * @property {string} id - The ERC721 ID.
+ * @property {string} collectionAddress - The contract address of the ERC721s collection.
+ * @property {BuyToken} buyToken - The token to buy the item with.
+ */
+interface SellParams {
+    provider: Web3Provider;
+    id: string;
+    collectionAddress: string;
+    buyToken: BuyToken;
+}
+/**
+ * Interface representing the result of the sell
+ * @property {string} id - The ERC721 ID.
+ * @property {string} collectionAddress - The contract address of the ERC721s collection.
+ * @property {SmartCheckoutResult} smartCheckoutResult - The result of the smart checkout.
+ * @property {SellStatus} status - The status of the sell, present when smart checkout balances are sufficient
+ */
+type SellResult = {
+    id: string;
+    collectionAddress: string;
+    smartCheckoutResult: SmartCheckoutResult;
+    status?: SellStatus;
+};
+/**
+ * Represents the status of the transaction for the Sell
+ */
+type SellStatus = SellSuccessStatus | SellFailedStatus;
+/**
+ * Represents the status of a successful Sell
+ * @property {string} type - The success sell status type.
+ * @property {string} orderId - The order ID of the listing.
+ */
+interface SellSuccessStatus {
+    type: SellStatusType.SUCCESS;
+    orderId: string;
+}
+/**
+ * Represents the status of a failed Sell
+ * @property {string} type - The failed sell status type.
+ * @property {string} transactionHash - The transaction hash of the failed transaction.
+ * @property {string} reason - The reason for the failed transaction.
+ */
+interface SellFailedStatus {
+    type: SellStatusType.FAILED;
+    transactionHash: string;
+    reason: string;
+}
+/**
+ * A type representing the status of the transaction for the Sell
+ * @enum {string}
+ * @property {string} SUCCESS - All the transactions were successful.
+ * @property {string} FAILED - At least one of the transactions failed.
+ */
+declare enum SellStatusType {
+    SUCCESS = "SUCCESS",
+    FAILED = "FAILED"
+}
+/**
+ * Represents the token that the item can be bought with once listed for sale.
+ * NativeBuyToken or ERC20BuyToken {@link Checkout.smartCheckout}.
+ */
+type BuyToken = NativeBuyToken | ERC20BuyToken;
+/**
+ * Represents a native buy token
+ * @property {ItemType} type - The type indicate this is a native token.
+ * @property {BigNumber} amount - The amount of native token.
+ */
+type NativeBuyToken = {
+    type: ItemType.NATIVE;
+    amount: BigNumber;
+};
+/**
+ * Represents a ERC20 buy token
+ * @property {ItemType} type - The type indicate this is a ERC20 token.
+ * @property {BigNumber} amount - The amount of native token.
+ * @property {string} contractAddress - The contract address of the ERC20.
+ */
+type ERC20BuyToken = {
+    type: ItemType.ERC20;
+    amount: BigNumber;
+    contractAddress: string;
+};
 /**
  * Interface representing the parameters for {@link Checkout.getTokenAllowList}.
  * @property {TokenFilterTypes} type - The type of token to retrieve.
@@ -14659,10 +14989,15 @@ declare enum CheckoutErrorType {
     UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
     UNSUPPORTED_BALANCE_REQUIREMENT_ERROR = "UNSUPPORTED_BALANCE_REQUIREMENT_ERROR",
     GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
+    CANCEL_ORDER_LISTING_ERROR = "CANCEL_ORDER_LISTING_ERROR",
     PREPARE_ORDER_LISTING_ERROR = "PREPARE_ORDER_LISTING_ERROR",
+    CREATE_ORDER_LISTING_ERROR = "CREATE_ORDER_LISTING_ERROR",
     SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
     GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
-    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR"
+    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR",
+    EXECUTE_APPROVAL_TRANSACTION_ERROR = "EXECUTE_APPROVAL_TRANSACTION_ERROR",
+    EXECUTE_FULFILMENT_TRANSACTION_ERROR = "EXECUTE_FULFILMENT_TRANSACTION_ERROR",
+    SIGN_MESSAGE_ERROR = "SIGN_MESSAGE_ERROR"
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.
@@ -14689,49 +15024,14 @@ declare class RemoteConfigFetcher {
 declare class CheckoutConfiguration {
     readonly isDevelopment: boolean;
     readonly isProduction: boolean;
+    readonly isOnRampEnabled: boolean;
+    readonly isSwapEnabled: boolean;
+    readonly isBridgeEnabled: boolean;
     readonly remote: RemoteConfigFetcher;
     readonly environment: Environment;
     readonly networkMap: NetworkMap;
     constructor(config: CheckoutModuleConfiguration);
 }
-/**
- * Interface representing the parameters for {@link Checkout.sell}
- * @property {Web3Provider} provider - The provider to use for the sell.
- * @property {string} id - The ERC721 ID.
- * @property {string} collectionAddress - The contract address of the ERC721s collection.
- * @property {BuyToken} buyToken - The token to buy the item with.
- */
-interface SellParams {
-    provider: Web3Provider;
-    id: string;
-    collectionAddress: string;
-    buyToken: BuyToken;
-}
-/**
- * Represents the token that the item can be bought with once listed for sale.
- * NativeBuyToken or ERC20BuyToken {@link Checkout.smartCheckout}.
- */
-type BuyToken = NativeBuyToken | ERC20BuyToken;
-/**
- * Represents a native buy token
- * @property {ItemType} type - The type indicate this is a native token.
- * @property {BigNumber} amount - The amount of native token.
- */
-type NativeBuyToken = {
-    type: ItemType.NATIVE;
-    amount: BigNumber;
-};
-/**
- * Represents a ERC20 buy token
- * @property {ItemType} type - The type indicate this is a ERC20 token.
- * @property {BigNumber} amount - The amount of native token.
- * @property {string} contractAddress - The contract address of the ERC20.
- */
-type ERC20BuyToken = {
-    type: ItemType.ERC20;
-    amount: BigNumber;
-    contractAddress: string;
-};
 declare class Checkout {
     readonly config: CheckoutConfiguration;
     /**
@@ -14816,6 +15116,11 @@ declare class Checkout {
      * @param {SellParams} params - The parameters for the sell.
     */
     sell(params: SellParams): Promise<void>;
+    /**
+     * Cancels a sell.
+     * @param {CancelParams} params - The parameters for the cancel.
+     */
+    cancel(params: CancelParams): Promise<void>;
     /**
      * Determines the transaction requirements to complete a purchase.
      * @params {SmartCheckoutParams} params - The parameters for smart checkout.
@@ -14837,7 +15142,9 @@ declare class Checkout {
 
 type checkout_sdk_d_AllowedNetworkConfig = AllowedNetworkConfig;
 type checkout_sdk_d_BuyParams = BuyParams;
+type checkout_sdk_d_BuyResult = BuyResult;
 declare const checkout_sdk_d_CHECKOUT_API_BASE_URL: typeof CHECKOUT_API_BASE_URL;
+type checkout_sdk_d_CancelParams = CancelParams;
 type checkout_sdk_d_ChainId = ChainId;
 declare const checkout_sdk_d_ChainId: typeof ChainId;
 type checkout_sdk_d_ChainName = ChainName;
@@ -14879,6 +15186,8 @@ type checkout_sdk_d_NetworkFilterTypes = NetworkFilterTypes;
 declare const checkout_sdk_d_NetworkFilterTypes: typeof NetworkFilterTypes;
 type checkout_sdk_d_NetworkInfo = NetworkInfo;
 type checkout_sdk_d_RemoteConfiguration = RemoteConfiguration;
+type checkout_sdk_d_SellParams = SellParams;
+type checkout_sdk_d_SellResult = SellResult;
 type checkout_sdk_d_SendTransactionParams = SendTransactionParams;
 type checkout_sdk_d_SendTransactionResult = SendTransactionResult;
 type checkout_sdk_d_SmartCheckoutParams = SmartCheckoutParams;
@@ -14900,7 +15209,9 @@ declare namespace checkout_sdk_d {
   export {
     checkout_sdk_d_AllowedNetworkConfig as AllowedNetworkConfig,
     checkout_sdk_d_BuyParams as BuyParams,
+    checkout_sdk_d_BuyResult as BuyResult,
     checkout_sdk_d_CHECKOUT_API_BASE_URL as CHECKOUT_API_BASE_URL,
+    checkout_sdk_d_CancelParams as CancelParams,
     checkout_sdk_d_ChainId as ChainId,
     checkout_sdk_d_ChainName as ChainName,
     checkout_sdk_d_CheckConnectionParams as CheckConnectionParams,
@@ -14934,6 +15245,8 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_NetworkFilterTypes as NetworkFilterTypes,
     checkout_sdk_d_NetworkInfo as NetworkInfo,
     checkout_sdk_d_RemoteConfiguration as RemoteConfiguration,
+    checkout_sdk_d_SellParams as SellParams,
+    checkout_sdk_d_SellResult as SellResult,
     checkout_sdk_d_SendTransactionParams as SendTransactionParams,
     checkout_sdk_d_SendTransactionResult as SendTransactionResult,
     checkout_sdk_d_SmartCheckoutParams as SmartCheckoutParams,
@@ -29979,6 +30292,11 @@ declare class ERC721 {
      * @returns the DEFAULT_ADMIN_ROLE as a string.
      */
     DEFAULT_ADMIN_ROLE(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * Returns the domain separator used in the encoding of the signature for permits, as defined by EIP-712
+     * @return the bytes32 domain separator
+     */
+    DOMAIN_SEPARATOR(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
     /**
      * @returns the MINTER_ROLE as a string.
      */
@@ -29995,6 +30313,27 @@ declare class ERC721 {
      * @returns the contractURI as a string.
      */
     contractURI(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @dev returns the fields and values that describe the domain separator used by this contract for EIP-712
+     * signature.
+     */
+    eip712Domain(provider: Provider$1, overrides?: CallOverrides): Promise<[
+        string,
+        string,
+        string,
+        BigNumber,
+        string,
+        string,
+        BigNumber[]
+    ] & {
+        fields: string;
+        name: string;
+        version: string;
+        chainId: BigNumber;
+        verifyingContract: string;
+        salt: string;
+        extensions: BigNumber[];
+    }>;
     /**
      * @returns admin addresses as an array of strings.
      */
@@ -30031,6 +30370,12 @@ declare class ERC721 {
      * @returns the owner address of a particular tokenId.
      */
     ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * Returns the current nonce of a given token ID.
+     * @param tokenId The ID of the token for which to retrieve the nonce.
+     * @return Current nonce of the given token.
+     */
+    nonces(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns the operator allowlist as a string.
      */
@@ -30060,6 +30405,14 @@ declare class ERC721 {
     populateApprove(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
+    /**
+     * Function to approve by way of owner signature
+     * @param spender the address to approve
+     * @param tokenId the index of the NFT to approve the spender on
+     * @param deadline a timestamp expiry for the permit
+     * @param sig a traditional or EIP-2098 signature
+     */
+    populatePermit(spender: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, deadline: PromiseOrValue<BigNumberish>, sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the burn contract function
      */
@@ -30326,6 +30679,12 @@ declare class ERC721MintByID {
      * @returns the owner address of a particular tokenId.
      */
     ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * Returns the current nonce of a given token ID.
+     * @param tokenId The ID of the token for which to retrieve the nonce.
+     * @return Current nonce of the given token.
+     */
+    nonces(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<BigNumber>;
     /**
      * @returns the operator allowlist as a string.
      */
@@ -30355,6 +30714,14 @@ declare class ERC721MintByID {
     populateApprove(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
         from?: PromiseOrValue<string>;
     }): Promise<PopulatedTransaction>;
+    /**
+     * Function to approve by way of owner signature
+     * @param spender the address to approve
+     * @param tokenId the index of the NFT to approve the spender on
+     * @param deadline a timestamp expiry for the permit
+     * @param sig a traditional or EIP-2098 signature
+     */
+    populatePermit(spender: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, deadline: PromiseOrValue<BigNumberish>, sig: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
     /**
      * @returns a populated transaction for the burn contract function
      */