@ledgerhq/speculos-web
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

speculos-web

A VNC/Websocket UI bridge to distant running Speculos devices

Usage

Register your transport:

import { registerTransportModule } from "@ledgerhq/live-common/lib/hw";
import { createSpeculosWebTransport } from "@ledgerhq/speculos-web";

registerTransportModule({
  id: "speculos-web",
  open: (id: string) => {
    if (id !== "speculos-web") return;
    return createSpeculosWebTransport();
  },
  disconnect: () => null,
});

Use the <SpeculosWeb /> component:

import { SpeculosWeb } from "@ledgerhq/speculos-web";

function MyApp() {
  return (
    <div>
      <SpeculosWeb
        baseDomain="speculos-server.com"
        blueAppVersion="5.2.1-dev-8.3.1-3d9ada4f"
        staxAppVersion="1.0.1"
      />
    </div>
  );
}

Readme

Keywords

none

Package Sidebar

Install

npm i @ledgerhq/speculos-web

Weekly Downloads

53

Version

2.0.0

License

BSD-2-Clause

Unpacked Size

1.11 MB

Total Files

49

Last publish

Collaborators

  • ledger-releaser
  • thomas.coudray
  • ldg-github-ci
  • aboissiere
  • vbouzon
  • gbrahm-ledger
  • sergii-shkolin
  • phenry-ledger