Skip to content

docs: document Ledger adapter stack and refresh package names#831

Draft
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/engineering-documentation-updates-3251
Draft

docs: document Ledger adapter stack and refresh package names#831
cursor[bot] wants to merge 1 commit into
onekeyfrom
cursor/engineering-documentation-updates-3251

Conversation

@cursor

@cursor cursor Bot commented Jul 6, 2026

Copy link
Copy Markdown

Summary

  • document the HWK Ledger adapter stack in the top-level package map and architecture overview
  • add a focused packages/hwk-ledger-adapter/README.md quickstart for connector selection, UI request handling, and troubleshooting
  • refresh the hd-transport-web-device package naming in docs to match current package names

Docs updated

  • README.md
  • docs/architecture.md
  • packages/hwk-ledger-adapter/README.md
  • packages/hd-transport-web-device/README.md

Codepaths covered

  • packages/hwk-ledger-adapter/src/adapter/LedgerAdapter.ts
  • packages/hwk-ledger-adapter/src/adapter/methods/allNetworkGetAddress.ts
  • packages/hwk-ledger-adapter/src/errors.ts
  • packages/hwk-ledger-adapter/src/index.ts
  • packages/hwk-ledger-connector-webhid/src/index.ts
  • packages/hwk-ledger-connector-ble/src/index.ts
  • packages/hwk-adapter-core/src/types/wallet.ts
  • packages/hwk-adapter-core/src/events/ui-request.ts

Knowledge gaps addressed

  • where the Ledger adapter stack fits relative to the existing hd-core SDK
  • which connector to use for WebHID vs React Native BLE
  • why hosts must answer uiResponse(...) events for permission, reconnect, and app-install flows
  • common integration pitfalls such as multiple USB devices, ephemeral connectId, and missing Ledger apps
Open in Web View Automation 

Co-authored-by: Leon <lixiao.dev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant