@imtbl/sdk 0.12.0-alpha → 0.13.0-alpha.1

package/dist/index.d.ts

@@ -296,7 +296,7 @@ interface Deposit$1 {
  * @export
  * @interface Mint
  */
-interface Mint$1 {
+interface Mint$2 {
     /**
      * The account address the asset was minted to
      * @type {string}
@@ -595,7 +595,7 @@ interface Withdrawal$1 {
  * The activity details
  * @export
  */
-type ActivityDetails = Burn | Deposit$1 | Mint$1 | NFTSale | Transfer$1 | Withdrawal$1;
+type ActivityDetails = Burn | Deposit$1 | Mint$2 | NFTSale | Transfer$1 | Withdrawal$1;
 
 /**
  * Immutable zkEVM API
@@ -4797,7 +4797,7 @@ interface CreateTradeResponse {
  * @export
  * @interface TransferRequest
  */
-interface TransferRequest$1 {
+interface TransferRequest$2 {
     /**
      * Amount to transfer
      * @type {string}
@@ -4871,7 +4871,7 @@ interface CreateTransferRequest {
      * @type {Array<TransferRequest>}
      * @memberof CreateTransferRequest
      */
-    'requests': Array<TransferRequest$1>;
+    'requests': Array<TransferRequest$2>;
     /**
      * Public stark key of the user sending the transfer
      * @type {string}
@@ -7080,7 +7080,7 @@ interface ListDepositsResponse {
  * @export
  * @interface Mint
  */
-interface Mint {
+interface Mint$1 {
     /**
      * Fee details
      * @type {Array<Fee>}
@@ -7154,7 +7154,7 @@ interface ListMintsResponse {
      * @type {Array<Mint>}
      * @memberof ListMintsResponse
      */
-    'result': Array<Mint>;
+    'result': Array<Mint$1>;
 }
 
 /**
@@ -10216,7 +10216,7 @@ declare class MintsApi extends BaseAPI {
      * @throws {RequiredError}
      * @memberof MintsApi
      */
-    getMint(requestParameters: MintsApiGetMintRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Mint[], any>>;
+    getMint(requestParameters: MintsApiGetMintRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<Mint$1[], any>>;
     /**
      * Get details of a mintable token with the given token address and token ID
      * @summary Get details of a mintable token with the given token address and token ID
@@ -12557,7 +12557,7 @@ declare class ImmutableXClient {
      * @returns a promise that resolves with the requested Mint
      * @throws {@link index.IMXError}
      */
-    getMint(request: MintsApiGetMintRequest): Promise<Mint[]>;
+    getMint(request: MintsApiGetMintRequest): Promise<Mint$1[]>;
     /**
      * Get a list of Mints
      * @param request optional object containing the parameters to be provided in the API request
@@ -13931,7 +13931,8 @@ declare enum CheckoutErrorType {
     UNSUPPORTED_TOKEN_TYPE_ERROR = "UNSUPPORTED_TOKEN_TYPE_ERROR",
     GET_ORDER_LISTING_ERROR = "GET_ORDER_LISTING_ERROR",
     SWITCH_NETWORK_UNSUPPORTED = "SWITCH_NETWORK_UNSUPPORTED",
-    GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR"
+    GET_ERC20_ALLOWANCE_ERROR = "GET_ERC20_ALLOWANCE_ERROR",
+    GET_ERC721_ALLOWANCE_ERROR = "GET_ERC721_ALLOWANCE_ERROR"
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.
@@ -14085,6 +14086,8 @@ type checkout_sdk_d_GasEstimateSwapResult = GasEstimateSwapResult;
 type checkout_sdk_d_GasEstimateTokenConfig = GasEstimateTokenConfig;
 type checkout_sdk_d_GasEstimateType = GasEstimateType;
 declare const checkout_sdk_d_GasEstimateType: typeof GasEstimateType;
+type checkout_sdk_d_GasTokenType = GasTokenType;
+declare const checkout_sdk_d_GasTokenType: typeof GasTokenType;
 type checkout_sdk_d_GetAllBalancesParams = GetAllBalancesParams;
 type checkout_sdk_d_GetAllBalancesResult = GetAllBalancesResult;
 type checkout_sdk_d_GetBalanceParams = GetBalanceParams;
@@ -14096,6 +14099,8 @@ type checkout_sdk_d_GetTokenAllowListParams = GetTokenAllowListParams;
 type checkout_sdk_d_GetTokenAllowListResult = GetTokenAllowListResult;
 type checkout_sdk_d_GetWalletAllowListParams = GetWalletAllowListParams;
 type checkout_sdk_d_GetWalletAllowListResult = GetWalletAllowListResult;
+type checkout_sdk_d_ItemType = ItemType;
+declare const checkout_sdk_d_ItemType: typeof ItemType;
 type checkout_sdk_d_NetworkFilter = NetworkFilter;
 type checkout_sdk_d_NetworkFilterTypes = NetworkFilterTypes;
 declare const checkout_sdk_d_NetworkFilterTypes: typeof NetworkFilterTypes;
@@ -14110,6 +14115,8 @@ type checkout_sdk_d_TokenFilter = TokenFilter;
 type checkout_sdk_d_TokenFilterTypes = TokenFilterTypes;
 declare const checkout_sdk_d_TokenFilterTypes: typeof TokenFilterTypes;
 type checkout_sdk_d_TokenInfo = TokenInfo;
+type checkout_sdk_d_TransactionOrGasType = TransactionOrGasType;
+declare const checkout_sdk_d_TransactionOrGasType: typeof TransactionOrGasType;
 type checkout_sdk_d_WalletFilter = WalletFilter;
 type checkout_sdk_d_WalletFilterTypes = WalletFilterTypes;
 declare const checkout_sdk_d_WalletFilterTypes: typeof WalletFilterTypes;
@@ -14137,6 +14144,7 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_GasEstimateSwapResult as GasEstimateSwapResult,
     checkout_sdk_d_GasEstimateTokenConfig as GasEstimateTokenConfig,
     checkout_sdk_d_GasEstimateType as GasEstimateType,
+    checkout_sdk_d_GasTokenType as GasTokenType,
     checkout_sdk_d_GetAllBalancesParams as GetAllBalancesParams,
     checkout_sdk_d_GetAllBalancesResult as GetAllBalancesResult,
     checkout_sdk_d_GetBalanceParams as GetBalanceParams,
@@ -14148,6 +14156,7 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_GetTokenAllowListResult as GetTokenAllowListResult,
     checkout_sdk_d_GetWalletAllowListParams as GetWalletAllowListParams,
     checkout_sdk_d_GetWalletAllowListResult as GetWalletAllowListResult,
+    checkout_sdk_d_ItemType as ItemType,
     checkout_sdk_d_NetworkFilter as NetworkFilter,
     checkout_sdk_d_NetworkFilterTypes as NetworkFilterTypes,
     checkout_sdk_d_NetworkInfo as NetworkInfo,
@@ -14160,6 +14169,7 @@ declare namespace checkout_sdk_d {
     checkout_sdk_d_TokenFilter as TokenFilter,
     checkout_sdk_d_TokenFilterTypes as TokenFilterTypes,
     checkout_sdk_d_TokenInfo as TokenInfo,
+    checkout_sdk_d_TransactionOrGasType as TransactionOrGasType,
     checkout_sdk_d_WalletFilter as WalletFilter,
     checkout_sdk_d_WalletFilterTypes as WalletFilterTypes,
     checkout_sdk_d_WalletInfo as WalletInfo,
@@ -29137,6 +29147,289 @@ declare namespace erc20_d {
 
 type PromiseOrValue<T> = T | Promise<T>;
 
+declare namespace ERC721Hybrid {
+    type IDMintStruct = {
+        to: PromiseOrValue<string>;
+        tokenIds: PromiseOrValue<BigNumberish>[];
+    };
+    type IDMintStructOutput = [string, BigNumber[]] & {
+        to: string;
+        tokenIds: BigNumber[];
+    };
+    type MintStruct = {
+        to: PromiseOrValue<string>;
+        quantity: PromiseOrValue<BigNumberish>;
+    };
+    type MintStructOutput = [string, BigNumber] & {
+        to: string;
+        quantity: BigNumber;
+    };
+    type TransferRequestStruct = {
+        from: PromiseOrValue<string>;
+        tos: PromiseOrValue<string>[];
+        tokenIds: PromiseOrValue<BigNumberish>[];
+    };
+    type TransferRequestStructOutput = [string, string[], BigNumber[]] & {
+        from: string;
+        tos: string[];
+        tokenIds: BigNumber[];
+    };
+}
+
+type Mint = ERC721Hybrid.MintStruct;
+type IDMint$1 = ERC721Hybrid.IDMintStruct;
+type TransferRequest$1 = ERC721Hybrid.TransferRequestStruct;
+declare class ERC721HybridPermissionedMintable {
+    private readonly contract;
+    constructor(contractAddress: string);
+    /**
+     * Read functions
+     */
+    /**
+     * @returns the DEFAULT_ADMIN_ROLE as a string.
+     */
+    DEFAULT_ADMIN_ROLE(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the MINTER_ROLE as a string.
+     */
+    MINTER_ROLE(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the balance of an address as a BigNumber.
+     */
+    balanceOf(provider: Provider$1, owner: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    /**
+     * @returns the baseURI as a string.
+     */
+    baseURI(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the contractURI as a string.
+     */
+    contractURI(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns admin addresses as an array of strings.
+     */
+    getAdmins(provider: Provider$1, overrides?: CallOverrides): Promise<string[]>;
+    /**
+     * @returns the approved address for a token ID, or zero if no address set.
+     */
+    getApproved(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the role admin address.
+     */
+    getRoleAdmin(provider: Provider$1, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the role member address at a particular index.
+     */
+    getRoleMember(provider: Provider$1, role: PromiseOrValue<BytesLike>, index: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the role member count as a BigNumber.
+     */
+    getRoleMemberCount(provider: Provider$1, role: PromiseOrValue<BytesLike>, overrides?: CallOverrides): Promise<BigNumber>;
+    /**
+     * @returns a boolean for whether an account has a particular role.
+     */
+    hasRole(provider: Provider$1, role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
+    /**
+     * @returns a booolean that tells whether an operator is approved by a given owner.
+     */
+    isApprovedForAll(provider: Provider$1, owner: PromiseOrValue<string>, operator: PromiseOrValue<string>, overrides?: CallOverrides): Promise<boolean>;
+    /**
+     * @returns the name of the contract as a string.
+     */
+    name(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the owner address of a particular tokenId.
+     */
+    ownerOf(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the royalty allowlist as a string.
+     */
+    royaltyAllowlist(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the royalty information for a particular tokenId.
+     */
+    royaltyInfo(provider: Provider$1, _tokenId: PromiseOrValue<BigNumberish>, _salePrice: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<[string, BigNumber]>;
+    /**
+     * @returns the symbol of the contract as a string.
+     */
+    symbol(provider: Provider$1, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns the Uniform Resource Identifier (URI) for tokenId token.
+     */
+    tokenURI(provider: Provider$1, tokenId: PromiseOrValue<BigNumberish>, overrides?: CallOverrides): Promise<string>;
+    /**
+     * @returns returns the total amount of tokens stored by the contract.
+     */
+    totalSupply(provider: Provider$1, overrides?: CallOverrides): Promise<BigNumber>;
+    /**
+     * Write functions
+     */
+    /**
+     * @returns a populated transaction for the approve contract function
+     */
+    populateApprove(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the burn contract function
+     */
+    populateBurn(tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch burn contract function
+     */
+    populateBurnBatch(tokenIds: PromiseOrValue<BigNumberish>[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the grantMinterRole contract function
+     */
+    populateGrantMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the grantRole contract function
+     */
+    populateGrantRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the mint by ID contract function
+     */
+    populateMintByID(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe mint by ID contract function
+     */
+    populateSafeMintByID(to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the mint by quantity contract function
+     */
+    populateMintByQuantity(to: PromiseOrValue<string>, quantity: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safe mint by quantity contract function
+     */
+    populateSafeMintByQuantity(to: PromiseOrValue<string>, quantity: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch mint by quantity contract function
+     */
+    populateBatchMintByQuantity(mints: Mint[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch safe mint by quantity contract function
+     */
+    populateBatchSafeMintByQuantity(mints: Mint[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch mint by ID to multiple recipients contract function
+     */
+    populateBatchMintByIDToMultiple(mints: IDMint$1[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch safe mint by ID to multiple recipients contract function
+     */
+    populateBatchSafeMintByIDToMultiple(mints: IDMint$1[], overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the renounceRole contract function
+     */
+    populateRenounceRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the revokeMinterRole contract function
+     */
+    populateRevokeMinterRole(user: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the revokeRole contract function
+     */
+    populateRevokeRole(role: PromiseOrValue<BytesLike>, account: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the batch save transfer from function
+     */
+    populateSafeTransferFromBatch(transfers: TransferRequest$1, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safeTransferFrom(address,address,uint256) contract function
+     */
+    'populateSafeTransferFrom(address,address,uint256)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the safeTransferFrom(address,address,uint256,bytes) contract function
+     */
+    'populateSafeTransferFrom(address,address,uint256,bytes)'(from: PromiseOrValue<string>, to: PromiseOrValue<string>, tokenId: PromiseOrValue<BigNumberish>, data: PromiseOrValue<BytesLike>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setApprovalForAll contract function
+     */
+    populateSetApprovalForAll(operator: PromiseOrValue<string>, approved: PromiseOrValue<boolean>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setBaseURI contract function
+     */
+    populateSetBaseURI(baseURI_: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setContractURI contract function
+     */
+    populateSetContractURI(_contractURI: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setDefaultRoyaltyReceiver contract function
+     */
+    populateSetDefaultRoyaltyReceiver(receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setNFTRoyaltyReceiver contract function
+     */
+    populateSetNFTRoyaltyReceiver(tokenId: PromiseOrValue<BigNumberish>, receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setNFTRoyaltyReceiverBatch contract function
+     */
+    populateSetNFTRoyaltyReceiverBatch(tokenIds: PromiseOrValue<BigNumberish>[], receiver: PromiseOrValue<string>, feeNumerator: PromiseOrValue<BigNumberish>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+    /**
+     * @returns a populated transaction for the setRoyaltyAllowlistRegistry contract function
+     */
+    populateSetRoyaltyAllowlistRegistry(_royaltyAllowlist: PromiseOrValue<string>, overrides?: Overrides & {
+        from?: PromiseOrValue<string>;
+    }): Promise<PopulatedTransaction>;
+}
+
+type erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable = ERC721HybridPermissionedMintable;
+declare const erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable: typeof ERC721HybridPermissionedMintable;
+declare namespace erc721_hybrid_permissioned_mintable_d {
+  export {
+    erc721_hybrid_permissioned_mintable_d_ERC721HybridPermissionedMintable as ERC721HybridPermissionedMintable,
+  };
+}
+
 declare namespace ImmutableERC721Base {
     type IDMintStruct = {
         to: PromiseOrValue<string>;
@@ -29375,4 +29668,4 @@ declare namespace erc721_permissioned_mintable_d {
   };
 }
 
-export { blockchain_data_d as blockchainData, checkout_sdk_d as checkoutSdk, checkout_widgets_d as checkoutWidgets, config_d as config, erc20_d as erc20, erc721_permissioned_mintable_d as erc721PermissionedMintable, immutablex_client_d as immutablexClient, orderbook_d as orderbook, passport_d as passport, provider_d as provider };
+export { blockchain_data_d as blockchainData, checkout_sdk_d as checkoutSdk, checkout_widgets_d as checkoutWidgets, config_d as config, erc20_d as erc20, erc721_hybrid_permissioned_mintable_d as erc721HybridPermissionedMintable, erc721_permissioned_mintable_d as erc721PermissionedMintable, immutablex_client_d as immutablexClient, orderbook_d as orderbook, passport_d as passport, provider_d as provider };