Immutable Docs
Immutable Hub
Preparing search index...
The search index is not available
@imtbl/sdk - v2.0.1
@imtbl/sdk
x
Namespace x
Index
References
Environment
Immutable
Configuration
Imx
Module
Configuration
generate
Legacy
Stark
Private
Key
create
Stark
Signer
Wallet
Connection
Namespaces
Contracts
Classes
IMXClient
ImmutableX
Api
Configuration
Imx
Configuration
IMXError
Transaction
Response
Assets
Api
Balances
Api
Collections
Api
Deposits
Api
Encoding
Api
Exchanges
Api
Mints
Api
Metadata
Api
Metadata
Refreshes
Api
Nft
Checkout
Primary
Api
Orders
Api
Projects
Api
Tokens
Api
Trades
Api
Transfers
Api
Users
Api
Withdrawals
Api
GenericIMXProvider
Meta
MaskIMXProvider
Provider
Configuration
Interfaces
Imx
Client
Module
Configuration
Imx
Client
Wallet
Connection
Eth
Configuration
ImmutableXConfiguration
Imx
Overrides
Config
Options
Eth
Signer
Stark
Signer
ERC20
Token
ERC721
Token
ETHToken
ETHAmount
ERC20
Amount
Unsigned
Order
Request
Stark
Ex
Contract
Version
Nft
Transfer
Details
Add
Metadata
Schema
To
Collection
Request
APIError
Asset
Assets
Api
Get
Asset
Request
Assets
Api
List
Assets
Request
Balance
Balances
Api
Get
Balance
Request
Balances
Api
List
Balances
Request
Cancel
Order
Response
Collection
Collection
Filter
Collections
Api
Get
Collection
Request
Collections
Api
List
Collection
Filters
Request
Collections
Api
List
Collections
Request
Create
Collection
Request
Create
Metadata
Refresh
Request
Create
Metadata
Refresh
Response
Create
Order
Response
Create
Trade
Response
Create
Transfer
Response
V1
Create
Withdrawal
Response
Currency
With
Limits
Deposit
Deposits
Api
Get
Deposit
Request
Deposits
Api
List
Deposits
Request
Exchange
Exchange
Create
Exchange
AndURLResponse
Exchanges
Api
Create
Exchange
Request
Exchanges
Api
Get
Exchange
Request
Exchanges
Api
Get
Exchanges
Request
Get
Metadata
Refreshes
Get
Metadata
Refresh
Errors
Response
Get
Metadata
Refresh
Response
Get
Signable
Cancel
Order
Request
Get
Signable
Order
Request
Get
Signable
Trade
Request
Get
Transactions
Response
Get
Users
Api
Response
List
Assets
Response
List
Balances
Response
List
Collections
Response
List
Deposits
Response
List
Mints
Response
List
Orders
Response
V3
List
Tokens
Response
List
Trades
Response
List
Transfers
Response
List
Withdrawals
Response
Metadata
Api
Get
Metadata
Schema
Request
Metadata
Schema
Property
Metadata
Schema
Request
Mint
Mint
Fee
Mint
Request
Mint
Result
Details
Mints
Api
Get
Mint
Request
Mints
Api
List
Mints
Request
Mints
Api
Mint
Tokens
Request
Mint
Token
Data
V2
Mint
Tokens
Response
Mint
User
Nft
Checkout
Primary
Api
Create
Nft
Primary
Request
Nft
Checkout
Primary
Api
Get
CurrenciesNFTCheckout
Primary
Request
Nft
Checkout
Primary
Api
Get
Nft
Primary
Transaction
Request
Nft
Checkout
Primary
Api
Get
Nft
Primary
Transactions
Request
Nftprimarytransaction
Create
Response
Nftprimarytransaction
Get
Response
Nftprimarytransaction
List
Transactions
Response
Orders
Api
Create
Order
V3
Request
Orders
Api
Get
Order
V3
Request
Orders
Api
List
Orders
V3
Request
Order
V3
Project
Signable
Token
Success
Response
Token
Details
Tokens
Api
Get
Token
Request
Tokens
Api
List
Tokens
Request
Trade
Trades
Api
Get
Trade
V3
Request
Trades
Api
List
Trades
V3
Request
Transfer
Transfers
Api
Get
Transfer
Request
Transfers
Api
List
Transfers
Request
Update
Collection
Request
Withdrawal
Withdrawals
Api
Get
Withdrawal
Request
Withdrawals
Api
List
Withdrawals
Request
IMXProvider
Type Aliases
Any
Token
Token
Amount
Exchange
Token
Amount
Unsigned
Transfer
Request
Unsigned
Mint
Request
Unsigned
Exchange
Transfer
Request
Variables
stark
Ec
Order
Metadata
Schema
Request
Type
Enum
Functions
imx
Client
Generate
Legacy
Stark
Private
Key
imx
Client
Create
Stark
Signer
create
Config
create
ImmutableXConfiguration
production
sandbox
imx
Client
Config
generate
Stark
Private
Key
serialize
Packed
Signature
sign
Register
Eth
Address
References
Environment
Re-exports
Environment
Immutable
Configuration
Re-exports
ImmutableConfiguration
Imx
Module
Configuration
Renames and re-exports
ImxClientModuleConfiguration
generate
Legacy
Stark
Private
Key
Renames and re-exports
imxClientGenerateLegacyStarkPrivateKey
create
Stark
Signer
Renames and re-exports
imxClientCreateStarkSigner
Wallet
Connection
Renames and re-exports
ImxClientWalletConnection
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
References
Environment
Immutable
Configuration
Imx
Module
Configuration
generate
Legacy
Stark
Private
Key
create
Stark
Signer
Wallet
Connection
Immutable Docs
Immutable Hub
@imtbl/sdk - v2.0.1
config
ImmutableConfiguration
ModuleConfiguration
Environment
KeyHeaders
addKeysToHeadersOverride
blockchainData
APIError
BlockchainData
BlockchainDataModuleConfiguration
ActivityType
Types
GetActivityResult
ListActivitiesResult
GetActivityRequestParams
ListActivitiesRequestParams
ListActivityHistoryRequestParams
ListChainsResult
ListChainsRequestParams
GetCollectionResult
ListCollectionsResult
RefreshCollectionMetadataRequest
RefreshCollectionMetadataResult
GetCollectionRequestParams
ListCollectionsRequestParams
ListCollectionsByNFTOwnerRequestParams
RefreshCollectionMetadataRequestParams
SignCraftingRequest
SignCraftingResult
SignCraftingPayloadRequestParams
GetMetadataResult
ListMetadataResult
MetadataRefreshRateLimitResult
RefreshMetadataByIDRequest
RefreshNFTMetadataByTokenIDRequest
StackBundle
GetMetadataRequestParams
ListMetadataRequestParams
ListMetadataForChainRequestParams
ListStacksRequestParams
RefreshMetadataByIDRequestParams
RefreshNFTMetadataByTokenIDRequestParams
ListFiltersResult
SearchNFTsResult
SearchStacksResult
ListFiltersRequestParams
SearchNFTsRequestParams
SearchStacksRequestParams
ListCollectionOwnersResult
ListNFTOwnersResult
ListAllNFTOwnersRequestParams
ListNFTOwnersRequestParams
ListOwnersByContractAddressRequestParams
CreateMintRequestRequest
CreateMintRequestResult
GetNFTResult
ListMintRequestsResult
ListNFTsByOwnerResult
ListNFTsResult
CreateMintRequestRequestParams
GetMintRequestRequestParams
GetNFTRequestParams
ListAllNFTsRequestParams
ListMintRequestsRequestParams
ListNFTsRequestParams
ListNFTsByAccountAddressRequestParams
QuotesForNFTsResult
QuotesForStacksResult
QuotesForNFTsRequestParams
QuotesForStacksRequestParams
GetTokenResult
ListTokensResult
GetERC20TokenRequestParams
ListERC20TokensRequestParams
APIError400AllOf
APIError401AllOf
APIError403AllOf
APIError404AllOf
APIError409AllOf
APIError429AllOf
APIError500AllOf
Activity
ActivityNFT
ActivityNativeToken
ActivityToken
BasicAPIError
Bid
BlockchainMetadata
Burn
Call
Chain
ChainWithDetailsAllOf
Collection
CollectionMetadata
Deposit
Filter
FilterResult
FilterValue
GetMintRequestResult
LastTrade
Listing
Market
MarketNft
MarketPriceDetails
MarketPriceERC20Token
MarketPriceFees
MarketPriceNativeToken
Metadata
Mint
MintAsset
MintRequestErrorMessage
NFT
NFTBundle
NFTMetadataAttribute
NFTMetadataRequest
NFTOwner
NFTQuoteResult
NFTSale
NFTWithBalance
NFTWithOwner
NFTWithStack
Page
RefreshMetadataByIDAllOf
RefreshMetadataByTokenIDAllOf
SaleFee
SalePayment
SignCraftingRequestMultiCaller
Stack
StackQuoteResult
Token
Transfer
Withdrawal
ActivityType
AssetVerificationStatus
SearchStacksSortByEnum
MintRequestStatus
APIError400AllOfCodeEnum
APIError401AllOfCodeEnum
APIError403AllOfCodeEnum
APIError404AllOfCodeEnum
APIError409AllOfCodeEnum
APIError429AllOfCodeEnum
APIError500AllOfCodeEnum
CollectionContractType
MarketPriceERC20TokenTypeEnum
MarketPriceFeesTypeEnum
MarketPriceNativeTokenTypeEnum
MarketplaceContractType
NFTContractType
NFTMetadataAttributeDisplayTypeEnum
SaleFeeTypeEnum
TokenContractType
APIError400
APIError404
APIError500
APIError401
APIError403
APIError429
APIError409
ActivityAsset
ActivityDetails
ChainWithDetails
MarketFloorListing
MarketPriceDetailsToken
MarketTopBid
NFTMetadataAttributeValue
RefreshMetadataByID
RefreshMetadataByTokenID
RefreshableNFTAttributes
SalePaymentToken
passport
PassportError
Passport
JsonRpcError
RequestArguments
JsonRpcResponsePayload
JsonRpcRequestCallback
TypedDataPayload
PassportOverrides
PassportModuleConfiguration
ProviderEvent
ProviderErrorCode
RpcErrorCode
JsonRpcRequestPayload
Provider
AccountsChangedEvent
LinkWalletParams
LinkedWallet
UserProfile
DeviceConnectResponse
DeviceTokenResponse
orderbook
Orderbook
OrderbookModuleConfiguration
OrderbookOverrides
NativeItem
ERC20Item
ERC721Item
ERC1155Item
ERC721CollectionItem
ERC1155CollectionItem
Listing
Bid
CollectionBid
Trade
Fee
FeeValue
PrepareOrderResponse
ListingResult
ListListingsResult
PrepareListingParams
PrepareBulkListingsParams
PrepareBulkListingsResponse
CreateListingParams
BulkListingsResult
BidResult
ListBidsResult
PrepareBidParams
CreateBidParams
BulkBidsResult
CollectionBidResult
ListCollectionBidsResult
PrepareCollectionBidParams
CreateCollectionBidParams
BulkCollectionBidsResult
FulfillmentOrder
FulfillmentListing
FulfillBulkOrdersSufficientBalanceResponse
FulfillBulkOrdersInsufficientBalanceResponse
FulfillOrderResponse
UnfulfillableOrder
PrepareCancelOrdersResponse
CancelOrdersOnChainResponse
TradeResult
ListTradesResult
TransactionAction
SignableAction
RoyaltyInfo
Page
PrepareBulkSeaportOrders
OrderStatusName
FeeType
ActionType
TransactionPurpose
SignablePurpose
Order
ListListingsParams
PrepareListingResponse
ListBidsParams
PrepareBidResponse
ListCollectionBidsParams
PrepareCollectionBidResponse
FulfillBulkOrdersResponse
ListTradesParams
Action
TransactionBuilder
constants
checkout
Checkout
WrappedBrowserProvider
CheckoutError
CheckoutConfiguration
BlockExplorerService
EIP1193Provider
EIP6963ProviderInfo
EIP6963ProviderDetail
BuyParams
CancelParams
CheckConnectionParams
CheckConnectionResult
CheckoutModuleConfiguration
CheckoutOnRampConfiguration
CheckoutBridgeConfiguration
CheckoutSwapConfiguration
ConnectParams
ConnectResult
CreateProviderParams
FeePercentage
FeeToken
FiatRampParams
GasEstimateBridgeToL2Result
GasEstimateSwapResult
GetAllBalancesParams
GetAllBalancesResult
GetBalanceParams
GetBalanceResult
GetNetworkAllowListParams
GetNetworkAllowListResult
GetNetworkParams
GetTokenInfoParams
GetTokenAllowListParams
GetTokenAllowListResult
GetWalletAllowListParams
GetWalletAllowListResult
NetworkFilter
NetworkInfo
OrderFee
SellParams
SendTransactionParams
SendTransactionResult
SmartCheckoutParams
SwitchNetworkParams
SwitchNetworkResult
TokenAmountEstimate
TokenFilter
TokenInfo
WalletFilter
WalletInfo
WalletConnectManager
IWidgetsFactory
IWidgetsFactoryCreate
Widget
ChainId
ChainName
ChainSlug
CheckoutStatus
ExchangeType
FeeType
FundingStepType
GasEstimateType
GasTokenType
ItemType
NetworkFilterTypes
RoutingOutcomeType
TokenFilterTypes
TransactionOrGasType
WalletFilterTypes
WalletProviderName
WalletProviderRdns
CheckoutErrorType
IMTBLWidgetEvents
ProviderEventType
ConnectEventType
WalletEventType
SwapEventType
SaleEventType
SalePaymentTypes
BridgeEventType
OrchestrationEventType
OnRampEventType
CommerceEventType
CommerceSuccessEventType
CommerceFailureEventType
CommerceUserActionEventType
AddTokensEventType
PurchaseEventType
WidgetType
ConnectTargetLayer
SwapDirection
CommerceFlowType
WidgetTheme
AddTokensConfig
AllowedNetworkConfig
AvailableRoutingOptions
BalanceDelta
BridgeFundingStep
BuyOrder
BuyOverrides
BuyResult
BuyResultFailed
BuyResultInsufficientFunds
BuyResultSuccess
BuyResultFulfillmentsUnsettled
BuyToken
CancelOverrides
CancelResult
CancelResultFailed
CancelResultGasless
CancelResultSuccess
CancelResultFulfillmentsUnsettled
DexConfig
ERC20ItemRequirement
ERC721Balance
ERC721ItemRequirement
FailedGaslessCancellation
Fee
FulfillmentTransaction
FundingItem
FundingRoute
FundingStep
GasAmount
GasEstimateParams
GasEstimateTokenConfig
GasToken
ItemBalance
NativeItemRequirement
NoRouteOptions
NoRoutesFound
OnRampFundingStep
OnRampProviderFees
PendingGaslessCancellation
RemoteConfiguration
RoutesFound
RoutingOutcome
SellOrder
SellResult
SellResultFailed
SellResultInsufficientFunds
SellResultSuccess
SellToken
SmartCheckoutInsufficient
SmartCheckoutResult
SmartCheckoutRouter
SmartCheckoutSufficient
SuccessfulGaslessCancellation
SwapFees
SwapFundingStep
TelemetryConfig
TokenBalance
TransactionRequirement
SquidConfig
CheckoutWidgetsVersionConfig
AssessmentResult
ErrorType
ProviderUpdated
LanguageChanged
ConnectionSuccess
ConnectionFailed
WalletConnectProviderChanged
WalletNetworkSwitch
WalletDisconnect
SwapSuccess
SwapFailed
SwapRejected
SaleSuccess
SaleFailed
SaleTransactionSuccess
SalePaymentMethod
SalePaymentToken
BridgeTransactionSent
BridgeFailed
BridgeClaimWithdrawalSuccess
BridgeClaimWithdrawalFailed
RequestConnectEvent
RequestWalletEvent
RequestSwapEvent
RequestBridgeEvent
RequestOnrampEvent
RequestAddTokensEvent
RequestGoBackEvent
OrchestrationEventData
OnRampSuccess
OnRampFailed
CommerceProviderUpdatedEvent
CommerceSaleSuccessEvent
CommerceSaleSuccessfulTransactionEvent
CommerceOnRampSuccessEvent
CommerceBridgeSuccessEvent
CommerceBridgeClaimWithdrawalSuccessEvent
CommerceSwapSuccessEvent
CommerceConnectSuccessEvent
CommerceAddTokensSuccessEvent
CommerceAddTokensConnectSuccessEvent
CommerceSuccessEvent
CommerceBridgeFailureEvent
CommerceBridgeClaimWithdrawalFailedEvent
CommerceConnectFailureEvent
CommerceOnRampFailureEvent
CommerceSwapFailureEvent
CommerceSwapRejectedEvent
CommerceSaleFailureEvent
CommerceAddTokensFailureEvent
CommerceFailureEvent
CommercePaymentMethodSelectedEvent
CommercePaymentTokenSelectedEvent
CommerceNetworkSwitchEvent
CommerceUserActionEvent
AddTokensSuccess
AddTokensFailed
AddTokensConnectSuccess
PurchaseSuccess
PurchaseFailed
PurchaseConnectSuccess
WidgetProperties
WidgetConfigurations
WidgetParameters
WidgetEventTypes
WidgetEventData
WidgetEvent
OrchestrationEvent
ProviderEvent
SemanticVersion
CheckoutWidgetsConfig
AddTokensWidgetParams
ConnectWidgetParams
BridgeWidgetParams
WalletWidgetParams
SwapWidgetParams
OnRampWidgetParams
SaleWidgetParams
SaleItem
CommerceWidgetConnectFlowParams
CommerceWidgetWalletFlowParams
CommerceWidgetSwapFlowParams
CommerceWidgetBridgeFlowParams
CommerceWidgetOnRampFlowParams
CommerceWidgetSaleFlowParams
CommerceWidgetAddTokensFlowParams
CommerceWidgetPurchaseFlowParams
CommerceWidgetFlowParams
CommerceWidgetParams
PurchaseWidgetParams
PurchaseItem
ConnectWidgetConfiguration
BridgeWidgetConfiguration
WalletWidgetConfiguration
SwapWidgetConfiguration
OnrampWidgetConfiguration
SaleWidgetConfiguration
WidgetConfiguration
WidgetLanguage
WalletConnectConfig
AddTokensWidgetConfiguration
CommerceWidgetConfiguration
PurchaseWidgetConfiguration
IMMUTABLE_API_BASE_URL
passportProviderInfo
metaMaskProviderInfo
getPassportProviderDetail
getMetaMaskProviderDetail
validateProvider
getUnderlyingChainId
getGasPriceInWei
fetchRiskAssessment
isAddressSanctioned
x
IMXClient
ImmutableX
ApiConfiguration
ImxConfiguration
IMXError
TransactionResponse
AssetsApi
BalancesApi
CollectionsApi
DepositsApi
EncodingApi
ExchangesApi
MintsApi
MetadataApi
MetadataRefreshesApi
NftCheckoutPrimaryApi
OrdersApi
ProjectsApi
TokensApi
TradesApi
TransfersApi
UsersApi
WithdrawalsApi
GenericIMXProvider
MetaMaskIMXProvider
ProviderConfiguration
ImxClientModuleConfiguration
ImxClientWalletConnection
EthConfiguration
ImmutableXConfiguration
ImxOverrides
ConfigOptions
EthSigner
StarkSigner
ERC20Token
ERC721Token
ETHToken
ETHAmount
ERC20Amount
UnsignedOrderRequest
StarkExContractVersion
NftTransferDetails
AddMetadataSchemaToCollectionRequest
APIError
Asset
AssetsApiGetAssetRequest
AssetsApiListAssetsRequest
Balance
BalancesApiGetBalanceRequest
BalancesApiListBalancesRequest
CancelOrderResponse
Collection
CollectionFilter
CollectionsApiGetCollectionRequest
CollectionsApiListCollectionFiltersRequest
CollectionsApiListCollectionsRequest
CreateCollectionRequest
CreateMetadataRefreshRequest
CreateMetadataRefreshResponse
CreateOrderResponse
CreateTradeResponse
CreateTransferResponseV1
CreateWithdrawalResponse
CurrencyWithLimits
Deposit
DepositsApiGetDepositRequest
DepositsApiListDepositsRequest
Exchange
ExchangeCreateExchangeAndURLResponse
ExchangesApiCreateExchangeRequest
ExchangesApiGetExchangeRequest
ExchangesApiGetExchangesRequest
GetMetadataRefreshes
GetMetadataRefreshErrorsResponse
GetMetadataRefreshResponse
GetSignableCancelOrderRequest
GetSignableOrderRequest
GetSignableTradeRequest
GetTransactionsResponse
GetUsersApiResponse
ListAssetsResponse
ListBalancesResponse
ListCollectionsResponse
ListDepositsResponse
ListMintsResponse
ListOrdersResponseV3
ListTokensResponse
ListTradesResponse
ListTransfersResponse
ListWithdrawalsResponse
MetadataApiGetMetadataSchemaRequest
MetadataSchemaProperty
MetadataSchemaRequest
Mint
MintFee
MintRequest
MintResultDetails
MintsApiGetMintRequest
MintsApiListMintsRequest
MintsApiMintTokensRequest
MintTokenDataV2
MintTokensResponse
MintUser
NftCheckoutPrimaryApiCreateNftPrimaryRequest
NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest
NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest
NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest
NftprimarytransactionCreateResponse
NftprimarytransactionGetResponse
NftprimarytransactionListTransactionsResponse
OrdersApiCreateOrderV3Request
OrdersApiGetOrderV3Request
OrdersApiListOrdersV3Request
OrderV3
Project
SignableToken
SuccessResponse
TokenDetails
TokensApiGetTokenRequest
TokensApiListTokensRequest
Trade
TradesApiGetTradeV3Request
TradesApiListTradesV3Request
Transfer
TransfersApiGetTransferRequest
TransfersApiListTransfersRequest
UpdateCollectionRequest
Withdrawal
WithdrawalsApiGetWithdrawalRequest
WithdrawalsApiListWithdrawalsRequest
IMXProvider
AnyToken
TokenAmount
ExchangeTokenAmount
UnsignedTransferRequest
UnsignedMintRequest
UnsignedExchangeTransferRequest
starkEcOrder
MetadataSchemaRequestTypeEnum
imxClientGenerateLegacyStarkPrivateKey
imxClientCreateStarkSigner
createConfig
createImmutableXConfiguration
production
sandbox
imxClientConfig
generateStarkPrivateKey
serializePackedSignature
signRegisterEthAddress
Contracts
Core
CoreV4
Registration
RegistrationV4
IERC20
IERC721
CoreContract
CoreV4Contract
RegistrationContract
RegistrationV4Contract
webhook
BlockChainMetadata
Chain
ZkevmActivityBurn
ZkevmActivityDeposit
ZkevmActivityMint
ZkevmActivitySale
ZkevmActivityTransfer
ZkevmActivityWithdrawal
ZkevmCollectionUpdated
ZkevmMetadataUpdated
ZkevmMintRequestUpdated
ZkevmNftUpdated
ZkevmOrderUpdated
ZkevmTokenUpdated
ZkevmTradeCreated
WebhookHandlers
handle
mintingBackend
MintingBackendModule
MintingBackendModuleConfiguration
submitMintingRequests
processMint
recordMint
mintingPersistencePg
mintingPersistencePrismaSqlite
"
"