✨ (rn-hid) [DSDK-611]: React Native HID transport #662

ofreyssinet-ledger · 2025-02-05T13:01:57Z

📝 Description

Android: Copy paste code of Android HID transport from the Mobile DMK.
Android+TS: Implement RNHIDTransport with a Native module + the TS layer on top.
Sample app: Add a screen for testing the RN HID transport (temporary until we have a fully working sample app)

❓ Context

JIRA or GitHub link: DSDK-611

Feature:

✅ Checklist

Pull Requests must pass CI checks and undergo code review. Set the PR as Draft if it is not yet ready for review.

Covered by automatic tests
Changeset is provided
Impact of the changes:
- list of the changes

🧐 Checklist for the PR Reviewers

The code aligns with the requirements described in the linked JIRA or GitHub issue.
The PR description clearly documents the changes made and explains any technical trade-offs or design decisions.
There are no undocumented trade-offs, technical debt, or maintainability issues.
The PR has been tested thoroughly, and any potential edge cases have been considered and handled.
Any new dependencies have been justified and documented.

vercel · 2025-02-05T13:02:02Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
device-sdk-ts-sample	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Feb 21, 2025 11:56am

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
doc-device-management-kit	⬜️ Ignored (Inspect)	Visit Preview		Feb 21, 2025 11:56am

ofreyssinet-ledger · 2025-02-05T15:47:00Z

apps/mobile/App.tsx

temporary changes just to test the transport

packages/transport/rn-hid/src/api/helpers/getObservableOfArraysNewItems.ts

smartine-ledger

GG. Just a few comments 😉

...ndroid/src/main/kotlin/com/ledger/devicesdk/shared/internal/service/stub/StubApduProvider.kt

...ransport/rn-hid/android/src/main/kotlin/com/ledger/devicesdk/shared/internal/utils/Either.kt

smartine-ledger · 2025-02-05T16:24:44Z

...ransport/rn-hid/android/src/main/kotlin/com/ledger/androidtransporthid/TransportHidModule.kt

+                }
+                else -> {}
+            }
+        }.launchIn(CoroutineScope(Dispatchers.Default))


[COMMENT] You never stop collecting the flow

Thanks, done ✅

smartine-ledger · 2025-02-05T16:25:59Z

...ransport/rn-hid/android/src/main/kotlin/com/ledger/androidtransporthid/TransportHidModule.kt

+            sendEvent(reactContext, BridgeEvents.TransportLog(info))
+        }
+
+    private val transport: AndroidUsbTransport? by lazy {


[ASK] Why is it nullable. In addition you never set it to null

[COMMENT] As it's lazy I ask myself if it'd be better to create all the instances in the init{} bloc instead of when we need the transport (meaning when calling the startScan() method) to avoid losing time🤔

It's nullable because reactContext.currentActivity can be null so in that case it's set to null.
The lazy initialization could be useful in case the DMK feature flag isn't enabled in LL. In that case we save some resources. But I'm not 100% sure it's necessary, I can also do that stuff in init...

Yes so I checked, the activity is null when TransportHidModule is initialized. React Native's lifecycle is like that 🤷‍♂️
Looking at the implementation of ReactContext, I can assume that activity won't be null when onResume is called... So I could do the initialization there.
https://github.com/facebook/react-native/blob/f9bffef6c78091d3e89da5e3abba87d1b30b0b69/packages/react-native/ReactAndroid/src/main/java/com/facebook/react/bridge/ReactContext.java#L257-L261

...nsport/rn-hid/android/src/main/kotlin/com/ledger/androidtransporthid/bridge/serialization.kt

smartine-ledger · 2025-02-05T16:33:59Z

packages/transport/rn-hid/src/api/bridge/StubNativeModuleWrapper.ts

+  InternalDeviceDisconnected,
+} from "@api/transport/types";
+
+export class StubNativeModuleWrapper implements NativeModuleWrapper {


[ASK] Useful?

Yes for iOS. It would crash on iOS if we use DefaultNativeModuleWrapper as the native module does not exist in that case.

smartine-ledger · 2025-02-06T09:40:44Z

...n/kotlin/com/ledger/devicesdk/shared/androidMain/transport/usb/DefaultAndroidUsbTransport.kt

+            val establishConnectionFn = {
+                val sessionId = generateSessionId(id = device.deviceId.toString())
+                val newConnection =
+                    AndroidUsbDeviceConnection(
+                        usbManager = usbManager,
+                        usbDevice = device,
+                        ioDispatcher = Dispatchers.IO,
+                        framerService = FramerService(loggerService),
+                        request = UsbRequest(),
                    )
-                }.onEach {
-                    loggerService.log(info = buildSimpleInfoLogInfo(
-                        tag = "DefaultUsbTransport",
-                        message = "event received while connecting : $it")
+                val connectedDevice =
+                    InternalConnectedDevice(
+                        sessionId,
+                        discoveryDevice.name,
+                        discoveryDevice.ledgerDevice,
+                        discoveryDevice.connectivityType,
+                        sendApduFn = { apdu -> newConnection.send(apdu) },
                    )
-                }.first {
-                    it is UsbPermissionEvent.PermissionGranted ||
-                        it is UsbPermissionEvent.PermissionDenied ||
-                        it is UsbState.Detached
-                }
+                usbConnections[sessionId] = newConnection
+                InternalConnectionResult.Connected(device = connectedDevice, sessionId = sessionId)
+            }
+


[COMMENT] Can be simplify without using a lambda and so creating a anonymous object :

override suspend fun connect(discoveryDevice: DiscoveryDevice): InternalConnectionResult { ..... return if (device == null) { InternalConnectionResult.ConnectionError(error = InternalConnectionResult.Failure.DeviceNotFound) } else { val sessionId = generateSessionId(id = device.deviceId.toString()) val newConnection = AndroidUsbDeviceConnection( usbManager = usbManager, usbDevice = device, framerService = FramerService(loggerService), loggerService = loggerService, request = UsbRequest(), ioDispatcher = Dispatchers.IO, ) val connectedDevice = InternalConnectedDevice( sessionId, discoveryDevice.name, discoveryDevice.ledgerDevice, discoveryDevice.connectivityType, sendApduFn = { apdu -> newConnection.send(apdu) }, ) usbConnections[sessionId] = newConnection val establishConnection = InternalConnectionResult.Connected(device = connectedDevice, sessionId = sessionId) if (usbManager.hasPermission(device)) { return establishConnection } ..... }

WDYT?

In the end I extracted the permission check/request logic into a checkAndRequestPermission method as it's reused now when a device gets attached (for reconnecting it)

smartine-ledger · 2025-02-06T09:43:21Z

apps/mobile/android/app/src/main/AndroidManifest.xml

+    <uses-permission android:name="android.permission.BLUETOOTH_SCAN" android:usesPermissionFlags="neverForLocation" />
+    <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
+    <!-- Android < 12 -->
+    <uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
+    <uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
+    <!-- common -->
+    <uses-permission android:name="android.permission.ACCESS_FINE_LOCATION" android:maxSdkVersion="30" />


[ASK] Why do you need these permissions? Don't you just implement the USB transport?

This is coming from the previous commits which my branch is based on, I need them because it includes the base for the sample app. And the sample app supports BLE, hence those permissions.

My bad. My point here was : why don't you add these permissions in the transport/rn-hid/android/src/main instead of the app 🙂

You mean in rn-ble ? In the rn-ble package, there is no native code, we use the react-native-ble-plx which implements the native part. So we don't have control over the AndroidManifest there.

smartine-ledger · 2025-02-06T09:48:15Z

packages/transport/rn-hid/android/build.gradle

+android {
+    namespace "com.ledger.androidtransporthid"
+    compileSdkVersion safeExtGet("compileSdkVersion", 34)
+
+    defaultConfig {
+        minSdkVersion safeExtGet("minSdkVersion", 30)
+        targetSdkVersion safeExtGet("targetSdkVersion", 32)
+        versionCode 1
+        versionName "1.0"
+    }
+
+    compileOptions {
+        // Use JavaVersion enums for compatibility
+        sourceCompatibility JavaVersion.VERSION_17
+        targetCompatibility JavaVersion.VERSION_17
+    }
+
+    kotlinOptions {
+        jvmTarget = jvmTargetVersion
+    }
+
+    lintOptions {
+        abortOnError false
+        warning 'InvalidPackage'
+    }
+}


[COMMENT] be careful. It turns out you don't use the same config that the android/app

What do you mean exactly? You're talking about compileSdkVersion minSdkVersion and targetSdkVersion?

you just need to create and use an constant 😉

smartine-ledger · 2025-02-06T09:56:04Z

...ransport/rn-hid/android/src/main/kotlin/com/ledger/androidtransporthid/TransportHidModule.kt

+            return
+        }
+
+        CoroutineScope(Dispatchers.Default).launch {


[COMMENT] Prefer having only one scope as parameter of the class

thanks, done ✅

github-actions · 2025-02-14T16:44:32Z

	Messages
✅	Danger: All checks passed successfully! 🎉

Generated by 🚫 dangerJS against bce3df6

...n/kotlin/com/ledger/devicesdk/shared/androidMain/transport/usb/DefaultAndroidUsbTransport.kt

...m/ledger/devicesdk/shared/androidMainInternal/transport/deviceconnection/DeviceApduSender.kt

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 971ade3 to b73908e Compare February 5, 2025 15:39

vercel bot deployed to Preview – device-sdk-ts-sample February 5, 2025 15:41 View deployment

ofreyssinet-ledger commented Feb 5, 2025

View reviewed changes

jiyuzhuang reviewed Feb 5, 2025

View reviewed changes

packages/transport/rn-hid/src/api/helpers/getObservableOfArraysNewItems.ts Outdated Show resolved Hide resolved

smartine-ledger reviewed Feb 6, 2025

View reviewed changes

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from b73908e to 7e67d8c Compare February 13, 2025 09:44

vercel bot deployed to Preview – device-sdk-ts-sample February 13, 2025 09:47 View deployment

vercel bot deployed to Preview – device-sdk-ts-sample February 13, 2025 10:27 View deployment

vercel bot deployed to Preview – device-sdk-ts-sample February 13, 2025 16:04 View deployment

vercel bot deployed to Preview – device-sdk-ts-sample February 14, 2025 11:14 View deployment

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 54f0d21 to 3e7c087 Compare February 14, 2025 15:06

vercel bot deployed to Preview – device-sdk-ts-sample February 14, 2025 15:10 View deployment

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 3e7c087 to 8e0b3aa Compare February 14, 2025 16:32

vercel bot deployed to Preview – device-sdk-ts-sample February 14, 2025 16:34 View deployment

ofreyssinet-ledger changed the base branch from develop to feat/dsdk-610-rn-mobile-ble February 14, 2025 16:43

github-actions bot assigned ofreyssinet-ledger Feb 14, 2025

jdabbech-ledger force-pushed the feat/dsdk-610-rn-mobile-ble branch from 31561a1 to 5c29afa Compare February 18, 2025 09:34

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 8e0b3aa to d8f5a1d Compare February 18, 2025 11:14

vercel bot had a problem deploying to Preview – device-sdk-ts-sample February 18, 2025 11:16 Failure

valpinkman force-pushed the feat/dsdk-610-rn-mobile-ble branch from 5c29afa to 817ad9c Compare February 19, 2025 09:10

jdabbech-ledger force-pushed the feat/dsdk-610-rn-mobile-ble branch 2 times, most recently from 9b1a744 to 9010ec3 Compare February 19, 2025 13:37

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from d8f5a1d to 53d3009 Compare February 19, 2025 17:15

vercel bot deployed to Preview – device-sdk-ts-sample February 19, 2025 17:30 View deployment

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 53d3009 to 8098d27 Compare February 20, 2025 09:03

vercel bot deployed to Preview – device-sdk-ts-sample February 20, 2025 09:04 View deployment

ofreyssinet-ledger commented Feb 20, 2025

View reviewed changes

...n/kotlin/com/ledger/devicesdk/shared/androidMain/transport/usb/DefaultAndroidUsbTransport.kt Outdated Show resolved Hide resolved

ofreyssinet-ledger commented Feb 20, 2025

View reviewed changes

...m/ledger/devicesdk/shared/androidMainInternal/transport/deviceconnection/DeviceApduSender.kt Outdated Show resolved Hide resolved

vercel bot deployed to Preview – device-sdk-ts-sample February 20, 2025 12:17 View deployment

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from ab624da to 55ffc70 Compare February 21, 2025 09:22

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 09:23 View deployment

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 10:21 View deployment

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from c58b34e to 28e1239 Compare February 21, 2025 10:58

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 10:59 View deployment

jdabbech-ledger and others added 15 commits February 21, 2025 12:19

📦️ (rn-hid): Setup transport rn-hid

b1cb1ab

✨ (rn-hid): DMK Mobile Transport HID + gradle setup

fde7cb7

✨ (rn-hid): Native Module & fully working Transport

8d5a0b3

✨ (mobile): AndroidManifest & build configuration

6d0f33f

🐛 (rn-hid): DefaultAndroidUsbTransport fix Disconnection

c705464

🐛 (rn-hid): DefaultAndroidUsbTransport fix first connection

4376652

♻️ (rn-hid): Cleanup Kotlin code

b7d9101

✨ (rn-hid): Device reconnections (State Machine)

a98a4f9

✨ (mobile): Add disconnect button & small improvements

ddb75f4

✨ (rn-hid): Support targeting Android 14

0d215dd

🔊 (rn-hid): Improve logs

fab1b1c

💚 (repo): Update pnpm lockfile

a1de6ba

⚰️ (rn-hid): PR feedback: remove dead code

fed84d7

♻️ (rn-hid): PR feedback: inject usbManager

f364795

♻️ (rn-hid): PR feedback: no android UsbDevice in UsbState (clean archi)

3ea2556

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 28e1239 to 096449b Compare February 21, 2025 11:20

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 11:20 View deployment

ofreyssinet-ledger added 3 commits February 21, 2025 12:29

💚 (rn-hid): Package "private" false

385c7ef

📝 (rn-hid): README.md

d821e27

🔖 (chore): Add changeset

5a34415

ofreyssinet-ledger force-pushed the feat/dsdk-611-rn-hid branch from 096449b to 5a34415 Compare February 21, 2025 11:29

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 11:30 View deployment

💚 (rn-hid): Add "./android" in "files"

bce3df6

vercel bot deployed to Preview – device-sdk-ts-sample February 21, 2025 11:56 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

✨ (rn-hid) [DSDK-611]: React Native HID transport #662

✨ (rn-hid) [DSDK-611]: React Native HID transport #662

ofreyssinet-ledger commented Feb 5, 2025 •

edited by jira bot

Loading

vercel bot commented Feb 5, 2025 •

edited

Loading

ofreyssinet-ledger Feb 5, 2025

smartine-ledger Feb 17, 2025

smartine-ledger left a comment

smartine-ledger Feb 5, 2025

ofreyssinet-ledger Feb 13, 2025

smartine-ledger Feb 5, 2025

smartine-ledger Feb 5, 2025

ofreyssinet-ledger Feb 13, 2025

ofreyssinet-ledger Feb 13, 2025

smartine-ledger Feb 17, 2025

smartine-ledger Feb 5, 2025

ofreyssinet-ledger Feb 13, 2025

smartine-ledger Feb 17, 2025

smartine-ledger Feb 6, 2025

ofreyssinet-ledger Feb 20, 2025

smartine-ledger Feb 6, 2025

ofreyssinet-ledger Feb 13, 2025

smartine-ledger Feb 17, 2025

ofreyssinet-ledger Feb 20, 2025

smartine-ledger Feb 6, 2025

ofreyssinet-ledger Feb 20, 2025

smartine-ledger Feb 20, 2025

smartine-ledger Feb 20, 2025

smartine-ledger Feb 6, 2025

ofreyssinet-ledger Feb 13, 2025

github-actions bot commented Feb 14, 2025 •

edited

Loading

✨ (rn-hid) [DSDK-611]: React Native HID transport #662

Are you sure you want to change the base?

✨ (rn-hid) [DSDK-611]: React Native HID transport #662

Conversation

ofreyssinet-ledger commented Feb 5, 2025 • edited by jira bot Loading

📝 Description

❓ Context

✅ Checklist

🧐 Checklist for the PR Reviewers

vercel bot commented Feb 5, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

smartine-ledger left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Feb 14, 2025 • edited Loading

ofreyssinet-ledger commented Feb 5, 2025 •

edited by jira bot

Loading

vercel bot commented Feb 5, 2025 •

edited

Loading

github-actions bot commented Feb 14, 2025 •

edited

Loading