Package Exports

@emurgo/ledger-connect-handler

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@emurgo/ledger-connect-handler) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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:

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

Supported Functions

getExtendedPublicKey

Inputs

{
  serial: ?string,
  params: {
    path: BIP32Path
  },
}

Outputs

{
  deriveSerial: {
    serial: string
  },
  deviceVersion: {
    flags: Flags,
    major: string,
    minor: string,
    patch: string
  },
  response: {
    chainCodeHex: string,
    publicKeyHex: string
  }
}

signTransaction

Inputs

{
  serial: ?string,
  params: {
    networkId: number,
    protocolMagic: number,
    inputs: Array<InputTypeUTxO>,
    outputs: Array<OutputTypeAddress | OutputTypeAddressParams>,
    feeStr: string,
    ttlStr: string,
    certificates: Array<Certificate>,
    withdrawals: Array<Withdrawal>,
    metadataHashHex: ?string
  },
}

Outputs

{
  txHashHex: string,
  witnesses: Array<Witness>
}

showAddress

Inputs

{|
  serial: ?string,
  params: {
    address: string,
    addressTypeNibble: $Values<typeof AddressTypeNibbles>,
    networkIdOrProtocolMagic: number,
    spendingPath: BIP32Path,
    stakingPath: ?BIP32Path,
    stakingKeyHashHex: ?string,
    stakingBlockchainPointer: ?StakingBlockchainPointer
  },
|}

Outputs

undefined

deriveAddress

Inputs

{
  serial: ?string,
  params: {
    addressTypeNibble: $Values<typeof AddressTypeNibbles>,
    networkIdOrProtocolMagic: number,
    spendingPath: BIP32Path,
    stakingPath: ?BIP32Path,
    stakingKeyHashHex: ?string,
    stakingBlockchainPointer: ?StakingBlockchainPointer,
  },
}

Outputs

{
  addressHex: string
}

getVersion

Inputs

{
  serial: ?string,
  params: undefined,
}

Outputs

{
  flags: Flags,
  major: string,
  minor: string,
  patch: string
}

getSerial

Inputs

{
  serial: ?string,
  params: undefined,
}

Outputs

{
  serial: string
}

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

@ledgerhq/hw-transport-webauthn [Default]
@ledgerhq/hw-transport-u2f
- Has issues on Windows 10 Version: >= 1903. Refer.
@ledgerhq/hw-transport-webusb [Incomplete]
- Firefox does not supports WebUSB.
- Needs udev rules(on Linux) or drivers(on Windows) to be pre-installed. Refer WebUSB section.

Building up

nvm i
yarn
yarn run build

Publishing

Make sure you have followed Building up steps before publishing.

npm publish