@zondax/zemu

Zemu

This package is part of our Ledger development and integration testing process. It allows full device/app mocking.

QuickStart:
Zemu class provides access and control to your emulated Ledger app running on a docker container.

Basic testing code:

jest.setTimeout(20000);

test("demo", async () => {
    //Create Zemu object. Pass the path to your .elf file
    const sim = new Zemu("/ledger-demo/app/bin/");
    //Create an instance of your Ledger-js app
  try {
    const demoJSApp = new DemoApp(sim.getTransport());
    //Start simulator. A new docker container instance will be created.
    await sim.start();
    //Do your tests
    ...
    //Finally, close the simulator. This will stop and remove the container.
  } finally {
    await sim.close();
  }
});

Basic control commands examples:

• Take a screenshot and save it:
  await sim.snapshot("tests/snapshots/0.png")

• Send "click left":
  await sim.clickLeft()

• Send "click right":
  await sim.clickRight()

• Send "click both":
  await sim.clickBoth()

• Wait some time:
  await Zemu.sleep(500) //Time in [ms]

We recommend using the npmjs package in order to receive updates/fixes.

We appreciate any contributions to this effort!