npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@ledgerhq/hw-app-str

v7.0.4

Published

Ledger Hardware Wallet Stellar Application API

Downloads

5,438

Readme

GitHub, Ledger Devs Discord, Developer Portal

@ledgerhq/hw-app-str

Ledger Hardware Wallet Stellar JavaScript bindings.


Are you adding Ledger support to your software wallet?

You may be using this package to communicate with the Stellar 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.

Errors handling

All functions may throw an error, it's important to handle the errors properly.

We have written corresponding classes for exceptions that developers should actively handle, you can find them in the API section.


API

Table of Contents

StellarHashSigningNotEnabledError

Error thrown when hash signing is not enabled on the device.

StellarDataParsingFailedError

Error thrown when data parsing fails.

For example, when parsing the transaction fails, this error is thrown.

StellarUserRefusedError

Error thrown when the user refuses the request on the device.

StellarDataTooLargeError

Error thrown when the data is too large to be processed by the device.

Str

Stellar API

Parameters

  • transport Transport a transport for sending commands to a device
  • scrambleKey a scramble key (optional, default "l0v")

Examples

import Str from "@ledgerhq/hw-app-str";
const str = new Str(transport)

getAppConfiguration

Get Stellar application configuration.

Examples
str.getAppConfiguration().then(o => o.version)

Returns Promise<{version: string, hashSigningEnabled: boolean, maxDataSize: number?}> an object with the application configuration, including the version, whether hash signing is enabled, and the maximum data size in bytes that the device can sign.

getPublicKey

Get Stellar raw public key for a given BIP 32 path.

Parameters
  • path string a path in BIP 32 format
  • display if true, the device will ask the user to confirm the address on the device, if false, it will return the raw public key directly (optional, default false)
Examples
str.getPublicKey("44'/148'/0'").then(o => o.rawPublicKey)

Returns Promise<{rawPublicKey: Buffer}> an object with the raw ed25519 public key. If you want to convert it to string, you can use StrKey.encodeEd25519PublicKey

signTransaction

Sign a Stellar transaction.

Parameters
Examples
str.signTransaction("44'/148'/0'", signatureBase).then(o => o.signature)

Returns Promise<{signature: Buffer}> an object with the signature

signSorobanAuthorization

Sign a Stellar Soroban authorization.

Parameters
Examples
str.signSorobanAuthorization("44'/148'/0'", hashIdPreimage).then(o => o.signature)

Returns Promise<{signature: Buffer}> an object with the signature

signHash

Sign a hash.

Parameters
  • path string a path in BIP 32 format
  • hash Buffer the hash to sign
Examples
str.signHash("44'/148'/0'", hash).then(o => o.signature)

Returns Promise<{signature: Buffer}> an object with the signature