# @blooo/hw-app-velas

> Ledger Hardware Wallet Velas Application API

Latest version **1.0.1** (published 2022-03-25) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install @blooo/hw-app-velas
pnpm add @blooo/hw-app-velas
yarn add @blooo/hw-app-velas
bun add @blooo/hw-app-velas
```

## Health

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

Positive: has types; esm support; no vulnerabilities.

Warnings: low downloads.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2022-03-25 |
| First published | 2022-03-25 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 4 |
| Unpacked size | 55.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | n4l5u0r |
| Keywords | Ledger, LedgerWallet, Velas, VLX, NanoS, Blue, Hardware Wallet |

## Links

- npm: https://www.npmjs.com/package/@blooo/hw-app-velas
- Repository: https://github.com/blooo-io/LedgerHQ-hw-app-velas
- Issues: https://github.com/blooo-io/LedgerHQ-hw-app-velas/issues
- npm.io page: https://npm.io/package/@blooo/hw-app-velas

## Dependencies (4)

- [bip32-path](https://npm.io/package/bip32-path.md) ^0.4.2
- [@ledgerhq/logs](https://npm.io/package/@ledgerhq/logs.md) ^6.10.0
- [@ledgerhq/errors](https://npm.io/package/@ledgerhq/errors.md) ^6.10.0
- [@ledgerhq/hw-transport](https://npm.io/package/@ledgerhq/hw-transport.md) ^6.24.1

## Alternatives

- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads
- [fa](https://npm.io/package/fa.md) — 185 weekly downloads

## Recent versions

- 1.0.1 (latest) — 2022-03-25
- 1.0.0 — 2022-03-25
- 6.27.0 — 2022-03-25

## README

<img src="https://user-images.githubusercontent.com/211411/34776833-6f1ef4da-f618-11e7-8b13-f0697901d6a8.png" height="100" />

[Github](https://github.com/LedgerHQ/ledgerjs/),
[Ledger Devs Slack](https://ledger-dev.slack.com/)

## @blooo/hw-app-velas

Ledger Hardware Wallet Velas JavaScript bindings.

## Notes

To run `speculos-smoke` test make sure [Speculos](https://github.com/LedgerHQ/speculos) running (apdu port 9999 and api rest endpoint <http://0.0.0.0:5000>) with [Velas app](https://github.com/LedgerHQ/app-velas) installed on it. Then run the command from root workspace:

```bash
$ yarn run ts-node packages/hw-app-velas/tests/speculos-smoke.ts
```

## Troubleshooting

If ledger returns error `6808` - enable blind signature in settings (not needed for unit testing).

## API

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

#### Table of Contents

- [@blooo/hw-app-velas](#blooohw-app-velas)
- [Notes](#notes)
- [Troubleshooting](#troubleshooting)
- [API](#api)
    - [Table of Contents](#table-of-contents)
  - [Velas](#velas)
    - [Parameters](#parameters)
    - [Examples](#examples)
    - [getAddress](#getaddress)
      - [Parameters](#parameters-1)
      - [Examples](#examples-1)
    - [signTransaction](#signtransaction)
      - [Parameters](#parameters-2)
      - [Examples](#examples-2)
    - [getAppConfiguration](#getappconfiguration)
      - [Examples](#examples-3)

### Velas

Velas API

#### 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 `"velas_default_scramble_key"`)

#### Examples

```javascript
import Velas from "@blooo/hw-app-velas";
const velas = new Velas(transport);
```

#### getAddress

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

Because Velas 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
velas.getAddress("44'/501'/0'").then(r => r.address)
```

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

#### signTransaction

Sign a Velas 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
velas.signTransaction("44'/501'/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

#### getAppConfiguration

Get application configuration.

##### Examples

```javascript
velas.getAppConfiguration().then(r => r.version)
```

Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<AppConfig>** application config object

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