@exodus/hw-ledger 3.4.1 → 3.4.2

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.4.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@3.4.1...@exodus/hw-ledger@3.4.2) (2024-12-20)
+
+### License
+
+- license: re-license under MIT license (#10599)
+
 ## [3.4.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/hw-ledger@3.4.0...@exodus/hw-ledger@3.4.1) (2024-10-30)
 
 ### Bug Fixes

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Exodus Movement, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -1,29 +1,34 @@
 # @exodus/hw-ledger
 
-```mermaid
-flowchart LR
-    AA[TransportFactory] --> A
-    A[LedgerDiscovery] -->|"list()"| B(HardwareWalletDescriptor)
-    B --> |"get()"| C(LedgerDevice)
-    C --> |"getAddress()"| D{Pick by \nasset}
-    D -->|bitcoin| E[BitcoinHandlers]
-    D -->|ethereum| F[EthereumHandlers]
-    D -->|solana| G[SolanaHandlers]
+This Exodus SDK feature handles all hardware wallet actions that are specific to Ledger and implements and [interface](../../libraries/hw-common/src/types.ts) which is abstracted for all hardware wallet devices.
+
+## Install
+
+```sh
+yarn add @exodus/hw-ledger
 ```
 
 ## Usage
 
+This feature is designed to be used together with `@exodus/headless`. See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md).
+
+### API Side
+
 ```typescript
-import createLedgerDiscover from '@exodus/hw-ledger'
+import hardwareWalletLedger from '@exodus/hw-ledger'
 import Transport from '@ledgerhq/hw-transport-node-speculos'
 
-// Initialize transport factories depending on the platform
-const ledgerDiscovery = createLedgerDiscover({
-  logger,
-  transports: {
-    tcp: Transport, // emulator transport over tcp
-  },
-})
+// Add a transportsFactories adapter to hold
+// the factory funcctions that are specific to the platform.
+const transportsFactories = {
+  tcp: Transport,
+}
+
+// Create IoC
+const ioc = createIocContainer({ adapters: { transportsFactories }, config, debug })
+ioc.use(hardwareWalletLedger({ bluetoothScannerTimeout: 60 * 1000 }))
+
+// Retrieve the ledgerDiscovery through dependency injection
 
 const ledgerDescriptors = await ledgerDiscovery.list()
 // [
@@ -53,6 +58,25 @@ if (ledgerDevice) {
 }
 ```
 
+### UI Side
+
+This package is not ment to be used directly through the UI. See [using the @exodus/hardware-wallets](../hardware-wallets/README.md) for UI usage.
+
+## Architecture
+
+The discovery provides descriptors which can be used to retrieve device handles.
+
+```mermaid
+flowchart LR
+    AA[TransportFactory] --> A
+    A[LedgerDiscovery] -->|"list()"| B(HardwareWalletDescriptor)
+    B --> |"get()"| C(LedgerDevice)
+    C --> |"getAddress()"| D{Pick by \nasset}
+    D -->|bitcoin| E[BitcoinHandlers]
+    D -->|ethereum| F[EthereumHandlers]
+    D -->|solana| G[SolanaHandlers]
+```
+
 ## Development
 
 If you're on Linux then it's highly likely that you'll want to setup your udev rules.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/hw-ledger",
-  "version": "3.4.1",
+  "version": "3.4.2",
   "description": "The ledger module",
   "author": "Exodus Movement, Inc.",
   "repository": {
@@ -8,7 +8,7 @@
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
   "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/features/hw-ledger",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "bugs": {
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Ahw-ledger"
   },
@@ -23,7 +23,7 @@
     "build:watch": "run -T tsc --build tsconfig.build.json && run -T tsc --build -w tsconfig.build.json",
     "clean": "run -T tsc --build --clean",
     "test": "RUN_TESTS=unit run -T exodus-test --jest --esbuild",
-    "zemu:install": "docker pull zondax/builder-zemu:speculos-745fe46f81cfc18114b94a37beaefb58a09c0fcd",
+    "zemu:install": "docker pull zondax/builder-zemu:speculos-ef9610662dc90a1eeddba7c991e3ef7c53c4e258",
     "test:integration": "yarn zemu:install && RUN_TESTS=integration run -T exodus-test --jest --esbuild",
     "lint": "run -T eslint .",
     "lint:fix": "yarn lint --fix",
@@ -51,19 +51,22 @@
   },
   "devDependencies": {
     "@exodus/bip32": "^3.3.0",
-    "@exodus/dependency-types": "^2.1.0",
+    "@exodus/dependency-types": "^2.1.1",
     "@ledgerhq/hw-transport-node-hid": "^6.27.17",
     "@solana/web3.js": "^1.78.0",
     "@types/bs58": "^4.0.1",
     "@types/bs58check": "^2.1.0",
     "@types/minimalistic-assert": "^1.0.1",
     "@types/semver": "^7.3.5",
-    "@zondax/zemu": "^0.43.1",
+    "@zondax/zemu": "^0.51.0",
     "bitcoinjs-lib": "^6.1.3",
     "ecpair": "^2.1.0",
     "p-defer": "^4.0.1",
     "redux": "^4.2.1",
     "tiny-secp256k1": "^2.2.3"
   },
-  "gitHead": "dc618f601bca671c7b778c4c9eb91edfb669e9a2"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "9cef1436f1cf2fa9afa1672954ea92c63a8e0f16"
 }