Class ImmutableX

constructor

• new ImmutableX(config): x.ImmutableX

• Parameters

  • config: x.ImxClientModuleConfiguration

  Returns x.ImmutableX

imxConfig

assetApi

balanceApi

collectionApi

depositsApi

encodingApi

exchangeApi

metadataApi

metadataRefreshesApi

mintsApi

nftCheckoutPrimaryApi

ordersApi

primarySalesApi

projectsApi

tokensApi

tradesApi

transfersApi

usersApi

withdrawalsApi

workflows

getDeposit

• getDeposit(request): Promise<Deposit>

• Get details of a Deposit with the given ID

  Parameters

  • request: x.DepositsApiGetDepositRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Deposit>

  a promise that resolves with the requested Deposit

  Throws

  index.IMXError

listDeposits

• listDeposits(request?): Promise<ListDepositsResponse>

• Get a list of Deposits

  Parameters

  • Optional request: x.DepositsApiListDepositsRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListDepositsResponse>

  a promise that resolves with the requested list of Deposits

  Throws

  index.IMXError

getUser

• getUser(ethAddress): Promise<GetUsersApiResponse>

• Get Stark keys for a registered User

  Parameters

  • ethAddress: string

    the eth address of the User

  Returns Promise<GetUsersApiResponse>

  a promise that resolves with the requested User

  Throws

  index.IMXError

getAsset

• getAsset(request): Promise<Asset>

• Get details of an Asset

  Parameters

  • request: x.AssetsApiGetAssetRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Asset>

  a promise that resolves with the requested Asset

  Throws

  index.IMXError

listAssets

• listAssets(request?): Promise<ListAssetsResponse>

• Get a list of Assets

  Parameters

  • Optional request: x.AssetsApiListAssetsRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListAssetsResponse>

  a promise that resolves with the requested list of Assets

  Throws

  index.IMXError

createCollection

• createCollection(ethSigner, request): Promise<Collection>

• Create a Collection

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • request: x.CreateCollectionRequest

    the request object to be provided in the API request

  Returns Promise<Collection>

  a promise that resolves with the created Collection

  Throws

  index.IMXError

getCollection

• getCollection(request): Promise<Collection>

• Get details of a Collection at the given address

  Parameters

  • request: x.CollectionsApiGetCollectionRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Collection>

  a promise that resolves with the requested Collection

  Throws

  index.IMXError

listCollectionFilters

• listCollectionFilters(request): Promise<CollectionFilter[]>

• Get a list of Collection filters

  Parameters

  • request: x.CollectionsApiListCollectionFiltersRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<CollectionFilter[]>

  a promise that resolves with the requested list of Collection Filters

  Throws

  index.IMXError

listCollections

• listCollections(request?): Promise<ListCollectionsResponse>

• Get a list of Collections

  Parameters

  • Optional request: x.CollectionsApiListCollectionsRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListCollectionsResponse>

  a promise that resolves with the requested list of Collections

  Throws

  index.IMXError

updateCollection

• updateCollection(ethSigner, collectionAddress, request): Promise<Collection>

• Update a Collection

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • collectionAddress: string

    the Collection contract address

  • request: x.UpdateCollectionRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Collection>

  a promise that resolves with the updated Collection

  Throws

  index.IMXError

addMetadataSchemaToCollection

• addMetadataSchemaToCollection(ethSigner, collectionAddress, request): Promise<SuccessResponse>

• Add metadata schema to Collection

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • collectionAddress: string

    the Collection contract address

  • request: x.AddMetadataSchemaToCollectionRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<SuccessResponse>

  a promise that resolves with the SuccessResponse if successful

  Throws

  index.IMXError

getMetadataSchema

• getMetadataSchema(request): Promise<MetadataSchemaProperty[]>

• Get Metadata schema

  Parameters

  • request: x.MetadataApiGetMetadataSchemaRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<MetadataSchemaProperty[]>

  a promise that resolves with the requested Metadata schema

  Throws

  index.IMXError

updateMetadataSchemaByName

• updateMetadataSchemaByName(ethSigner, collectionAddress, name, request): Promise<SuccessResponse>

• Update metadata schema by name

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • collectionAddress: string

    the Collection contract address

  • name: string

    the Metadata schema name

  • request: x.MetadataSchemaRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<SuccessResponse>

  a promise that resolves with the SuccessResponse if successful

  Throws

  index.IMXError

listMetadataRefreshes

• listMetadataRefreshes(ethSigner, collectionAddress?, pageSize?, cursor?): Promise<GetMetadataRefreshes>

• Get a list of metadata refreshes

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • Optional collectionAddress: string

    the Collection contract address

  • Optional pageSize: number

    the page size of the result

  • Optional cursor: string

    the cursor

  Returns Promise<GetMetadataRefreshes>

  a promise that resolves with the requested metadata refreshes

  Throws

  index.IMXError

getMetadataRefreshErrors

• getMetadataRefreshErrors(ethSigner, refreshId, pageSize?, cursor?): Promise<GetMetadataRefreshErrorsResponse>

• Get a list of metadata refresh errors

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • refreshId: string

    the metadata refresh ID

  • Optional pageSize: number

    the page size of the result

  • Optional cursor: string

    the cursor

  Returns Promise<GetMetadataRefreshErrorsResponse>

  a promise that resolves with the requested metadata refresh errors

  Throws

  index.IMXError

getMetadataRefreshResults

• getMetadataRefreshResults(ethSigner, refreshId): Promise<GetMetadataRefreshResponse>

• Get a list of metadata refresh results

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • refreshId: string

    the metadata refresh ID

  Returns Promise<GetMetadataRefreshResponse>

  a promise that resolves with the requested metadata refresh results

  Throws

  index.IMXError

createMetadataRefresh

• createMetadataRefresh(ethSigner, request): Promise<CreateMetadataRefreshResponse>

• Request a metadata refresh

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • request: x.CreateMetadataRefreshRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<CreateMetadataRefreshResponse>

  a promise that resolves with the requested metadata refresh

  Throws

  index.IMXError

getProject

• getProject(ethSigner, id): Promise<Project>

• Get a Project

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • id: string

    the Project ID

  Returns Promise<Project>

  a promise that resolves with the requested Project

  Throws

  index.IMXError

getBalance

• getBalance(request): Promise<Balance>

• Get the token Balances of the User

  Parameters

  • request: x.BalancesApiGetBalanceRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Balance>

  a promise that resolves with the requested Balance

  Throws

  index.IMXError

listBalances

• listBalances(request): Promise<ListBalancesResponse>

• Get a list of Balances for given User

  Parameters

  • request: x.BalancesApiListBalancesRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<ListBalancesResponse>

  a promise that resolves with the requested list of Balances

  Throws

  index.IMXError

getMint

• getMint(request): Promise<Mint[]>

• Get details of a Mint with the given ID

  Parameters

  • request: x.MintsApiGetMintRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Mint[]>

  a promise that resolves with the requested Mint

  Throws

  index.IMXError

listMints

• listMints(request?): Promise<ListMintsResponse>

• Get a list of Mints

  Parameters

  • Optional request: x.MintsApiListMintsRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListMintsResponse>

  a promise that resolves with the requested list of Mints

  Throws

  index.IMXError

mint

• mint(ethSigner, request): Promise<x.MintTokensResponse>

• Mint tokens in a batch with fees

  Parameters

  • ethSigner: x.EthSigner

    the L1 signer

  • request: x.UnsignedMintRequest

    the request object to be provided in the API request

  Returns Promise<x.MintTokensResponse>

  a promise that resolves with the minted tokens

  Throws

  index.IMXError

listWithdrawals

• listWithdrawals(request?): Promise<ListWithdrawalsResponse>

• Get a list of Withdrawals

  Parameters

  • Optional request: x.WithdrawalsApiListWithdrawalsRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListWithdrawalsResponse>

  a promise that resolves with the requested list of Withdrawals

  Throws

  index.IMXError

getWithdrawal

• getWithdrawal(request): Promise<Withdrawal>

• Get details of Withdrawal with the given ID

  Parameters

  • request: x.WithdrawalsApiGetWithdrawalRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Withdrawal>

  a promise that resolves with the requested Withdrawal

  Throws

  index.IMXError

getOrder

• getOrder(request): Promise<OrderV3>

• Get details of an Order with the given ID

  Parameters

  • request: x.OrdersApiGetOrderV3Request

    the request object containing the parameters to be provided in the API request

  Returns Promise<OrderV3>

  a promise that resolves with the requested Order

  Throws

  index.IMXError

listOrders

• listOrders(request?): Promise<ListOrdersResponseV3>

• Get a list of Orders

  Parameters

  • Optional request: x.OrdersApiListOrdersV3Request

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListOrdersResponseV3>

  a promise that resolves with the requested list of Orders

  Throws

  index.IMXError

getTrade

• getTrade(request): Promise<Trade>

• Get details of a Trade with the given ID

  Parameters

  • request: x.TradesApiGetTradeV3Request

    the request object containing the parameters to be provided in the API request

  Returns Promise<Trade>

  a promise that resolves with the requested Trade

  Throws

  index.IMXError

listTrades

• listTrades(request?): Promise<ListTradesResponse>

• Get a list of Trades

  Parameters

  • Optional request: x.TradesApiListTradesV3Request

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListTradesResponse>

  a promise that resolves with the requested list of Trades

  Throws

  index.IMXError

getToken

• getToken(request): Promise<TokenDetails>

• Get details of a Token

  Parameters

  • request: x.TokensApiGetTokenRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<TokenDetails>

  a promise that resolves with the requested Token

  Throws

  index.IMXError

listTokens

• listTokens(request?): Promise<ListTokensResponse>

• Get a list of Tokens

  Parameters

  • Optional request: x.TokensApiListTokensRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListTokensResponse>

  a promise that resolves with the requested list of Tokens

  Throws

  index.IMXError

getTransfer

• getTransfer(request): Promise<Transfer>

• Get details of a Transfer with the given ID

  Parameters

  • request: x.TransfersApiGetTransferRequest

    the request object containing the parameters to be provided in the API request

  Returns Promise<Transfer>

  a promise that resolves with the requested Transfer

  Throws

  index.IMXError

listTransfers

• listTransfers(request?): Promise<ListTransfersResponse>

• Get a list of Transfers

  Parameters

  • Optional request: x.TransfersApiListTransfersRequest

    optional object containing the parameters to be provided in the API request

  Returns Promise<ListTransfersResponse>

  a promise that resolves with the requested list of Transfers

  Throws

  index.IMXError

createExchange

• createExchange(request): Promise<ExchangeCreateExchangeAndURLResponse>

• Create a new Exchange transaction

  Parameters

  • request: x.ExchangesApiCreateExchangeRequest

    the request object to be provided in the API request

  Returns Promise<ExchangeCreateExchangeAndURLResponse>

  a promise that resolves with the created Exchange Transaction

  Throws

  index.IMXError

getExchange

• getExchange(request): Promise<Exchange>

• Get an Exchange transaction

  Parameters

  • request: x.ExchangesApiGetExchangeRequest

    the request object to be provided in the API request

  Returns Promise<Exchange>

  a promise that resolves with the Exchange Transaction

  Throws

  index.IMXError

getExchanges

• getExchanges(request): Promise<GetTransactionsResponse>

• Get Exchange transactions

  Parameters

  • request: x.ExchangesApiGetExchangesRequest

    the request object to be provided in the API request

  Returns Promise<GetTransactionsResponse>

  a promise that resolves with Exchange Transactions

  Throws

  index.IMXError

exchangeTransfer

• exchangeTransfer(walletConnection, request): Promise<x.CreateTransferResponseV1>

• Create a new Transfer request

  Parameters

  • walletConnection: x.ImxClientWalletConnection

    the pair of Eth/Stark signers

  • request: x.UnsignedExchangeTransferRequest

    the request object to be provided in the API request

  Returns Promise<x.CreateTransferResponseV1>

  a promise that resolves with the created Exchange Transfer

  Throws

  index.IMXError

createNftPrimary

• createNftPrimary(request): Promise<NftprimarytransactionCreateResponse>

• Create a new nft primary transaction

  Parameters

  • request: x.NftCheckoutPrimaryApiCreateNftPrimaryRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionCreateResponse>

  a promise that resolves with the created nft primary Transaction

  Throws

  index.IMXError

getCurrenciesNFTCheckoutPrimary

• getCurrenciesNFTCheckoutPrimary(request): Promise<CurrencyWithLimits>

• Get nft primary supported currencies and their limits

  Parameters

  • request: x.NftCheckoutPrimaryApiGetCurrenciesNFTCheckoutPrimaryRequest

    the request object to be provided in the API request

  Returns Promise<CurrencyWithLimits>

  a promise that resolves with nft primary Currencies

  Throws

  index.IMXError

getNftPrimaryTransaction

• getNftPrimaryTransaction(request): Promise<NftprimarytransactionGetResponse>

• Get nft primary transaction by transaction id

  Parameters

  • request: x.NftCheckoutPrimaryApiGetNftPrimaryTransactionRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionGetResponse>

  a promise that resolves with nft primary transaction

  Throws

  index.IMXError

getNftPrimaryTransactions

• getNftPrimaryTransactions(request): Promise<NftprimarytransactionListTransactionsResponse>

• Get list of nft primary transactions

  Parameters

  • request: x.NftCheckoutPrimaryApiGetNftPrimaryTransactionsRequest

    the request object to be provided in the API request

  Returns Promise<NftprimarytransactionListTransactionsResponse>

  a promise that resolves with nft primary transaction

  Throws

  index.IMXError

createPrimarySale

• createPrimarySale(walletConnection, request): Promise<x.CreatePrimarySaleBadRequestBody | x.CreatePrimarySaleCreatedBody | x.CreatePrimarySaleForbiddenBody | x.CreatePrimarySaleNotFoundBody | x.CreatePrimarySaleUnauthorizedBody>

• Create a PrimarySale

  Parameters

  • walletConnection: x.ImxClientWalletConnection

    the pair of L1/L2 signers

  • request: x.PrimarySalesApiSignableCreatePrimarySaleRequest

    the request object to be provided in the API request

  Returns Promise<x.CreatePrimarySaleBadRequestBody | x.CreatePrimarySaleCreatedBody | x.CreatePrimarySaleForbiddenBody | x.CreatePrimarySaleNotFoundBody | x.CreatePrimarySaleUnauthorizedBody>

  a promise that resolves with the created Trade

  Throws

  index.IMXError

acceptPrimarySale

• acceptPrimarySale(ethSigner, primarySaleId): Promise<x.AcceptPrimarySaleBadRequestBody | x.AcceptPrimarySaleForbiddenBody | x.AcceptPrimarySaleNotFoundBody | x.AcceptPrimarySaleOKBody | x.AcceptPrimarySaleUnauthorizedBody>

• Accept a PrimarySale

  Parameters

  • ethSigner: x.EthSigner

    eth signer matching the 'studio_ether_key' of the primary sale

  • primarySaleId: number

    id of the primary sale accepting

  Returns Promise<x.AcceptPrimarySaleBadRequestBody | x.AcceptPrimarySaleForbiddenBody | x.AcceptPrimarySaleNotFoundBody | x.AcceptPrimarySaleOKBody | x.AcceptPrimarySaleUnauthorizedBody>

  a promise that resolves with the created Trade

  Throws

  index.IMXError

rejectPrimarySale

• rejectPrimarySale(ethSigner, primarySaleId): Promise<x.RejectPrimarySaleBadRequestBody | x.RejectPrimarySaleForbiddenBody | x.RejectPrimarySaleNotFoundBody | x.RejectPrimarySaleOKBody | x.RejectPrimarySaleUnauthorizedBody>

• Reject a PrimarySale

  Parameters

  • ethSigner: x.EthSigner

    eth signer matching the 'studio_ether_key' of the primary sale

  • primarySaleId: number

    id of the primary sale to be rejected

  Returns Promise<x.RejectPrimarySaleBadRequestBody | x.RejectPrimarySaleForbiddenBody | x.RejectPrimarySaleNotFoundBody | x.RejectPrimarySaleOKBody | x.RejectPrimarySaleUnauthorizedBody>

  a promise that resolves with the rejected PrimarySale

  Throws

  index.IMXError