Interface IMXProvider

interface IMXProvider {
    getAddress(): Promise<string>;
    registerOffchain(): Promise<RegisterUserResponse>;
    isRegisteredOffchain(): Promise<boolean>;
    isRegisteredOnchain(): Promise<boolean>;
    createOrder(request: UnsignedOrderRequest): Promise<CreateOrderResponse>;
    cancelOrder(request: GetSignableCancelOrderRequest): Promise<CancelOrderResponse>;
    createTrade(request: GetSignableTradeRequest): Promise<CreateTradeResponse>;
    transfer(request: UnsignedTransferRequest): Promise<CreateTransferResponseV1>;
    batchNftTransfer(request: NftTransferDetails[]): Promise<CreateTransferResponse>;
    exchangeTransfer(request: UnsignedExchangeTransferRequest): Promise<CreateTransferResponseV1>;
    deposit(deposit: TokenAmount): Promise<TransactionResponse>;
    prepareWithdrawal(request: TokenAmount): Promise<CreateWithdrawalResponse>;
    completeWithdrawal(starkPublicKey: string, token: AnyToken): Promise<TransactionResponse>;
}

Implemented by

Methods

getAddress registerOffchain isRegisteredOffchain isRegisteredOnchain createOrder cancelOrder createTrade transfer batchNftTransfer exchangeTransfer deposit prepareWithdrawal completeWithdrawal

Methods

getAddress

  • getAddress(): Promise<string>

  • Get the Signer address

    Returns Promise<string>

    Returns a promise that resolves with the signer's address

registerOffchain

  • registerOffchain(): Promise<RegisterUserResponse>

  • Register a User to Immutable X if they are not already registered

    Returns Promise<RegisterUserResponse>

    Returns a promise that resolves with the user registration response

isRegisteredOffchain

  • isRegisteredOffchain(): Promise<boolean>

  • Checks if a User is registered off-chain

    Returns Promise<boolean>

    Returns a promise that resolves with true if the User is registered with IMX, false otherwise

isRegisteredOnchain

  • isRegisteredOnchain(): Promise<boolean>

  • Checks if a User is registered on-chain

    Returns Promise<boolean>

    Returns a promise that resolves with true if the User is registered, false otherwise

createOrder

  • createOrder(request): Promise<CreateOrderResponse>

  • Create an Order

    Parameters

    Returns Promise<CreateOrderResponse>

    Returns a promise that resolves with the created Order

cancelOrder

  • cancelOrder(request): Promise<CancelOrderResponse>

  • Cancel an Order

    Parameters

    Returns Promise<CancelOrderResponse>

    Returns a promise that resolves with the cancelled Order

createTrade

transfer

  • transfer(request): Promise<CreateTransferResponseV1>

  • Create a new Transfer request

    Parameters

    Returns Promise<CreateTransferResponseV1>

    Returns a promise that resolves with the created Transfer

batchNftTransfer

  • batchNftTransfer(request): Promise<CreateTransferResponse>

  • Create a batch of NFT transfer requests

    Parameters

    Returns Promise<CreateTransferResponse>

    Resolves a promise that resolves with the list of Transfer IDs

exchangeTransfer

  • exchangeTransfer(request): Promise<CreateTransferResponseV1>

  • Create a new Exchange transaction

    Parameters

    Returns Promise<CreateTransferResponseV1>

    Returns a promise that resolves with the created Exchange Transaction

deposit

  • deposit(deposit): Promise<TransactionResponse>

  • Deposit either ETH, ERC20 or ERC721 tokens

    Parameters

    Returns Promise<TransactionResponse>

    Returns a promise that resolves with the transaction

prepareWithdrawal

  • prepareWithdrawal(request): Promise<CreateWithdrawalResponse>

  • Create a Withdrawal

    Parameters

    • request: TokenAmount

      The token type amount in its corresponding unit

    Returns Promise<CreateWithdrawalResponse>

    Returns a promise that resolves with the created Withdrawal

completeWithdrawal

  • completeWithdrawal(starkPublicKey, token): Promise<TransactionResponse>

  • Completes a Withdrawal

    Parameters

    • starkPublicKey: string

      The stark public key

    • token: AnyToken

      The token to withdraw

    Returns Promise<TransactionResponse>

    Returns a promise that resolves with the transaction

Settings

Member Visibility

On This Page

Methods