@ledgerhq/hw-app-cosmos
Version:
Ledger Hardware Wallet Cosmos Application API
70 lines (43 loc) • 2.41 kB
Markdown
<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-cosmos
Ledger Hardware Wallet Cosmos JavaScript bindings.
***
## Are you adding Ledger support to your software wallet?
You may be using this package to communicate with the Cosmos 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
* [Cosmos](#cosmos)
* [Parameters](#parameters)
* [Examples](#examples)
* [getAddress](#getaddress)
* [Parameters](#parameters-1)
* [Examples](#examples-1)
### Cosmos
Cosmos API
#### Parameters
* `transport` **Transport** 
* `scrambleKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** (optional, default `APP_KEY`)
#### Examples
```javascript
import Cosmos from "@ledgerhq/hw-app-cosmos";
const cosmos = new Cosmos(transport)
```
#### getAddress
get Cosmos 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
* `hrp` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** usually cosmos
* `boolDisplay` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?** 
##### Examples
```javascript
cosmos.getAddress("44'/60'/0'/0/0", "cosmos").then(o => o.address)
```
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 publicKey, address and (optionally) chainCode