Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

yoroi-extension-ledger-connect-handler

2.0.4 • Public • Published

yoroi-extension-ledger-connect-handler

This library enables Yoroi extension to communicate with Ledger device, in process this library needs one web page that directly communicates with Ledger device. This library is responsible for opening, sendind resquest, passing back response to Yoroi and closing the target web page.

Message Passing

ledger-content-script

Flow:

  1. Yoroi requests yoroi-extension-ledger-connect-handler(Using function call).
  2. yoroi-extension-ledger-connect-handler opens target Website.
  3. yoroi-extension-ledger-connect-handler sends request message to content-script(Using extension port).
  4. content-script passes request to the target Website app(Using postMessage()).
  5. Target Website app processes the request and send response to content-script(Using postMessage()).
  6. content-script passes response to yoroi-extension-ledger-connect-handler(Using extension port).
  7. Finally, yoroi-extension-ledger-connect-handler passes response to Yoroi(Using function return).

Supported Functions

Example

Import

import LedgerConnect from 'yoroi-extension-ledger-connect-handler';

Create new instance


const ledgerConnect = new LedgerConnect(config);

config is type of: Config

Calling function

const deviceVersionResp = await ledgerConnect.getVersion();

Supported Ledger Transport

Building up

  • nvm i
  • yarn
  • yarn run build

Publishing

Make sure you have followed Building up steps before publishing.

  • npm publish

Install

npm i yoroi-extension-ledger-connect-handler

DownloadsWeekly Downloads

1

Version

2.0.4

License

MIT

Unpacked Size

33 kB

Total Files

13

Last publish

Collaborators

  • avatar