The main entry point for the Core SDK

Hierarchy

  • ImmutableX

Constructors

Methods

  • Completes a Withdrawal

    Returns

    a promise that resolves with the transaction

    Throws

    IMXError

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • starkPublicKey: string

      the Signer address

    • token: AnyToken

      the token

    Returns Promise<TransactionResponse>

  • Deposit based on a token type. For unregistered Users, the Deposit will be combined with a registration in order to register the User first

    Returns

    a promise that resolves with the resulting transaction

    Throws

    IMXError

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • deposit: TokenAmount

      the token type amount in its corresponding unit

    Returns Promise<TransactionResponse>

  • Get a list of metadata refresh errors

    Returns

    a promise that resolves with the requested metadata refresh errors

    Throws

    IMXError

    Parameters

    • ethSigner: 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>

  • Get Projects owned by the given User

    Returns

    a promise that resolves with the requested Projects

    Throws

    IMXError

    Parameters

    • ethSigner: EthSigner

      the L1 signer

    • Optional pageSize: number

      the page size of the result

    • Optional cursor: string

      the cursor

    • Optional orderBy: string

      the property to sort by

    • Optional direction: string

      direction to sort (asc/desc)

    Returns Promise<GetProjectsResponse>

  • Checks if a User is registered on on-chain

    Returns

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

    Throws

    IMXError

    Parameters

    Returns Promise<boolean>

  • Get a list of metadata refreshes

    Returns

    a promise that resolves with the requested metadata refreshes

    Throws

    IMXError

    Parameters

    • ethSigner: 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>

Generated using TypeDoc