@ledgerhq/hw-transport 6.27.1 → 6.27.2-next.0

package/.turbo/turbo-build.log

@@ -0,0 +1,5 @@
+@ledgerhq/hw-transport:build: cache hit, replaying output f5f576df6bdd32a8
+@ledgerhq/hw-transport:build: 
+@ledgerhq/hw-transport:build: > @ledgerhq/hw-transport@6.27.1 build /home/runner/work/ledger-live/ledger-live/libs/ledgerjs/packages/hw-transport
+@ledgerhq/hw-transport:build: > tsc && tsc -m ES6 --outDir lib-es
+@ledgerhq/hw-transport:build: 

package/CHANGELOG.md

@@ -0,0 +1,9 @@
+# @ledgerhq/hw-transport
+
+## 6.27.2-next.0
+
+### Patch Changes
+
+- Updated dependencies [[`203b927b4`](https://github.com/LedgerHQ/ledger-live/commit/203b927b4e5bca3402c85a88c536d519adb18c5f), [`f538d2974`](https://github.com/LedgerHQ/ledger-live/commit/f538d29745669b2aada6ac34f37cd404c23cf1b8)]:
+  - @ledgerhq/errors@6.10.1-next.0
+  - @ledgerhq/devices@7.0.0-next.0

package/README.md

@@ -192,7 +192,7 @@ Returns **any** a promise of descriptors
 
 #### listen
 
-Listen all device events for a given Transport. The method takes an Obverver of DescriptorEvent and returns a Subscription (according to Observable paradigm <https://github.com/tc39/proposal-observable> )
+Listen all device events for a given Transport. The method takes an Obverver of DescriptorEvent and returns a Subscription (according to Observable paradigm https://github.com/tc39/proposal-observable )
 a DescriptorEvent is a `{ descriptor, type }` object. type can be `"add"` or `"remove"` and descriptor is a value you can pass to `open(descriptor)`.
 each listen() call will first emit all potential device already connected and then will emit events can come over times,
 for instance if you plug a USB device after listen() or a bluetooth device become discoverable.

package/jest.config.ts

@@ -0,0 +1,6 @@
+import baseConfig from "../../jest.config";
+
+export default {
+  ...baseConfig,
+  rootDir: __dirname,
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ledgerhq/hw-transport",
-  "version": "6.27.1",
+  "version": "6.27.2-next.0",
   "description": "Ledger Hardware Wallet common interface of the communication layer",
   "keywords": [
     "Ledger",
@@ -11,12 +11,12 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/LedgerHQ/ledgerjs"
+    "url": "https://github.com/LedgerHQ/ledger-live.git"
   },
   "bugs": {
-    "url": "https://github.com/LedgerHQ/ledgerjs/issues"
+    "url": "https://github.com/LedgerHQ/ledger-live/issues"
   },
-  "homepage": "https://github.com/LedgerHQ/ledgerjs",
+  "homepage": "https://github.com/LedgerHQ/ledger-live/tree/develop/libs/ledgerjs/packages/hw-transport",
   "publishConfig": {
     "access": "public"
   },
@@ -25,15 +25,19 @@
   "types": "lib/Transport.d.ts",
   "license": "Apache-2.0",
   "dependencies": {
-    "@ledgerhq/devices": "^6.27.1",
-    "@ledgerhq/errors": "^6.10.0",
+    "@ledgerhq/devices": "^7.0.0-next.0",
+    "@ledgerhq/errors": "^6.10.1-next.0",
     "events": "^3.3.0"
   },
+  "gitHead": "dd0dea64b58e5a9125c8a422dcffd29e5ef6abec",
   "scripts": {
-    "clean": "bash ../../script/clean.sh",
-    "build": "bash ../../script/build.sh",
-    "watch": "bash ../../script/watch.sh",
-    "doc": "bash ../../script/doc.sh"
-  },
-  "gitHead": "9639f96a970e1f46e9e39d0c2c361ce2289923be"
-}
+    "clean": "rimraf lib lib-es",
+    "build": "tsc && tsc -m ES6 --outDir lib-es",
+    "prewatch": "pnpm build",
+    "watch": "tsc --watch",
+    "doc": "documentation readme src/** --section=API --pe ts --re ts --re d.ts",
+    "lint": "eslint ./src --no-error-on-unmatched-pattern --ext .ts,.tsx",
+    "lint:fix": "pnpm lint --fix",
+    "test": "jest"
+  }
+}

package/LICENSE

@@ -1,202 +0,0 @@
-                                 Apache License
-                           Version 2.0, January 2004
-                        http://www.apache.org/licenses/
-
-   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
-
-   1. Definitions.
-
-      "License" shall mean the terms and conditions for use, reproduction,
-      and distribution as defined by Sections 1 through 9 of this document.
-
-      "Licensor" shall mean the copyright owner or entity authorized by
-      the copyright owner that is granting the License.
-
-      "Legal Entity" shall mean the union of the acting entity and all
-      other entities that control, are controlled by, or are under common
-      control with that entity. For the purposes of this definition,
-      "control" means (i) the power, direct or indirect, to cause the
-      direction or management of such entity, whether by contract or
-      otherwise, or (ii) ownership of fifty percent (50%) or more of the
-      outstanding shares, or (iii) beneficial ownership of such entity.
-
-      "You" (or "Your") shall mean an individual or Legal Entity
-      exercising permissions granted by this License.
-
-      "Source" form shall mean the preferred form for making modifications,
-      including but not limited to software source code, documentation
-      source, and configuration files.
-
-      "Object" form shall mean any form resulting from mechanical
-      transformation or translation of a Source form, including but
-      not limited to compiled object code, generated documentation,
-      and conversions to other media types.
-
-      "Work" shall mean the work of authorship, whether in Source or
-      Object form, made available under the License, as indicated by a
-      copyright notice that is included in or attached to the work
-      (an example is provided in the Appendix below).
-
-      "Derivative Works" shall mean any work, whether in Source or Object
-      form, that is based on (or derived from) the Work and for which the
-      editorial revisions, annotations, elaborations, or other modifications
-      represent, as a whole, an original work of authorship. For the purposes
-      of this License, Derivative Works shall not include works that remain
-      separable from, or merely link (or bind by name) to the interfaces of,
-      the Work and Derivative Works thereof.
-
-      "Contribution" shall mean any work of authorship, including
-      the original version of the Work and any modifications or additions
-      to that Work or Derivative Works thereof, that is intentionally
-      submitted to Licensor for inclusion in the Work by the copyright owner
-      or by an individual or Legal Entity authorized to submit on behalf of
-      the copyright owner. For the purposes of this definition, "submitted"
-      means any form of electronic, verbal, or written communication sent
-      to the Licensor or its representatives, including but not limited to
-      communication on electronic mailing lists, source code control systems,
-      and issue tracking systems that are managed by, or on behalf of, the
-      Licensor for the purpose of discussing and improving the Work, but
-      excluding communication that is conspicuously marked or otherwise
-      designated in writing by the copyright owner as "Not a Contribution."
-
-      "Contributor" shall mean Licensor and any individual or Legal Entity
-      on behalf of whom a Contribution has been received by Licensor and
-      subsequently incorporated within the Work.
-
-   2. Grant of Copyright License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      copyright license to reproduce, prepare Derivative Works of,
-      publicly display, publicly perform, sublicense, and distribute the
-      Work and such Derivative Works in Source or Object form.
-
-   3. Grant of Patent License. Subject to the terms and conditions of
-      this License, each Contributor hereby grants to You a perpetual,
-      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
-      (except as stated in this section) patent license to make, have made,
-      use, offer to sell, sell, import, and otherwise transfer the Work,
-      where such license applies only to those patent claims licensable
-      by such Contributor that are necessarily infringed by their
-      Contribution(s) alone or by combination of their Contribution(s)
-      with the Work to which such Contribution(s) was submitted. If You
-      institute patent litigation against any entity (including a
-      cross-claim or counterclaim in a lawsuit) alleging that the Work
-      or a Contribution incorporated within the Work constitutes direct
-      or contributory patent infringement, then any patent licenses
-      granted to You under this License for that Work shall terminate
-      as of the date such litigation is filed.
-
-   4. Redistribution. You may reproduce and distribute copies of the
-      Work or Derivative Works thereof in any medium, with or without
-      modifications, and in Source or Object form, provided that You
-      meet the following conditions:
-
-      (a) You must give any other recipients of the Work or
-          Derivative Works a copy of this License; and
-
-      (b) You must cause any modified files to carry prominent notices
-          stating that You changed the files; and
-
-      (c) You must retain, in the Source form of any Derivative Works
-          that You distribute, all copyright, patent, trademark, and
-          attribution notices from the Source form of the Work,
-          excluding those notices that do not pertain to any part of
-          the Derivative Works; and
-
-      (d) If the Work includes a "NOTICE" text file as part of its
-          distribution, then any Derivative Works that You distribute must
-          include a readable copy of the attribution notices contained
-          within such NOTICE file, excluding those notices that do not
-          pertain to any part of the Derivative Works, in at least one
-          of the following places: within a NOTICE text file distributed
-          as part of the Derivative Works; within the Source form or
-          documentation, if provided along with the Derivative Works; or,
-          within a display generated by the Derivative Works, if and
-          wherever such third-party notices normally appear. The contents
-          of the NOTICE file are for informational purposes only and
-          do not modify the License. You may add Your own attribution
-          notices within Derivative Works that You distribute, alongside
-          or as an addendum to the NOTICE text from the Work, provided
-          that such additional attribution notices cannot be construed
-          as modifying the License.
-
-      You may add Your own copyright statement to Your modifications and
-      may provide additional or different license terms and conditions
-      for use, reproduction, or distribution of Your modifications, or
-      for any such Derivative Works as a whole, provided Your use,
-      reproduction, and distribution of the Work otherwise complies with
-      the conditions stated in this License.
-
-   5. Submission of Contributions. Unless You explicitly state otherwise,
-      any Contribution intentionally submitted for inclusion in the Work
-      by You to the Licensor shall be under the terms and conditions of
-      this License, without any additional terms or conditions.
-      Notwithstanding the above, nothing herein shall supersede or modify
-      the terms of any separate license agreement you may have executed
-      with Licensor regarding such Contributions.
-
-   6. Trademarks. This License does not grant permission to use the trade
-      names, trademarks, service marks, or product names of the Licensor,
-      except as required for reasonable and customary use in describing the
-      origin of the Work and reproducing the content of the NOTICE file.
-
-   7. Disclaimer of Warranty. Unless required by applicable law or
-      agreed to in writing, Licensor provides the Work (and each
-      Contributor provides its Contributions) on an "AS IS" BASIS,
-      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
-      implied, including, without limitation, any warranties or conditions
-      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
-      PARTICULAR PURPOSE. You are solely responsible for determining the
-      appropriateness of using or redistributing the Work and assume any
-      risks associated with Your exercise of permissions under this License.
-
-   8. Limitation of Liability. In no event and under no legal theory,
-      whether in tort (including negligence), contract, or otherwise,
-      unless required by applicable law (such as deliberate and grossly
-      negligent acts) or agreed to in writing, shall any Contributor be
-      liable to You for damages, including any direct, indirect, special,
-      incidental, or consequential damages of any character arising as a
-      result of this License or out of the use or inability to use the
-      Work (including but not limited to damages for loss of goodwill,
-      work stoppage, computer failure or malfunction, or any and all
-      other commercial damages or losses), even if such Contributor
-      has been advised of the possibility of such damages.
-
-   9. Accepting Warranty or Additional Liability. While redistributing
-      the Work or Derivative Works thereof, You may choose to offer,
-      and charge a fee for, acceptance of support, warranty, indemnity,
-      or other liability obligations and/or rights consistent with this
-      License. However, in accepting such obligations, You may act only
-      on Your own behalf and on Your sole responsibility, not on behalf
-      of any other Contributor, and only if You agree to indemnify,
-      defend, and hold each Contributor harmless for any liability
-      incurred by, or claims asserted against, such Contributor by reason
-      of your accepting any such warranty or additional liability.
-
-   END OF TERMS AND CONDITIONS
-
-   APPENDIX: How to apply the Apache License to your work.
-
-      To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
-      replaced with your own identifying information. (Don't include
-      the brackets!)  The text should be enclosed in the appropriate
-      comment syntax for the file format. We also recommend that a
-      file or class name and description of purpose be included on the
-      same "printed page" as the copyright notice for easier
-      identification within third-party archives.
-
-   Copyright {yyyy} {name of copyright owner}
-
-   Licensed under the Apache License, Version 2.0 (the "License");
-   you may not use this file except in compliance with the License.
-   You may obtain a copy of the License at
-
-       http://www.apache.org/licenses/LICENSE-2.0
-
-   Unless required by applicable law or agreed to in writing, software
-   distributed under the License is distributed on an "AS IS" BASIS,
-   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-   See the License for the specific language governing permissions and
-   limitations under the License.
-

package/lib-es/Transport.js.flow

@@ -1,343 +0,0 @@
-//@flow
-
-import EventEmitter from "events";
-import type { DeviceModel } from "@ledgerhq/devices";
-import {
-  TransportRaceCondition,
-  TransportError,
-  StatusCodes,
-  getAltStatusMessage,
-  TransportStatusError,
-} from "@ledgerhq/errors";
-
-export {
-  TransportError,
-  TransportStatusError,
-  StatusCodes,
-  getAltStatusMessage,
-};
-
-/**
- */
-export type Subscription = { unsubscribe: () => void };
-
-/**
- */
-export type Device = Object;
-
-/**
- * type: add or remove event
- * descriptor: a parameter that can be passed to open(descriptor)
- * deviceModel: device info on the model (is it a nano s, nano x, ...)
- * device: transport specific device info
- */
-export type DescriptorEvent<Descriptor> = {
-  type: "add" | "remove",
-  descriptor: Descriptor,
-  deviceModel?: ?DeviceModel,
-  device?: Device,
-};
-/**
- */
-export type Observer<Ev> = $ReadOnly<{
-  next: (event: Ev) => mixed,
-  error: (e: any) => mixed,
-  complete: () => mixed,
-}>;
-
-/**
- * Transport defines the generic interface to share between node/u2f impl
- * A **Descriptor** is a parametric type that is up to be determined for the implementation.
- * it can be for instance an ID, an file path, a URL,...
- */
-export default class Transport<Descriptor> {
-  exchangeTimeout: number = 30000;
-  unresponsiveTimeout: number = 15000;
-  deviceModel: ?DeviceModel = null;
-
-  /**
-   * Statically check if a transport is supported on the user's platform/browser.
-   */
-  static +isSupported: () => Promise<boolean>;
-
-  /**
-   * List once all available descriptors. For a better granularity, checkout `listen()`.
-   * @return a promise of descriptors
-   * @example
-   * TransportFoo.list().then(descriptors => ...)
-   */
-  static +list: () => Promise<Array<Descriptor>>;
-
-  /**
-   * Listen all device events for a given Transport. The method takes an Obverver of DescriptorEvent and returns a Subscription (according to Observable paradigm https://github.com/tc39/proposal-observable )
-   * a DescriptorEvent is a `{ descriptor, type }` object. type can be `"add"` or `"remove"` and descriptor is a value you can pass to `open(descriptor)`.
-   * each listen() call will first emit all potential device already connected and then will emit events can come over times,
-   * for instance if you plug a USB device after listen() or a bluetooth device become discoverable.
-   * @param observer is an object with a next, error and complete function (compatible with observer pattern)
-   * @return a Subscription object on which you can `.unsubscribe()` to stop listening descriptors.
-   * @example
-const sub = TransportFoo.listen({
-  next: e => {
-    if (e.type==="add") {
-      sub.unsubscribe();
-      const transport = await TransportFoo.open(e.descriptor);
-      ...
-    }
-  },
-  error: error => {},
-  complete: () => {}
-})
-   */
-  static +listen: (
-    observer: Observer<DescriptorEvent<Descriptor>>
-  ) => Subscription;
-
-  /**
-   * attempt to create a Transport instance with potentially a descriptor.
-   * @param descriptor: the descriptor to open the transport with.
-   * @param timeout: an optional timeout
-   * @return a Promise of Transport instance
-   * @example
-TransportFoo.open(descriptor).then(transport => ...)
-   */
-  static +open: (
-    descriptor: Descriptor,
-    timeout?: number
-  ) => Promise<Transport<Descriptor>>;
-
-  /**
-   * low level api to communicate with the device
-   * This method is for implementations to implement but should not be directly called.
-   * Instead, the recommanded way is to use send() method
-   * @param apdu the data to send
-   * @return a Promise of response data
-   */
-  exchange(_apdu: Buffer): Promise<Buffer> {
-    throw new Error("exchange not implemented");
-  }
-
-  /**
-   * set the "scramble key" for the next exchanges with the device.
-   * Each App can have a different scramble key and they internally will set it at instanciation.
-   * @param key the scramble key
-   */
-  setScrambleKey(_key: string) {}
-
-  /**
-   * close the exchange with the device.
-   * @return a Promise that ends when the transport is closed.
-   */
-  close(): Promise<void> {
-    return Promise.resolve();
-  }
-
-  _events = new EventEmitter();
-
-  /**
-   * Listen to an event on an instance of transport.
-   * Transport implementation can have specific events. Here is the common events:
-   * * `"disconnect"` : triggered if Transport is disconnected
-   */
-  on(eventName: string, cb: Function) {
-    this._events.on(eventName, cb);
-  }
-
-  /**
-   * Stop listening to an event on an instance of transport.
-   */
-  off(eventName: string, cb: Function) {
-    this._events.removeListener(eventName, cb);
-  }
-
-  emit(event: string, ...args: *) {
-    this._events.emit(event, ...args);
-  }
-
-  /**
-   * Enable or not logs of the binary exchange
-   */
-  setDebugMode() {
-    console.warn(
-      "setDebugMode is deprecated. use @ledgerhq/logs instead. No logs are emitted in this anymore."
-    );
-  }
-
-  /**
-   * Set a timeout (in milliseconds) for the exchange call. Only some transport might implement it. (e.g. U2F)
-   */
-  setExchangeTimeout(exchangeTimeout: number) {
-    this.exchangeTimeout = exchangeTimeout;
-  }
-
-  /**
-   * Define the delay before emitting "unresponsive" on an exchange that does not respond
-   */
-  setExchangeUnresponsiveTimeout(unresponsiveTimeout: number) {
-    this.unresponsiveTimeout = unresponsiveTimeout;
-  }
-
-  /**
-   * wrapper on top of exchange to simplify work of the implementation.
-   * @param cla
-   * @param ins
-   * @param p1
-   * @param p2
-   * @param data
-   * @param statusList is a list of accepted status code (shorts). [0x9000] by default
-   * @return a Promise of response buffer
-   */
-  send = async (
-    cla: number,
-    ins: number,
-    p1: number,
-    p2: number,
-    data: Buffer = Buffer.alloc(0),
-    statusList: Array<number> = [StatusCodes.OK]
-  ): Promise<Buffer> => {
-    if (data.length >= 256) {
-      throw new TransportError(
-        "data.length exceed 256 bytes limit. Got: " + data.length,
-        "DataLengthTooBig"
-      );
-    }
-    const response = await this.exchange(
-      Buffer.concat([
-        Buffer.from([cla, ins, p1, p2]),
-        Buffer.from([data.length]),
-        data,
-      ])
-    );
-    const sw = response.readUInt16BE(response.length - 2);
-    if (!statusList.some((s) => s === sw)) {
-      throw new TransportStatusError(sw);
-    }
-    return response;
-  };
-
-  /**
-   * create() allows to open the first descriptor available or
-   * throw if there is none or if timeout is reached.
-   * This is a light helper, alternative to using listen() and open() (that you may need for any more advanced usecase)
-   * @example
-TransportFoo.create().then(transport => ...)
-   */
-  static create(
-    openTimeout?: number = 3000,
-    listenTimeout?: number
-  ): Promise<Transport<Descriptor>> {
-    return new Promise((resolve, reject) => {
-      let found = false;
-      const sub = this.listen({
-        next: (e) => {
-          found = true;
-          if (sub) sub.unsubscribe();
-          if (listenTimeoutId) clearTimeout(listenTimeoutId);
-          this.open(e.descriptor, openTimeout).then(resolve, reject);
-        },
-        error: (e) => {
-          if (listenTimeoutId) clearTimeout(listenTimeoutId);
-          reject(e);
-        },
-        complete: () => {
-          if (listenTimeoutId) clearTimeout(listenTimeoutId);
-          if (!found) {
-            reject(
-              new TransportError(
-                this.ErrorMessage_NoDeviceFound,
-                "NoDeviceFound"
-              )
-            );
-          }
-        },
-      });
-      const listenTimeoutId = listenTimeout
-        ? setTimeout(() => {
-            sub.unsubscribe();
-            reject(
-              new TransportError(
-                this.ErrorMessage_ListenTimeout,
-                "ListenTimeout"
-              )
-            );
-          }, listenTimeout)
-        : null;
-    });
-  }
-
-  exchangeBusyPromise: ?Promise<void>;
-
-  // $FlowFixMe
-  exchangeAtomicImpl = async (f) => {
-    if (this.exchangeBusyPromise) {
-      throw new TransportRaceCondition(
-        "An action was already pending on the Ledger device. Please deny or reconnect."
-      );
-    }
-    let resolveBusy;
-    const busyPromise = new Promise((r) => {
-      resolveBusy = r;
-    });
-    this.exchangeBusyPromise = busyPromise;
-    let unresponsiveReached = false;
-    const timeout = setTimeout(() => {
-      unresponsiveReached = true;
-      this.emit("unresponsive");
-    }, this.unresponsiveTimeout);
-    try {
-      const res = await f();
-      if (unresponsiveReached) {
-        this.emit("responsive");
-      }
-      return res;
-    } finally {
-      clearTimeout(timeout);
-      if (resolveBusy) resolveBusy();
-      this.exchangeBusyPromise = null;
-    }
-  };
-
-  decorateAppAPIMethods(
-    self: Object,
-    methods: Array<string>,
-    scrambleKey: string
-  ) {
-    for (let methodName of methods) {
-      self[methodName] = this.decorateAppAPIMethod(
-        methodName,
-        self[methodName],
-        self,
-        scrambleKey
-      );
-    }
-  }
-
-  _appAPIlock = null;
-  decorateAppAPIMethod<R, A: any[]>(
-    methodName: string,
-    f: (...args: A) => Promise<R>,
-    ctx: *,
-    scrambleKey: string
-  ): (...args: A) => Promise<R> {
-    return async (...args) => {
-      const { _appAPIlock } = this;
-      if (_appAPIlock) {
-        return Promise.reject(
-          new TransportError(
-            "Ledger Device is busy (lock " + _appAPIlock + ")",
-            "TransportLocked"
-          )
-        );
-      }
-      try {
-        this._appAPIlock = methodName;
-        this.setScrambleKey(scrambleKey);
-        return await f.apply(ctx, args);
-      } finally {
-        this._appAPIlock = null;
-      }
-    };
-  }
-
-  static ErrorMessage_ListenTimeout = "No Ledger device found (timeout)";
-  static ErrorMessage_NoDeviceFound = "No Ledger device found";
-}