Class ImmutableX

Hierarchy (view full)

Constructors

Properties

imxConfig: ImxConfiguration
assetApi: AssetsApi
balanceApi: BalancesApi
collectionApi: CollectionsApi
depositsApi: DepositsApi
encodingApi: EncodingApi
exchangeApi: ExchangesApi
metadataApi: MetadataApi
metadataRefreshesApi: MetadataRefreshesApi
mintsApi: MintsApi
nftCheckoutPrimaryApi: NftCheckoutPrimaryApi
ordersApi: OrdersApi
projectsApi: ProjectsApi
tokensApi: TokensApi
tradesApi: TradesApi
transfersApi: TransfersApi
usersApi: UsersApi
withdrawalsApi: WithdrawalsApi
workflows: Workflows

Methods

  • Get details of a Deposit with the given ID

    Parameters

    Returns Promise<x.Deposit>

    a promise that resolves with the requested Deposit

    IMXError

  • 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

    IMXError

  • Get details of an Asset

    Parameters

    Returns Promise<Asset>

    a promise that resolves with the requested Asset

    IMXError

  • Update a Collection

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • collectionAddress: string

      the Collection contract address

    • request: UpdateCollectionRequest

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

    Returns Promise<x.Collection>

    a promise that resolves with the updated Collection

    IMXError

  • Get a list of metadata refreshes

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • OptionalcollectionAddress: string

      the Collection contract address

    • OptionalpageSize: number

      the page size of the result

    • Optionalcursor: string

      the cursor

    Returns Promise<GetMetadataRefreshes>

    a promise that resolves with the requested metadata refreshes

    IMXError

  • Get a Project

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • id: string

      the Project ID

    Returns Promise<Project>

    a promise that resolves with the requested Project

    IMXError

  • Get the token Balances of the User

    Parameters

    Returns Promise<Balance>

    a promise that resolves with the requested Balance

    IMXError

  • Get details of a Mint with the given ID

    Parameters

    • request: MintsApiGetMintRequest

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

    Returns Promise<x.Mint[]>

    a promise that resolves with the requested Mint

    IMXError

  • Get details of an Order with the given ID

    Parameters

    Returns Promise<OrderV3>

    a promise that resolves with the requested Order

    IMXError

  • Get details of a Trade with the given ID

    Parameters

    Returns Promise<x.Trade>

    a promise that resolves with the requested Trade

    IMXError

  • Get details of a Transfer with the given ID

    Parameters

    Returns Promise<x.Transfer>

    a promise that resolves with the requested Transfer

    IMXError