@ledgerhq/hw-app-tezos
Version:
Ledger Hardware Wallet Tezos Application API
69 lines (42 loc) • 2.12 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-tezos
Ledger Hardware Wallet Tezos JavaScript bindings.
***
## Are you adding Ledger support to your software wallet?
You may be using this package to communicate with the Tezos 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
* [Tezos](#tezos)
* [Parameters](#parameters)
* [Examples](#examples)
* [getAddress](#getaddress)
* [Parameters](#parameters-1)
* [Examples](#examples-1)
### Tezos
Tezos API
#### Parameters
* `transport` **Transport** 
#### Examples
```javascript
import Tezos from "@ledgerhq/hw-app-tezos";
const tez = new Tezos(transport)
```
#### getAddress
get Tezos 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, must begin with 44'/1729'
* `options` **{verify: [boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)?, curve: Curve?, ins: [number](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Number)?}** (optional, default `{}`)
##### Examples
```javascript
tez.getAddress("44'/1729'/0'/0'").then(o => o.address)
tez.getAddress("44'/1729'/0'/0'", { verify: true })
```
Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<GetAddressResult>** an object with address, publicKey