About

The X-Client SDK package provides a set of functions and utilities for interacting with the ImmutableX StarkEx-based Layer 2 blockchain. It provides an IMXClient that is used for this purpose.

Read more about the X-Client package in our docs here

Table of Contents

• Installation
  • Individual Package Installation
  • SDK Installation
    • Conditional Exports
    • Direct Imports

Installation

Individual Package Installation

To install this package, run the following command:

npm add @imtbl/x-client
# or
pnpm add @imtbl/x-client
# or
yarn add @imtbl/x-client

SDK Installation

This package is also included within the @imtbl/sdk NPM package and can be re-exported directly from there.

Conditional Exports

If your environment supports conditional exports, you can import the contents of this package directly from the @imtbl/sdk package using the @imtbl/sdk/x import path like so:

import { IMXClient } from '@imtbl/sdk/x';

This is the recommended way of consuming this package, as it allows for better tree-shaking and smaller bundle sizes.

Direct Imports

If your environment does not support conditional exports, you will need to import the contents of this package directly from the @imtbl/sdk package like so:

import { x } from '@imtbl/sdk';

const { IMXClient } = x;

However this method will result in a larger bundle size as the entire @imtbl/x-client package will be included in your bundle.