Skip to content

multiversx/mx-sdk-js-core

Repository files navigation

MultiversX SDK for JavaScript and TypeScript

MultiversX SDK for JavaScript and TypeScript (written in TypeScript).

Documentation

Distribution

npm

Installation

sdk-core is delivered via npm and it can be installed as follows:

npm install @multiversx/sdk-core

Development

Feel free to skip this section if you are not a contributor.

Prerequisites

browserify is required to compile the browser-friendly versions of sdk-core. It can be installed as follows:

npm install --global browserify

Building the library

In order to compile the library, run the following:

npm install
npm run compile
npm run compile-browser

Running the tests

In order to run the tests on NodeJS, do as follows:

npm run tests-unit
npm run tests-localnet
npm run tests-devnet
npm run tests-testnet

Before running the tests in the browser, make sure you have the package http-server installed globally.

npm install --global http-server

In order to run the tests in the browser, do as follows:

make clean && npm run browser-tests

For the localnet tests, make sure you have a local testnet up & running. In order to start a local testnet, follow this.