@ledgerhq/hw-app-multiversx/README.md

Ledger Hardware Wallet MultiversX Application API

<img src="https://user-images.githubusercontent.com/4631227/191834116-59cf590e-25cc-4956-ae5c-812ea464f324.png" height="100" />

[GitHub](https://github.com/LedgerHQ/ledger-live/),
[Ledger Devs Discord](https://developers.ledger.com/discord-pro),
[Developer Portal](https://developers.ledger.com/)

## @ledgerhq/hw-app-multiversx

Ledger Hardware Wallet Multiversx JavaScript bindings.

***

## Are you adding Ledger support to your software wallet?

You may be using this package to communicate with the Multiversx Nano App.

For a smooth and quick integration:

*   See the developers’ documentation on the [Developer Portal](https://developers.ledger.com/docs/transport/overview/) and
*   Go on [Discord](https://developers.ledger.com/discord-pro/) to chat with developer support and the developer community.

***

## API

<!-- Generated by documentation.js. Update this documentation by updating the source code. -->

#### Table of Contents

*   [MultiversX](#multiversx)
    *   [Parameters](#parameters)
    *   [Examples](#examples)
    *   [getAppConfiguration](#getappconfiguration)
        *   [Examples](#examples-1)
    *   [getAddress](#getaddress)
        *   [Parameters](#parameters-1)
        *   [Examples](#examples-2)
    *   [setAddress](#setaddress)
        *   [Parameters](#parameters-2)
        *   [Examples](#examples-3)

### MultiversX

MultiversX API

#### Parameters

*   `transport` **Transport**&#x20;
*   `scrambleKey`   (optional, default `"eGLD"`)

#### Examples

```javascript
import MultiversX from "@ledgerhq/hw-app-multiversx";
const multiversx = new MultiversX(transport)
```

#### getAppConfiguration

Get MultiversX app configuration.

##### Examples

```javascript
const result = await multiversx.getAppConfiguration();
const { contractData, accountIndex, addressIndex, version } = result;
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<any>** an object with a contractData, accountIndex, addressIndex, version

#### getAddress

Get MultiversX address for a given BIP 32 path.

##### Parameters

*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP 32 format
*   `boolDisplay` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the display

##### Examples

```javascript
const result = await multiversx.getAddress("44'/508'/0'/0'/0'");
const { publicKey, address } = result;
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{publicKey: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), address: [string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)}>** an object with a address

#### setAddress

Set MultiversX address for a given BIP 32 path.

##### Parameters

*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a path in BIP 32 format
*   `display` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** optionally enable or not the display

##### Examples

```javascript
const result = await multiversx.setAddress("44'/508'/0'/0/0");
result : Buffer;
```

Returns **any** an object with a address