hw-app-nano 1.3.0 | Documentation

STATUS_CODES

An enum containing the common status codes returned via the TransportStatusError#statusCode field.

STATUS_CODES

Example

nano.getAddress("44'/165'/0'", true).then(o => {
  // ...
}, err => {
  if (err.statusCode == STATUS_CODES.CONDITIONS_OF_USE_NOT_SATISFIED) {
    console.log('User cancelled the request');
  }
  // ..
});

Static Members

▸ SECURITY_STATUS_NOT_SATISFIED

src/api.js

Security status not satisfied is returned when the device is still locked

SECURITY_STATUS_NOT_SATISFIED

▸ CONDITIONS_OF_USE_NOT_SATISFIED

src/api.js

Conditions of use not satisfied is returned when the user declines the request to complete the action.

CONDITIONS_OF_USE_NOT_SATISFIED

▸ INVALID_SIGNATURE

src/api.js

Failed to verify the provided signature.

INVALID_SIGNATURE

▸ CACHE_MISS

src/api.js

Parent block data was not found in cache.

CACHE_MISS

BlockData

src/api.js

Union type of all of the valid block data configurations.

BlockData

Type: (OpenBlockData | ReceiveBlockData | SendBlockData | ChangeBlockData)

Properties

previousBlock (string?) : hash (in hex) of the previous block in the account chain

representative (string) : address of the representative (both nano and xrb addresses are supported)

balance (string) : new account balance after the transaction

sourceBlock (string?) : hash (in hex) of the block from which to receive the funds

recipient (string?) : address of the account to send Nano to (both nano and xrb addresses are supported)

Example

Open block data

let openBlockData = {
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
};

Receive block data

let receiveBlockData = {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
};

Send block data

let sendBlockData = {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  recipient: "nano_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k"
};

Change block data

let changeBlockData = {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000"
};

CoinConfig

src/api.js

Coin configuration object used to pass coin implementation details to all the common API functions that the coins share.

CoinConfig

Type: {coinName: string, addressPrimaryPrefix: string, addressSecondaryPrefix: string}

Properties

coinName (string)

addressPrimaryPrefix (string)

addressSecondaryPrefix (string)

BaseAPI

src/api.js

Base class for all Nano-family coin APIs to derive from.

new BaseAPI(transport: Transport<any>, coin: CoinConfig)

Parameters

transport (Transport<any>)

coin (CoinConfig)

Instance Members

▸ coin

src/api.js

The coin configuration object for the current coin.

coin

Type: CoinConfig

▸ getAppConfiguration()

src/api.js

Get Nano-family application configuration. The returned coinName should be verified to match that of inst.coin.coinName. If it doesn't, then the user has the wrong application open on their device and other API calls will fail.

getAppConfiguration(): Promise<{version: string, coinName: string}>

Returns

Promise<{version: string, coinName: string}>: an object with a version and the coin name

Example

inst.getAppConfiguration().then(c => {
  if (c.coinName != inst.coin.coinName) { throw new Error("Wrong coin app"); }
  return c.version;
})

encodeBalance

src/util.js

Encode the balance value (128bit big endian integer) as hex string

encodeBalance(value: string): string

Parameters

value (string) string representation of a base 10 number

Returns

string: a string that of hex encoded value of the value

Example

encodeBalance("14000000000000000000000000") == "00000000000B949D854F34FECE000000"

decodeBalance

src/util.js

Decode the balance value (128bit big endian integer) from hex string

decodeBalance(value: string): string

Parameters

value (string) hex encoded value

Returns

string: a string of the number in base 10

Example

decodeBalance("00000000000B949D854F34FECE000000") == "14000000000000000000000000"

Nano

src/Nano.js

Nano API (default export of this module)

new Nano(transport: Transport<any>)

Extends BaseAPI

Parameters

transport (Transport<any>)

Example

import Nano from "hw-app-nano";
const nano = new Nano(transport);

Instance Members

▸ getAddress(path, boolDisplay?)

src/Nano.js

Get Nano address for the given BIP 32 path.

getAddress(path: string, boolDisplay: boolean?): Promise<{publicKey: string, address: string}>

Parameters

path (string) a path in BIP 32 format

boolDisplay (boolean?)

Returns

Promise<{publicKey: string, address: string}>: an object with a publicKey and address

Example

nano.getAddress("44'/165'/0'").then(o => o.address)

▸ signBlock(path, blockData)

src/Nano.js

Generate a signature for a block

signBlock(path: string, blockData: BlockData): Promise<{blockHash: string, signature: string}>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data to hash and sign

Returns

Promise<{blockHash: string, signature: string}>

Example

Opening an account

nano.signBlock("44'/165'/0'", {
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
}).then(o => o.signature)

Sending funds

nano.signBlock("44'/165'/0'", {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  recipient: "nano_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k"
}).then(o => o.signature)

▸ cacheBlock(path, blockData, signature)

src/Nano.js

Cache block in Ledger device memory

cacheBlock(path: string, blockData: BlockData, signature: string): Promise<any>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data

signature (string) signature (in hex) of the block

Returns

Promise<any>

Example

nano.cacheBlock("44'/165'/0'", {
  representative: "xrb_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
});

Banano

src/Banano.js

Banano API

new Banano(transport: Transport<any>)

Extends BaseAPI

Parameters

transport (Transport<any>)

Example

import { Banano } from "hw-app-nano";
const ban = new Banano(transport);

Instance Members

▸ getAddress(path, boolDisplay?)

src/Banano.js

Get Banano address for the given BIP 32 path.

getAddress(path: string, boolDisplay: boolean?): Promise<{publicKey: string, address: string}>

Parameters

path (string) a path in BIP 32 format

boolDisplay (boolean?)

Returns

Promise<{publicKey: string, address: string}>: an object with a publicKey and address

Example

ban.getAddress("44'/198'/0'").then(o => o.address)

▸ signBlock(path, blockData)

src/Banano.js

Generate a signature for a block

signBlock(path: string, blockData: BlockData): Promise<{blockHash: string, signature: string}>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data to hash and sign

Returns

Promise<{blockHash: string, signature: string}>

Example

Opening an account

ban.signBlock("44'/198'/0'", {
  representative: "ban_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
}).then(o => o.signature)

Sending funds

ban.signBlock("44'/198'/0'", {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "ban_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  recipient: "ban_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k"
}).then(o => o.signature)

▸ cacheBlock(path, blockData, signature)

src/Banano.js

Cache block in Ledger device memory

cacheBlock(path: string, blockData: BlockData, signature: string): Promise<any>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data

signature (string) signature (in hex) of the block

Returns

Promise<any>

Example

ban.cacheBlock("44'/198'/0'", {
  representative: "ban_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
});

NOS

src/NOS.js

NOS API

new NOS(transport: Transport<any>)

Extends BaseAPI

Parameters

transport (Transport<any>)

Example

import { NOS } from "hw-app-nano";
const nos = new NOS(transport);

Instance Members

▸ getAddress(path, boolDisplay?)

src/NOS.js

Get NOS address for the given BIP 32 path.

getAddress(path: string, boolDisplay: boolean?): Promise<{publicKey: string, address: string}>

Parameters

path (string) a path in BIP 32 format

boolDisplay (boolean?)

Returns

Promise<{publicKey: string, address: string}>: an object with a publicKey and address

Example

nos.getAddress("44'/229'/0'/0'").then(o => o.address)

▸ signBlock(path, blockData)

src/NOS.js

Generate a signature for a block

signBlock(path: string, blockData: BlockData): Promise<{blockHash: string, signature: string}>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data to hash and sign

Returns

Promise<{blockHash: string, signature: string}>

Example

Opening an account

nos.signBlock("44'/229'/0'/0'", {
  representative: "nos_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
}).then(o => o.signature)

Sending funds

nos.signBlock("44'/229'/0'/0'", {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "nos_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  recipient: "nos_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k"
}).then(o => o.signature)

▸ cacheBlock(path, blockData, signature)

src/NOS.js

Cache block in Ledger device memory

cacheBlock(path: string, blockData: BlockData, signature: string): Promise<any>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data

signature (string) signature (in hex) of the block

Returns

Promise<any>

Example

nos.cacheBlock("44'/229'/0'/0'", {
  representative: "nos_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
});

NOLLAR

src/NOLLAR.js

NOLLAR API

new NOLLAR(transport: Transport<any>)

Extends BaseAPI

Parameters

transport (Transport<any>)

Example

import { NOLLAR } from "hw-app-nano";
const nollar = new NOLLAR(transport);

Instance Members

▸ getAddress(path, boolDisplay?)

src/NOLLAR.js

Get NOLLAR address for the given BIP 32 path.

getAddress(path: string, boolDisplay: boolean?): Promise<{publicKey: string, address: string}>

Parameters

path (string) a path in BIP 32 format

boolDisplay (boolean?)

Returns

Promise<{publicKey: string, address: string}>: an object with a publicKey and address

Example

nollar.getAddress("44'/229'/840'/0'").then(o => o.address)

▸ signBlock(path, blockData)

src/NOLLAR.js

Generate a signature for a block

signBlock(path: string, blockData: BlockData): Promise<{blockHash: string, signature: string}>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data to hash and sign

Returns

Promise<{blockHash: string, signature: string}>

Example

Opening an account

nollar.signBlock("44'/229'/840'/0'", {
  representative: "usd_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
}).then(o => o.signature)

Sending funds

nollar.signBlock("44'/229'/840'/0'", {
  previousBlock: "991CF190094C00F0B68E2E5F75F6BEE95A2E0BD93CEAA4A6734DB9F19B728948",
  representative: "usd_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  recipient: "usd_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k"
}).then(o => o.signature)

▸ cacheBlock(path, blockData, signature)

src/NOLLAR.js

Cache block in Ledger device memory

cacheBlock(path: string, blockData: BlockData, signature: string): Promise<any>

Parameters

path (string) a path of the account in BIP 32 format

blockData (BlockData) block data

signature (string) signature (in hex) of the block

Returns

Promise<any>

Example

nollar.cacheBlock("44'/229'/840'/0'", {
  representative: "usd_3hd4ezdgsp15iemx7h81in7xz5tpxi43b6b41zn3qmwiuypankocw3awes5k",
  balance: "100000000000000000000000000000000",
  sourceBlock: "06B95C8A7EC4116E5BD907CD6DC65D310E065992A2E1D02F337D1A8308DEBC14"
});