Skip to main content

Install and initialize


Core SDK

The Core SDK is a wrapper around our API and provides the bulk of the functionality of the ImmutableX platform. Before you can start using the Core SDK, you must initialize the client.

Initialize the Core SDK client with the network on which you want your application to run:

SandboxThe default test network (currently, it is Goërli)
ProductionEthereum network
  1. Install the npm package
npm install @imtbl/core-sdk --save
# or
yarn add @imtbl/core-sdk
  1. Initialize the SDK with the correct environment:
import { ImmutableX, Config } from '@imtbl/core-sdk';

const config = Config.SANDBOX; // Or Config.PRODUCTION
const client = new ImmutableX(config);