open-index/open-npm huggingface dataset:
npm package: @multiversx/sdk-core
Description: MultiversX SDK for JavaScript and TypeScript
Author: MultiversX
Latest version: 15.4.0

# MultiversX SDK for JavaScript and TypeScript

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

## Documentation

- [Cookbook](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-cookbook/)
- [Auto-generated documentation](https://multiversx.github.io/mx-sdk-js-core/)

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-core)

## 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` 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
```

## Optional Dependencies

### axios

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`:

```bash
npm install axios
```

### @multiversx/sdk-bls-wasm

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:

```bash
npm install @multiversx/sdk-bls-wasm
```

### bip39

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:

```bash
npm install bip39
```

### 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](https://docs.multiversx.com/developers/setup-local-testnet/).
npm package: @multiversx/sdk-exchange
Description: Utilities modules for xExchange interactions
Author: MultiversX
Latest version: 0.2.24

# MultiversX SDK for JavaScript and TypeScript: xExchange utilities

Utilities modules for xExchange interactions

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-exchange)

## Installation

`sdk-exchange` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-exchange), therefore it can be installed as follows:

```
npm install @multiversx/sdk-exchange
```

### Building the library

In order to compile the library, run the following:

```
npm install
npm run compile
```
npm package: @multiversx/sdk-extension-provider
Description: Signing provider for dApps: DeFi Wallet
Author: MultiversX
Latest version: 5.1.2

# mx-sdk-js-extension-provider

Signing provider for dApps: Maiar DeFi Wallet. 

Documentation is available on [docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/erdjs/erdjs-signing-providers/), while an integration example can be found [here](https://github.com/multiversx/mx-sdk-js-examples/tree/main/signing-providers).

Note that **we recommend using [dapp-core](https://github.com/multiversx/mx-sdk-dapp)** instead of integrating the signing provider on your own.

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-extension-provider)

## Installation

`sdk-extension-provider` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-extension-provider), therefore it can be installed as follows:

```
npm install @multiversx/sdk-extension-provider
```

### Building the library

In order to compile the library, run the following:

```
npm install
npm run compile
```
npm package: @multiversx/sdk-hw-provider
Description: Signing provider for dApps: hardware wallet (Ledger)
Author: MultiversX
Latest version: 8.1.2

# mx-sdk-js-hw-provider

Signing provider for dApps: hardware wallet (Ledger).

Documentation is available on [docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/erdjs/erdjs-signing-providers/), while an integration example can be found [here](https://github.com/multiversx/mx-sdk-js-examples/tree/main/signing-providers).

Note that **we recommend using [dapp-core](https://github.com/multiversx/mx-sdk-dapp)** instead of integrating the signing provider on your own.

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-hw-provider)

## Installation

`sdk-hw-provider` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-hw-provider), therefore it can be installed as follows:

```
npm install @multiversx/sdk-hw-provider
```

### Building the library

In order to compile `sdk-hw-provider`, run the following:

```
npm install
npm run compile
```
npm package: @multiversx/sdk-network-providers
Description: Network Provider (API, Gateway) components (compatible with @multiversx/sdk-core)
Author: MultiversX
Latest version: 2.9.3
Deprecated: The functionality has been integrated into @multiversx/sdk-core, thus this package is no longer supported.

# This package was integrated into [sdk-core](https://www.npmjs.com/package/@multiversx/sdk-core) and will soon be deprecated
To utilize the functionality from the unified @multiversx/sdk-core library, please update the existing import statements within your project.

For example:
``` 
import { ProxyNetworkProvider } from "@multiversx/sdk-network-providers";
```
should be changed to:
```
import { ProxyNetworkProvider } from "@multiversx/sdk-core";
```
npm package: @multiversx/sdk-transaction-decoder
Description: Transaction metadata decoder
Author: MultiversX
Latest version: 2.0.0

# Transaction Decoder for JavaScript

Transaction processor for JavaScript and TypeScript (written in TypeScript).

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/transaction-decoder)

## Usage

```js
const metadata = new TransactionDecoder().getTransactionMetadata({
  sender: 'erd18w6yj09l9jwlpj5cjqq9eccfgulkympv7d4rj6vq4u49j8fpwzwsvx7e85',
  receiver: 'erd18w6yj09l9jwlpj5cjqq9eccfgulkympv7d4rj6vq4u49j8fpwzwsvx7e85',
  data: 'RVNEVE5GVFRyYW5zZmVyQDRjNGI0ZDQ1NTgyZDYxNjE2MjM5MzEzMEAyZmI0ZTlAZTQwZjE2OTk3MTY1NWU2YmIwNGNAMDAwMDAwMDAwMDAwMDAwMDA1MDBkZjNiZWJlMWFmYTEwYzQwOTI1ZTgzM2MxNGE0NjBlMTBhODQ5ZjUwYTQ2OEA3Mzc3NjE3MDVmNmM2YjZkNjU3ODVmNzQ2ZjVmNjU2NzZjNjRAMGIzNzdmMjYxYzNjNzE5MUA=',
  value: '0',
});
```
npm package: @multiversx/sdk-wallet
Description: Wallet components for MultiversX
Author: MultiversX
Latest version: 4.6.0
Deprecated: The functionality has been integrated into @multiversx/sdk-core, thus this package is no longer supported.

# MultiversX SDK for JavaScript and TypeScript: wallet components

Wallet components (generation, signing) for TypeScript (JavaScript).

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-wallet)

## Installation

`sdk-wallet` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-wallet), therefore it can be installed as follows:

```
npm install @multiversx/sdk-wallet
```

## Development

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

### Additional dependencies

Instanbul, for code coverage:

```
npm install --no-save nyc
```

### Building the library

In order to compile `sdk-wallet`, run the following:

```
npm install
npm run compile
npm run compile-browser
```

### Running the tests

#### On NodeJS

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

```
npm run test
```

#### In the browser

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

```
npm run browser-tests
```
npm package: @multiversx/sdk-wallet-cli
Description: Light CLI wrapper over the wallet components
Author: MultiversX
Latest version: 2.1.0
Deprecated: Package no longer supported. Contact Support at https://www.npmjs.com/support for more info.

# mx-sdk-js-wallet-cli

## Overview

**sdk-wallet-cli** is a light CLI wrapper over [@multiversx/sdk-wallet](https://www.npmjs.com/package/@multiversx/sdk-wallet) and allows one to generate mnemonics, derive key files and sign MultiversX transactions.
It exposes the following **commands**, via the `mxjs-wallet` alias:


```
$ mxjs-wallet --help
Usage: mxjs-wallet [options] [command]

Options:
  -V, --version           output the version number
  -h, --help              display help for command

Commands:
  new-mnemonic [options]  Create a new mnemonic phrase (24 words)
  derive-key [options]    Derive a JSON key-file from an existing mnemonic
                          phrase
  sign [options]          Sign a JSON transaction
  help [command]          display help for command

```
### New Mnemonic


```
$ mxjs-wallet new-mnemonic --help
Usage: mxjs-wallet new-mnemonic [options]

Create a new mnemonic phrase (24 words)

Options:
  -m, --mnemonic-file <mnemonicFile>  where to save the mnemonic
  -h, --help                          display help for command

```


### Derive Key File


```
$ mxjs-wallet derive-key --help
Usage: mxjs-wallet derive-key [options]

Derive a JSON key-file from an existing mnemonic phrase

Options:
  -m, --mnemonic-file <mnemonicFile>  a file containing the mnemonic
  -n, --account-index <accountIndex>  the account index to derive (default:
                                      "0")
  -k, --key-file <keyFile>            the key-file to create
  -p, --password-file <passwordFile>  a file containing the password for the
                                      key-file
  -h, --help                          display help for command

```


### Sign


```
$ mxjs-wallet sign --help
Usage: mxjs-wallet sign [options]

Sign a JSON transaction

Options:
  -i, --in-file <inFile>              the file containing the JSON transaction
  -o, --out-file <outFile>            where to save the signed JSON transaction
  -k, --key-file <keyFile>            the key-file (the wallet)
  -p, --password-file <passwordFile>  the file containing the key-file password
  -h, --help                          display help for command

```
npm package: @multiversx/sdk-web-wallet-cross-window-provider
Description: Signing provider for dApps: Cross Window
Author: MultiversX
Latest version: 3.2.2

# mx-sdk-js-web-wallet-cross-window-provider

Signing provider for dApps: Web Wallet Cross Window Provider. 

This package is part of the MultiversX SDK, which is a set of tools and libraries that allow developers to build decentralized applications (dApps) on the MultiversX blockchain.
By using this package, developers can integrate the MultiversX Web Wallet into their dApps, allowing users to sign transactions and messages with their MultiversX account.
The connection between the dApp and the Web Wallet is established through a cross-window communication channel, which is managed by the Web Wallet Cross Window Provider.

Documentation is available on [docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-signing-providers/#the-web-wallet-cross-window-provider), while an integration example can be found [here](https://github.com/multiversx/mx-sdk-js-examples/tree/main/signing-providers).

Note that **we recommend using [sdk-dapp](https://github.com/multiversx/mx-sdk-dapp)** instead of integrating the signing provider on your own.

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/sdk-web-wallet-cross-window-provider)

## Installation

`sdk-web-wallet-cross-window-provider` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-web-wallet-cross-window-provider), therefore it can be installed as follows:

```
npm install @multiversx/sdk-web-wallet-cross-window-provider
```

### Building the library

In order to compile the library, run the following:

```
npm install
npm run compile
```
npm package: @multiversx/sdk-web-wallet-iframe-provider
Description: Signing provider for dApps: Web Wallet Iframe Provider
Author: MultiversX
Latest version: 4.0.1

# mx-sdk-js-web-wallet-iframe-provider

Signing provider for dApps: Web Wallet Iframe Provider.

Documentation is available on [docs.multiversx.com](https://docs.multiversx.com/sdk-and-tools/sdk-js/sdk-js-signing-providers), while an integration example can be found [here](https://github.com/multiversx/mx-sdk-js-examples/tree/main/signing-providers).

Note that **we recommend using [sdk-dapp](https://github.com/multiversx/mx-sdk-dapp)** instead of integrating the signing provider on your own.

## Distribution

[npm](https://www.npmjs.com/package/@multiversx/mx-sdk-js-web-wallet-iframe-provider)

## Installation

`sdk-web-wallet-iframe-provider` is delivered via [npm](https://www.npmjs.com/package/@multiversx/sdk-web-wallet-iframe-provider), therefore it can be installed as follows:

```
npm install @multiversx/sdk-web-wallet-iframe-provider
```

### Building the library

In order to compile the library, run the following:

```
pnpm install
pnpm run compile
```