@ledgerhq/errors

Hodl all possible errors of Ledger (live, ledgerjs) so we can deal with them in a unified way (share between libraries, instanceof them,...)

API

Table of Contents

• HwTransportErrorType
• HwTransportError
  • Parameters
• TransportError
  • Parameters
• TransportStatusError
  • Parameters

HwTransportErrorType

Type of a Transport error used to represent all equivalent errors coming from all possible implementation of Transport

HwTransportError

Extends Error

Represents an error coming from the usage of any Transport implementation.

Needed to map a specific implementation error into an error that can be managed by any code unaware of the specific Transport implementation that was used.

Parameters

• type HwTransportErrorType
• message string

TransportError

Extends Error

TransportError is used for any generic transport errors. e.g. Error thrown when data received by exchanges are incorrect or if exchanged failed to communicate with the device for various reason.

Parameters

• message string
• id string

TransportStatusError

Extends Error

Error thrown when a device returned a non success status. the error.statusCode is one of the StatusCodes exported by this library.

Parameters

• statusCode number The error status code coming from a Transport implementation

• options {canBeMappedToChildError: boolean?} containing:* canBeMappedToChildError: enable the mapping of TransportStatusError to an error extending/inheriting from it

  . Ex: LockedDeviceError. Default to true. (optional, default `{}`)

  • options.canBeMappedToChildError (optional, default true)

@ledgerhq/errors

6.22.0

Minor Changes

• #10493 b5e3217 Thanks @CremaFR! - feat: catching missing address to better understand swap errors

6.22.0-next.0

Minor Changes

• #10493 b5e3217 Thanks @CremaFR! - feat: catching missing address to better understand swap errors

6.21.0

Minor Changes

• #9929 107f35a Thanks @semeano! - Add aptos tokens functionality

• #10269 9081c26 Thanks @francois-guerin-ledger! - refactor(llc): extract Solana signer creation logic

6.21.0-next.0

Minor Changes

• #9929 107f35a Thanks @semeano! - Add aptos tokens functionality

• #10269 9081c26 Thanks @francois-guerin-ledger! - refactor(llc): extract Solana signer creation logic

6.19.1

Patch Changes

• #7771 0a71c43 Thanks @valpinkman! - Add new PINNotSet error

6.19.1-next.0

Patch Changes

• #7771 0a71c43 Thanks @valpinkman! - Add new PINNotSet error

6.19.0

Minor Changes

• #7603 5c738cb Thanks @thesan! - Fix Trustchain error when switching device while logged in

Patch Changes

• #7672 fb9466a Thanks @hzheng-ledger! - Add support for jettons

• #7690 a3fd728 Thanks @thesan! - Refresh ledger sync QR code on expiration

6.19.0-next.0

Minor Changes

• #7603 5c738cb Thanks @thesan! - Fix Trustchain error when switching device while logged in

Patch Changes

• #7672 fb9466a Thanks @hzheng-ledger! - Add support for jettons

• #7690 a3fd728 Thanks @thesan! - Refresh ledger sync QR code on expiration

6.18.0

Minor Changes

• #7124 e78f3b7 Thanks @jiyuzhuang! - Implement App data backup relative commands

Patch Changes

• #7286 f979216 Thanks @CremaFR! - fix: tron max value computation

• #7202 c1d2bb0 Thanks @CremaFR! - feat transform NotEnoughBalance into specific error for swap to have different error messages

6.18.0-next.0

Minor Changes

• #7124 e78f3b7 Thanks @jiyuzhuang! - Implement App data backup relative commands

Patch Changes

• #7286 f979216 Thanks @CremaFR! - fix: tron max value computation

• #7202 c1d2bb0 Thanks @CremaFR! - feat transform NotEnoughBalance into specific error for swap to have different error messages

6.17.0

Minor Changes

• #6596 77fa530 Thanks @KVNLS! - Upgrade React Native to version 0.73.6

• #6812 cec1599 Thanks @sprohaszka-ledger! - Modularize Cardano

Patch Changes

• #6963 815ae3d Thanks @aussedatlo! - restore TransportRaceCondition instead of TransportPendingOperation that caused a breaking change

6.17.0-next.0

Minor Changes

• #6596 77fa530 Thanks @KVNLS! - Upgrade React Native to version 0.73.6

• #6812 cec1599 Thanks @sprohaszka-ledger! - Modularize Cardano

Patch Changes

• #6963 815ae3d Thanks @aussedatlo! - restore TransportRaceCondition instead of TransportPendingOperation that caused a breaking change

6.16.4

Patch Changes

• #6257 fc4f83e Thanks @lpaquet-ledger! - add new errors for wrong device

• #6554 dd1d17f Thanks @liviuciulinaru! - Implement DisabledTransactionBroadcastError to handle a specific development scenario where transaction broadcasts are disabled

• #6317 26b3a5d Thanks @hzheng-ledger! - fix cosmos sequence number error message

6.16.4-next.0

Patch Changes

• #6257 fc4f83e Thanks @lpaquet-ledger! - add new errors for wrong device

• #6554 dd1d17f Thanks @liviuciulinaru! - Implement DisabledTransactionBroadcastError to handle a specific development scenario where transaction broadcasts are disabled

• #6317 26b3a5d Thanks @hzheng-ledger! - fix cosmos sequence number error message

6.16.3

Patch Changes

• #6107 f456d69 Thanks @jdabbech-ledger! - Set prototype of locked device error in order to fix 'instanceof' check of an error

6.16.3-next.0

Patch Changes

• #6107 f456d69 Thanks @jdabbech-ledger! - Set prototype of locked device error in order to fix 'instanceof' check of an error

6.16.2

Patch Changes

• #6165 ee88785 Thanks @live-github-bot! - Set prototype of locked device error in order to fix 'instanceof' check of an error

6.16.2-next.0

Patch Changes

• #6107 f456d69 Thanks @jdabbech-ledger! - Set prototype of locked device error in order to fix 'instanceof' check of an error

6.16.1

Patch Changes

• #5171 52a3732 Thanks @alexandremgo! - Feat: new abort timeout on opening transport and APDU exchange

  On @ledgerhq/hw-transport

  • exchange adding an optional abortTimeoutMs arg to its definition
  • send taking an optional abortTimeoutMs and passing it to exchange
  • Some documentation and tracing

  On @ledgerhq/react-native-hw-transport-ble

  • open: enabling optional timeout when opening a transport instance
  • exchange: enabling optional timeout on APDU exchange, calling cancelPendingOperations on timeout
  • cancelPendingOperations: using a currentTransactionIds array of transactions id for each write, we can try to abort completely pending writes
  • More documentation + tracing + simple unit tests

• #5432 4d1aade Thanks @alexandremgo! - chore: refactoring TransportStatusError

  Refactor into a real class in order to improve TS inference

6.16.1-next.0

Patch Changes

• #5171 52a3732 Thanks @alexandremgo! - Feat: new abort timeout on opening transport and APDU exchange

  On @ledgerhq/hw-transport

  • exchange adding an optional abortTimeoutMs arg to its definition
  • send taking an optional abortTimeoutMs and passing it to exchange
  • Some documentation and tracing

  On @ledgerhq/react-native-hw-transport-ble

  • open: enabling optional timeout when opening a transport instance
  • exchange: enabling optional timeout on APDU exchange, calling cancelPendingOperations on timeout
  • cancelPendingOperations: using a currentTransactionIds array of transactions id for each write, we can try to abort completely pending writes
  • More documentation + tracing + simple unit tests

• #5432 4d1aade Thanks @alexandremgo! - chore: refactoring TransportStatusError

  Refactor into a real class in order to improve TS inference

6.16.0

Minor Changes

• #4886 771c9d3c1d Thanks @chabroA! - Add speedup / cancel tx feature for evm

• #5430 5964e30bed Thanks @hedi-edelbloute! - Update documentation v14 ledgerjs

Patch Changes

• #4819 c5981ae341 Thanks @haammar-ledger! - Add support for casper blockchain

• #4987 e63205b850 Thanks @kallen-ledger! - add 10s timeout to estimate gas

6.16.0-next.0

Minor Changes

• #4886 771c9d3c1d Thanks @chabroA! - Add speedup / cancel tx feature for evm

• #5430 5964e30bed Thanks @hedi-edelbloute! - Update documentation v14 ledgerjs

Patch Changes

• #4819 c5981ae341 Thanks @haammar-ledger! - Add support for casper blockchain

• #4987 e63205b850 Thanks @kallen-ledger! - add 10s timeout to estimate gas

6.15.0

Minor Changes

• #4919 4d6fa0772e Thanks @hedi-edelbloute! - Change network error to better suit node flakiness

6.15.0-next.0

Minor Changes

• #4919 4d6fa0772e Thanks @hedi-edelbloute! - Change network error to better suit node flakiness

6.14.0

Minor Changes

• #4154 3455944496 Thanks @kallen-ledger! - Added NotEnoughGasSwap to errors, will return amountFromWarning from useSwapTransaction and display and interpolate NotEnoughGasSwap in LLD

Patch Changes

• #4186 a61a43fc47 Thanks @kallen-ledger! - Add linked errors to LLM

6.14.0-next.0

Minor Changes

• #4154 3455944496 Thanks @kallen-ledger! - Added NotEnoughGasSwap to errors, will return amountFromWarning from useSwapTransaction and display and interpolate NotEnoughGasSwap in LLD

Patch Changes

• #4186 a61a43fc47 Thanks @kallen-ledger! - Add linked errors to LLM

6.13.1

Patch Changes

• #4042 c7c484acf0 Thanks @alexandremgo! - feat: new error (only used in the device SDK) UnresponsiveDeviceError

6.13.1-next.0

Patch Changes

• #4042 c7c484acf0 Thanks @alexandremgo! - feat: new error (only used in the device SDK) UnresponsiveDeviceError

6.13.0

Minor Changes

• #3815 0f4293e9bf Thanks @haammar-ledger! - Support for Internet Computer blockchain

6.13.0-next.0

Minor Changes

• #3815 0f4293e9bf Thanks @haammar-ledger! - Support for Internet Computer blockchain

6.12.7

Patch Changes

• #3631 9adc1862dd Thanks @scnale! - Adds message to TransportStatusErrors displayed in node.js

6.12.7-next.0

Patch Changes

• #3631 9adc1862dd Thanks @scnale! - Adds message to TransportStatusErrors displayed in node.js

6.12.6

Patch Changes

• #3306 77f990e207 Thanks @chabroA! - Add missing ClaimRewardsFeesWarning error definition

6.12.6-next.0

Patch Changes

• #3306 77f990e207 Thanks @chabroA! - Add missing ClaimRewardsFeesWarning error definition

6.12.5

Patch Changes

• #3229 87d2349fd8 Thanks @juan-cortes! - Added mising error for broken ble pairing

6.12.5-next.0

Patch Changes

• #3229 87d2349fd8 Thanks @juan-cortes! - Added mising error for broken ble pairing

6.12.4

Patch Changes

• #2949 1d0b2d19eb Thanks @juan-cortes! - added new status code to unboarded device

• #3002 ef945b05c0 Thanks @juan-cortes! - Support 5102 status on language pack installation (full device)

• #2912 5fa68510b4 Thanks @alexandremgo! - chore: re-work of the transport error mapping HwTransportErrorType

  And updating functions and hooks using them

6.12.4-next.0

Patch Changes

• #2949 1d0b2d19eb Thanks @juan-cortes! - added new status code to unboarded device

• #3002 ef945b05c0 Thanks @juan-cortes! - Support 5102 status on language pack installation (full device)

• #2912 5fa68510b4 Thanks @alexandremgo! - chore: re-work of the transport error mapping HwTransportErrorType

  And updating functions and hooks using them

6.12.3

Patch Changes

• #2176 3df451dafb Thanks @juan-cortes! - Handled IL old firmware bug that prevented access to My Ledger

• #2205 20c5c5e109 Thanks @juan-cortes! - Better error handling in socket.ts connections to scriptrunners

6.12.3-next.0

Patch Changes

• #2176 3df451dafb Thanks @juan-cortes! - Handled IL old firmware bug that prevented access to My Ledger

• #2205 20c5c5e109 Thanks @juan-cortes! - Better error handling in socket.ts connections to scriptrunners

6.12.2

Patch Changes

• #1984 f1c15446da Thanks @alexandremgo! - New HwTransportError for all the implementations of Transport

6.12.2-next.0

Patch Changes

• #1984 f1c15446da Thanks @alexandremgo! - New HwTransportError for all the implementations of Transport

6.12.1

Patch Changes

• #1779 856f49374e Thanks @juan-cortes! - Added missing StatusCodes for custom image fetch

• #1741 77056e3692 Thanks @alexandremgo! - Fix for locked device error

6.12.1-next.0

Patch Changes

• #1779 856f49374e Thanks @juan-cortes! - Added missing StatusCodes for custom image fetch

• #1741 77056e3692 Thanks @alexandremgo! - Fix for locked device error

6.12.0

Minor Changes

• #1662 4ad6155953 Thanks @lambertkevin! - Add EIP1559 related errors

Patch Changes

• #1766 0308e8c6ae Thanks @gre! - Fixes resiliency of deserializeError.

• #1622 df8cbb8dd1 Thanks @alexandremgo! - Fix bootloader repairing steps

• #1141 24ea9cd15f Thanks @valpinkman! - Collateral changes due to solving all LLM typescript/eslint issues/warnings.

6.12.0-next.0

Minor Changes

• #1662 4ad6155953 Thanks @lambertkevin! - Add EIP1559 related errors

Patch Changes

• #1766 0308e8c6ae Thanks @gre! - Fixes resiliency of deserializeError.

• #1622 df8cbb8dd1 Thanks @alexandremgo! - Fix bootloader repairing steps

• #1141 24ea9cd15f Thanks @valpinkman! - Collateral changes due to solving all LLM typescript/eslint issues/warnings.

6.11.1

Patch Changes

• #1356 ecac411d7a Thanks @juan-cortes! - Updated readme.md of packages

6.11.1-next.0

Patch Changes

• #1356 ecac411d7a Thanks @juan-cortes! - Updated readme.md of packages

6.11.0

Minor Changes

• #1253 1a94cbf28a Thanks @hedi-edelbloute! - Warning when btc transactions are pending in send flow

6.11.0-next.0

Minor Changes

• #1253 1a94cbf28a Thanks @hedi-edelbloute! - Warning when btc transactions are pending in send flow

6.10.2

Patch Changes

• #1179 ae5e33e15e Thanks @gre! - Improve TypeScript of @ledgerhq/errors and fixes 2 bugs in swap and stellar on their error handling

6.10.2-next.0

Patch Changes

• #1179 ae5e33e15 Thanks @gre! - Improve TypeScript of @ledgerhq/errors and fixes 2 bugs in swap and stellar on their error handling

6.10.1

Patch Changes

• #547 203b927b4 Thanks @gre! - Improve stacktrace in custom errors

6.10.1-next.0

Patch Changes

• #547 203b927b4 Thanks @gre! - Improve stacktrace in custom errors