# @pontem/hw-app-aptos

> Ledger Hardware Wallet Aptos Application API

Latest version **0.0.1** (published 2023-04-12) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @pontem/hw-app-aptos
pnpm add @pontem/hw-app-aptos
yarn add @pontem/hw-app-aptos
bun add @pontem/hw-app-aptos
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2023-04-12 |
| First published | 2023-04-12 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 27.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | vldmkr |
| Maintainers | evtif, lusd, rspiridonov, buuni, pontem_network |

## Links

- npm: https://www.npmjs.com/package/@pontem/hw-app-aptos
- Repository: https://github.com/pontem-network/hw-app-aptos
- Homepage: https://github.com/pontem-network/hw-app-aptos#readme
- Issues: https://github.com/pontem-network/hw-app-aptos/issues
- npm.io page: https://npm.io/package/@pontem/hw-app-aptos

## Dependencies (5)

- [bip32-path](https://npm.io/package/bip32-path.md) ^0.4.2
- [@noble/hashes](https://npm.io/package/@noble/hashes.md) ^1.1.2
- [@ledgerhq/errors](https://npm.io/package/@ledgerhq/errors.md) ^6.10.2
- [@ledgerhq/hw-transport](https://npm.io/package/@ledgerhq/hw-transport.md) ^6.27.4
- [@ledgerhq/hw-transport-node-hid](https://npm.io/package/@ledgerhq/hw-transport-node-hid.md) ^6.27.4

## Recent versions

- 0.0.1 (latest) — 2023-04-12

## README

## Aptos Hardware Wallet Example 

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

#### Table of Contents

*   [Aptos](#aptos)
    *   [Parameters](#parameters)
    *   [Examples](#examples)
    *   [getVersion](#getversion)
        *   [Examples](#examples-1)
    *   [getAddress](#getaddress)
        *   [Parameters](#parameters-1)
        *   [Examples](#examples-2)
    *   [signTransaction](#signtransaction)
        *   [Parameters](#parameters-2)
        *   [Examples](#examples-3)

#### Parameters

*   `transport` **Transport** a transport for sending commands to a device
*   `scrambleKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a scramble key (optional, default `"aptos"`)

#### Examples

```javascript
import Aptos from "hw-app-aptos";
const aptos = new Aptos(transport);
```

#### getVersion

Get application version.

##### Examples

```javascript
aptos.getVersion().then(r => r.version)
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<AppConfig>** an object with the version field

#### getAddress

Get Aptos address (public key) for a BIP32 path.

Because Aptos uses Ed25519 keypairs, as per SLIP-0010
all derivation-path indexes will be promoted to hardened indexes.

##### Parameters

*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a BIP32 path
*   `display` **[boolean](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** flag to show display (optional, default `false`)

##### Examples

```javascript
aptos.getAddress("m/44'/637'/1'/0'/0'").then(r => r.address)
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<AddressData>** an object with publicKey, chainCode, address fields

#### signTransaction

Sign an Aptos transaction.

##### Parameters

*   `path` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** a BIP32 path
*   `txBuffer` **[Buffer](https://nodejs.org/api/buffer.html)** serialized transaction

##### Examples

```javascript
aptos.signTransaction("m/44'/637'/1'/0'/0'", txBuffer).then(r => r.signature)
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)<{signature: [Buffer](https://nodejs.org/api/buffer.html)}>** an object with the signature field

---
_Source: https://npm.io/package/@pontem/hw-app-aptos · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._