MultiversX SDK for JavaScript and TypeScript (written in TypeScript).
sdk-core
is delivered via npm and it can be installed as follows:
npm install @multiversx/sdk-core
Feel free to skip this section if you are not a contributor.
browserify
and esmify
are required to compile the browser-friendly versions of sdk-core
. They can be installed as follows:
npm install --global browserify
npm install esmify --no-save
This package can make HTTP requests using axios
, which is not bundled by default. If you plan to use the API network provider or Proxy network provider, make sure to install axios
:
npm install axios
This package requires @multiversx/sdk-bls-wasm
for BLS (Boneh-Lynn-Shacham) cryptographic functions, which is not bundled by default. If you plan to use BLS functionality, make sure to install this optional dependency:
npm install @multiversx/sdk-bls-wasm
This package provides mnemonic and seed generation functionality using bip39
, but it is not bundled by default. If you plan to use mnemonic-related features, make sure to install this optional dependency:
npm install bip39
In order to compile the library, run the following:
npm install
npm run compile
npm run compile-browser
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.