View @ledgerhq/hw-app-str on Snyk Open Source Advisor

Package Health Score

87 / 100

security
No known security issues
popularity
Small
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
7.0.4	\|	09/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.29.0	\|	06/2024		0 C 0 H 0 M 0 L	0 H 0 M 0 L
6.28.3	\|	01/2024	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
5.51.1	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
4.78.0	\|	11/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Small

Weekly Downloads (1,217)

GitHub Stars: 440
Forks: 333
Contributors: 290

Direct Usage Popularity

The npm package @ledgerhq/hw-app-str receives a total of 1,217 downloads a week. As such, we scored @ledgerhq/hw-app-str popularity level to be Small.

Based on project statistics from the GitHub repository for the npm package @ledgerhq/hw-app-str, we found that it has been starred 440 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 290
Funding: No

A good and healthy external contribution signal for @ledgerhq/hw-app-str project, which invites more than one hundred open source maintainers to collaborate on the repository.

We found a way for you to contribute to the project! Looks like @ledgerhq/hw-app-str is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 18
Open PR: 49
Last Release: 2 months ago
Last Commit: 4 days ago

Further analysis of the maintenance status of @ledgerhq/hw-app-str based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @ledgerhq/hw-app-str demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 7 years
Dependencies: 3 Direct
Versions: 340
Install Size: 110 kB
Dist-tags: 29
# of Files: 27
Maintainers: 8
TS Typings: No

@ledgerhq/hw-app-str has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Not sure how to use @ledgerhq/hw-app-str?

To help you get started, we've collected the most common ways that @ledgerhq/hw-app-str is being used within popular public projects.

stellarchat / desktop-client / src / main / hardwareWalletLedger.js View on Github

async _watchdogCallback() {
      console.log(`Hardwallet&lt;${this.uid}&gt; Watchdog: state='${this.state}' busy='${this.busy}'`)
      if(!this.transport) {
        try {
          const transport = await Transport.open(this.descriptor);
          const str = new Str(transport);
          this.transport = transport;
          this.str = str;
          console.info(`Hardwallet&lt;${this.uid}&gt;: Transport open.`)
        } catch(e) {
          console.warn(`Hardwallet&lt;${this.uid}&gt; Watchdog: recovering from error... (${e.message})`)
          return;  // Skip the rest try again later.
        }
      }

      let newState;
      try {

        if(this.subaccount) {
          if(!this.publicKey &amp;&amp; !this.busy) await this.selectSubaccount(this.subaccount)
          if(!this.busy) await this.ping();
          newState = HWW_STATE.READY;

View more ways to use @ledgerhq/hw-app-str

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

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 =&gt; 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 =&gt; 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

path string a path in BIP 32 format
transaction Buffer signature base of the transaction to sign

Examples

str.signTransaction("44'/148'/0'", signatureBase).then(o =&gt; o.signature)

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

signSorobanAuthorization

Sign a Stellar Soroban authorization.

Parameters

path string a path in BIP 32 format
hashIdPreimage Buffer the Soroban authorization hashIdPreimage to sign

Examples

str.signSorobanAuthorization("44'/148'/0'", hashIdPreimage).then(o =&gt; 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 =&gt; o.signature)

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

@ledgerhq/hw-app-str dependencies

bip32-path @ledgerhq/hw-transport @ledgerhq/errors

@ledgerhq/hw-app-str development dependencies

@types/jest @types/node documentation jest rimraf source-map-support ts-jest ts-node @ledgerhq/hw-transport-mocker

FAQs

What is @ledgerhq/hw-app-str?

Ledger Hardware Wallet Stellar Application API. Visit Snyk Advisor to see a full health score report for @ledgerhq/hw-app-str, including popularity, security, maintenance & community analysis.

Is @ledgerhq/hw-app-str popular?

The npm package @ledgerhq/hw-app-str receives a total of 1,217 weekly downloads. As such, @ledgerhq/hw-app-str popularity was classified as small. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @ledgerhq/hw-app-str well maintained?

We found that @ledgerhq/hw-app-str demonstrated a healthy version release cadence and project activity. It has a community of 290 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @ledgerhq/hw-app-str safe to use?

The npm package @ledgerhq/hw-app-str was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 19 November-2024, at 04:05 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (1,217)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Not sure how to use @ledgerhq/hw-app-str?

@ledgerhq/hw-app-str

Are you adding Ledger support to your software wallet?

Errors handling

API

Table of Contents

StellarHashSigningNotEnabledError

StellarDataParsingFailedError

StellarUserRefusedError

StellarDataTooLargeError

Str

Parameters

Examples

getAppConfiguration

Examples

getPublicKey

Parameters

Examples

signTransaction

Parameters

Examples

signSorobanAuthorization

Parameters

Examples

signHash

Parameters

Examples

@ledgerhq/hw-app-str dependencies

@ledgerhq/hw-app-str development dependencies

FAQs

What is @ledgerhq/hw-app-str?

Is @ledgerhq/hw-app-str popular?

Is @ledgerhq/hw-app-str well maintained?

Is @ledgerhq/hw-app-str safe to use?

Build a secure application checklist

Select a recommended open source package

Scan your app for vulnerabilities

Source Code

Open Source

Container

Config

Fix identified vulnerabilities

Monitor for new issues