GitHub, Ledger Devs Discord, Developer Portal

@ledgerhq/hw-app-sui

Ledger Hardware Wallet Sui JavaScript bindings.

Are you adding Ledger support to your software wallet?

You may be using this package to communicate with the Sui Nano App.

For a smooth and quick integration:

• See the developers’ documentation on the Developer Portal and
• Go on Discord to chat with developer support and the developer community.

Dependecies

This package extends @mysten/ledgerjs-hw-app-sui

API

Table of Contents

• Sui
  • Parameters
  • Examples
  • getPublicKey
    • Parameters
  • signTransaction
    • Parameters
  • getVersion
• checkAppVersion
  • Parameters
• provideTrustedDynamicDescriptor
  • Parameters
• sendChunks
  • Parameters

Sui

Sui API

Parameters

• transport Transport
• scrambleKey (optional, default "default_sui_scramble_key")
• verbose (optional, default false)

Examples

import Sui from "@mysten/ledgerjs-hw-app-sui";
const sui = new Sui(transport)

getPublicKey

Retrieves the public key associated with a particular BIP32 path from the Ledger app.

Parameters

• path string the path to retrieve.
• displayOnDevice whether or not the address should be displayed on the device. (optional, default false)

Returns Promise<GetPublicKeyResult>

signTransaction

Sign a transaction with the key at a BIP32 path.

Parameters

• path string The path to use when signing the transaction.
• txn Uint8Array The transaction bytes to sign.
• options {bcsObjects: Array<Uint8Array>}? Additional options used for clear signing purposes.
• resolution Resolution? Additional data for token clear signing purposes.

Returns Promise<SignTransactionResult>

getVersion

Retrieve the app version on the attached Ledger device.

Returns Promise<GetVersionResult>

checkAppVersion

Retrieve the app version on the attached Ledger device.

Parameters

• minVersion string

• $1 {throwOnOutdated: boolean}

  • $1.throwOnOutdated

provideTrustedDynamicDescriptor

Provides trusted dynamic and signed coin metadata

Parameters

• data DescriptorInput An object containing the descriptor and its signature from the CAL

Returns Promise<boolean>

sendChunks

Convert a raw payload into what is essentially a singly-linked list of chunks, which allows the ledger to re-seek the data in a secure fashion.

Parameters

• cla number
• ins number
• p1 number
• p2 number
• payload (Buffer | Array<Buffer>)
• extraData Map<string, Buffer> (optional, default new Map<string,Buffer>())

Returns Promise<Buffer>