3.0.0

Major release. Switched from flow to TypeScript.

Changed

• All API calls now use single structured argument instead of long list of partial arguments.
  (For the overview see src/Ada.ts changes in #61)
• AddressTypeNibble enum renamed to AddressType
• derive/showAddress now take network as an explicit parameter instead of networkIdOrProtocolMagic field in AddressParams
• all 64-bit integers that were previously stored in fields ending with Str (e.g. feeStr) are now without the suffix (i.e. fee) and take a "bignumber-like" argument which can be Number (if it is small enough, i.e. <= Number.MAX_SAFE_INTEGER), string, or native BigInt. Non-native bigint implementations are not supported and should be converted to strings)
• all "tagged enums" now use {type: SomeType.Variant, params: SomeTypeVariantParams} typing. This unified previously mixed tagging with sometimes arbitrarily variant fields into the parent type. As part of this change
  • Relays are now typed properly with variants
  • TxOutput was separated into "amount" part (amount & tokenBundle) & destination specification.
    • Destination is now explicitly of type DestinationType.ThirdParty or DestinationType.DeviceOwned to clarify what the device should sign
    • Device owned destination reuses existing Address param type
  • Address is now tagged enum across different address types (Byron, Base, Enterprise, Pointer, Reward). Reward address still uses spendingPath instead of stakingPath to denote that this key can be used to spend funds
• All API call types now use *Request/*Response nomenclature
• GetVersion call now returns {version, compatibility} instead of version where compatibility describes overall set of features we support for the device. It should be responsibility of API users to check compatibility.isCompatible flag and urge users to upgrade device to compatibility.recommendedVersion if the device is not compatible.
• All (expected) errors thrown by the API are now descendants of ErrorBase from errors subpackage. API now distinguishes between these error types
  • InvalidData - you passed some wrong data to the API. We will not even try to communicate with the device
  • DeviceUnsupported - thrown when trying to use API with unsopported Ledger app version (or when using features not yet available for the app version)
  • DeviceStatusError - thrown when device rejects operation for some reason. Common reasons are found in DeviceStatusCodes mapping.
• There is new documentation available at (https://vacuumlabs.github.io/ledgerjs-cardano-shelley/index.html)

Removed

• Compatibility with pre-Mary (<2.2) App versions.

3.0.0-rc.3

Ledgerjs refactored to typescript release candidate

Changes:

• metadata have been renamed to auxiliary data in the signTransaction call (#96)

3.1.0-catalyst-rc.0

Prerelease with Catalyst registration support, to be used with Ledger app built from vacuumlabs/ledger-app-cardano-shelley#63

2.3.0-rc.0

Operator app support pre-release

2.3.0-operatorapp-rc.1

• operator app support with backwards compatibility fixes so stake pool registration as an owner works properly for users registering their pool as owners using Ledger app 2.2.1 and older

3.0.0-rc.2

• Top level transaction types naming made consistent
• Minor internal cleanups

2.3.0-operatorapp-rc.0

• prerelease with operator app support

3.0.0-rc.1

• ledgerjs typescript refactor pre-release with fixed types export

3.0.0-rc.0

• internal pre-release of ledgerjs refactored to TypeScript

2.2.0

Works with Ledger Cardano app 2.2.0 and is backwards compatible with older versions down to 2.0.4/2.0.5*. Older versions of this js library do not support Ledger Cardano app 2.2.0, hence an update to this version of the library is required before Ledger Cardano app 2.2.0 is released.

Added

• Support for Allegra-era transaction min validity property, transaction TTL is now optional: https://github.com/vacuumlabs/ledgerjs-cardano-shelley/pull/27/files
• Support for Mary-era multiasset outputs (no minting yet) https://github.com/vacuumlabs/ledgerjs-cardano-shelley/pull/27/files
• Update docs with a stake pool registration (as an owner) example #23

Fixed

• Fixed incorrect validation of numerical parameters passed as strings which failed for values over JS max safe integer: #29