@taquito/ledger-signer - npm Package Compare versions

Comparing version 11.2.0-beta-RC.0 to 11.2.0

dist/lib/version.js

@@ -6,5 +6,5 @@ "use strict";
 exports.VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+    "version": "11.2.0"
 };
 //# sourceMappingURL=version.js.map

dist/taquito-ledger-signer.es6.js

@@ -151,4 +151,4 @@ import { b58cencode, prefix, Prefix } from '@taquito/utils';
 const VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+    "version": "11.2.0"
 };
@@ -155,0 +155,0 @@

dist/taquito-ledger-signer.umd.js

@@ -158,4 +158,4 @@ (function (global, factory) {
     const VERSION = {
-        "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-        "version": "11.2.0-beta-RC.0"
+        "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+        "version": "11.2.0"
     };
@@ -162,0 +162,0 @@

package.json

 {
   "name": "@taquito/ledger-signer",
-  "version": "11.2.0-beta-RC.0",
+  "version": "11.2.0",
   "description": "Ledger signer provider",
@@ -61,4 +61,4 @@ "keywords": [
     "@ledgerhq/hw-transport": "^6.20.0",
-    "@taquito/taquito": "^11.2.0-beta-RC.0",
-    "@taquito/utils": "^11.2.0-beta-RC.0",
+    "@taquito/taquito": "^11.2.0",
+    "@taquito/utils": "^11.2.0",
     "buffer": "^6.0.3",
@@ -97,3 +97,3 @@ "libsodium-wrappers": "0.7.8"
   },
-  "gitHead": "7cc9152cdad01bacca4a1b682c7cb0a33a24f544"
+  "gitHead": "7323157124742e8f2fdb11642f6b779cfb15df43"
 }

README.md

 # Taquito Ledger Signer package
+*Documentation can be found [here](https://tezostaquito.io/docs/ledger_signer)*  
+*TypeDoc style documentation is available [here](https://tezostaquito.io/typedoc/modules/_taquito_ledger_signer.html)*
 
+## General Information
 `@taquito/ledger-signer` is an npm package that provides developers with ledger signing functionality for Taquito. It implements the Signer interface of Taquito, allowing you to sign operations from a Ledger Nano device.
 
-You first need to import the desired transport from the [LedgerJs library](https://github.com/LedgerHQ/ledgerjs). The Ledger Signer has currently been tested with `@ledgerhq/hw-transport-node-hid` for Node-based applications and with `@ledgerhq/hw-transport-u2f` for web applications.
-You can pass an instance of the transport of your choice to your Ledger Signer as follows:
+## Install
+Install the package as follows
+```
+npm install @taquito/ledger-signer
+```
 
+## Usage
+### Prerequisites
+To use the Ledger Signer we must first import the desired transport from the [LedgerJs library](https://github.com/LedgerHQ/ledgerjs).
+
+The Ledger Signer has currently been tested with `@ledgerhq/hw-transport-node-hid` for Node-based applications and with `@ledgerhq/hw-transport-webhi` for web applications.
+
+Pass an instance of the transport of your choice to the Ledger Signer as follows:
 ```ts
-import TransportU2F from '@ledgerhq/hw-transport-u2f';
+import transportWeb from '@ledgerhq/hw-transport-webhi';
 import { LedgerSigner } from '@taquito/ledger-signer';
 
-const transport = await TransportU2F.create();
+const transport = await transportWeb.create();
 const ledgerSigner = new LedgerSigner(transport);
 ```
 
-The constructor of the `LedgerSigner` class can take three other parameters. If none are specified, the default values are used.
+The constructor of the `LedgerSigner` class takes three other optional parameters. If none are specified, the following default values are used:
 
-- path: **default value is "44'/1729'/0'/0'"**  
-  You can use as a parameter the `HDPathTemplate` which refers to `44'/1729'/${account}'/0'`. You have to specify what is the index of the account you want to use. Or you can also use a complete path as a parameter.  
-  _More details about paths below_
-- prompt: **default is true**  
-  If true, you will be asked on your Ledger device to send your public key for validation. **_Note that confirmation is required when using `@ledgerhq/hw-transport-u2f`, so you should not set this parameter to false if you are using this transport._**
-- derivationType: **default is DerivationType.ED25519**  
+- `path`: **default value is "44'/1729'/0'/0'"**  
+  You can use as a parameter the `HDPathTemplate` which refers to `44'/1729'/${account}'/0'`. You have to specify the index of the account you want to use. Or you can also use a complete path as a parameter. More details about paths [here](https://tezostaquito.io/docs/ledger_signer#derivation-paths-hd-wallet--bip-standards)
+- `prompt`: **default is true**  
+  If true, you will be asked on your Ledger device to send your public key for validation. **_Note that confirmation is required when using `@ledgerhq/hw-transport-webhi`, so you should not set this parameter to false if you are using this transport._**
+- `derivationType`: **default is DerivationType.ED25519**  
   It can be DerivationType.ED25519 (tz1), DerivationType.SECP256K1 (tz2) or DerivationType.P256 (tz3).
@@ -37,7 +49,7 @@
 
-## Usage
+### Code Example
 
 ```ts
 import { LedgerSigner } from '@taquito/ledger-signer';
-import TransportNodeHid from '@ledgerhq/hw-transport-node-hid';
+import TransportWeb from '@ledgerhq/hw-transport-webhi';
 import { TezosToolkit } from '@taquito/taquito';
@@ -47,3 +59,3 @@
 
-const transport = await TransportNodeHid.create();
+const transport = await TransportWeb.create();
 const ledgerSigner = new LedgerSigner(transport);
@@ -58,10 +70,8 @@
 
+## Additional Info
 See the top-level [https://github.com/ecadlabs/taquito](https://github.com/ecadlabs/taquito) file for details on reporting issues, contributing and versioning.
 
-## API Documentation
 
-TypeDoc style documentation is available on-line [here](https://tezostaquito.io/typedoc/modules/_taquito_ledger_signer.html)
-
 ## Disclaimer
 
 THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

src/version.ts

 
 // IMPORTANT: THIS FILE IS AUTO GENERATED! DO NOT MANUALLY EDIT OR CHECKIN!
 export const VERSION = {
-    "commitHash": "e03d983c780c7f96d8291ddd1251ea82f4581858",
-    "version": "11.2.0-beta-RC.0"
+    "commitHash": "81f0a5b103f867f57fbe5d526315c375a3788346",
+    "version": "11.2.0"
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

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

Improved metrics

Total package byte prevSize

149533

increased by0.15%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

74

increased by15.63%

Dependency changes

• Updated@taquito/taquito@^11.2.0

• Updated@taquito/utils@^11.2.0