@ledgerhq/hw-transport-webauthn - npm Package Compare versions

Comparing version 5.34.0 to 5.36.0-deprecated

package.json

 {
   "name": "@ledgerhq/hw-transport-webauthn",
-  "version": "5.34.0",
+  "version": "5.36.0-deprecated",
   "description": "Ledger Hardware Wallet Web implementation of the communication layer, using WebAuthN api",
@@ -46,3 +46,3 @@ "keywords": [
   },
-  "gitHead": "b6a7aca784dd61818d43b6198143176507ef412b"
+  "gitHead": "6d655aa89b748e50ae15c0cfb30c08f2215f6d84"
 }

README.md

@@ -1,68 +0,4 @@
-<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/)
+`@ledgerhq/hw-transport-u2f` is deprecated. Please use [`@ledgerhq/hw-transport-webusb`](https://github.com/LedgerHQ/ledgerjs) or [`@ledgerhq/hw-transport-webhid`](https://github.com/LedgerHQ/ledgerjs).
 
-## @ledgerhq/hw-transport-webauthn
-
-Allows to communicate with Ledger Hardware Wallets.
-
-**[Web]** **(WebAuthn)** – WebAuthn api. [check browser support](https://caniuse.com/webauthn).
-
-### Known limitation
-
-There is a "blink" at each time there is a communication with the device due to WebAuthn. WebAuthn is meant for authentification and we use it for communication, ideally prefer WebUSB.
-
-## API
-
-<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
-
-#### Table of Contents
-
--   [TransportWebAuthn](#transportwebauthn)
-    -   [Examples](#examples)
-    -   [exchange](#exchange)
-        -   [Parameters](#parameters)
-    -   [setScrambleKey](#setscramblekey)
-        -   [Parameters](#parameters-1)
-        -   [Examples](#examples-1)
-
-### TransportWebAuthn
-
-**Extends Transport**
-
-WebAuthn Transport implementation
-
-#### Examples
-
-```javascript
-import TransportWebAuthn from "@ledgerhq/hw-transport-webauthn";
-...
-TransportWebAuthn.create().then(transport => ...)
-```
-
-#### exchange
-
-Exchange with the device using APDU protocol.
-
-##### Parameters
-
--   `apdu` **[Buffer](https://nodejs.org/api/buffer.html)** 
-
-Returns **[Promise](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)&lt;[Buffer](https://nodejs.org/api/buffer.html)>** a promise of apdu response
-
-#### setScrambleKey
-
-A scramble key is a string that xor the data exchanged.
-It depends on the device app you need to exchange with.
-For instance it can be "BTC" for the bitcoin app, "B0L0S" for the dashboard.
-
-##### Parameters
-
--   `scrambleKey` **[string](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** 
-
-##### Examples
-
-```javascript
-transport.setScrambleKey("B0L0S")
-```
+More information: https://github.com/LedgerHQ/ledgerjs/blob/master/docs/migrate_webusb.md

New alerts

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Number of high maintenance alerts

0

decreased by-100%

Worsened metrics

Total package byte prevSize

37936

decreased by-4.24%

Number of low quality alerts

1

increased byInfinity%

Number of lines in readme file

4

decreased by-94.2%

No dependency changes