forked from Zondax/zemu
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README-npm
42 lines (29 loc) · 1.73 KB
/
README-npm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# Zemu
[](https://opensource.org/licenses/Apache-2.0)
[](https://badge.fury.io/js/%40zondax%2Fzemu)
[](https://github.com/Zondax/zemu/blob/main/.github/workflows/main.yml)
> **We appreciate any contributions to this effort!**
>
> We recommend using the npmjs package in order to receive updates/fixes.
**This project is under active development - API and usage guidelines are _very_ likely to change**
## Overview
Integration and end-to-end testing of Ledger Apps is a manual and time consuming process. We believe that the Ledger apps ecosystem is
lacking an adequate approach with respect to testing. The Zemu Framework is our solution for this problem. Under the hood, Zemu uses
Ledger's project [speculos](https://github.com/ledgerHQ/speculos). It's currently being used in every Ledger App built by Zondax, among many
others (such as Ethereum one built by Ledger team).
_Zemu is an emulation and testing framework for Ledger Nano S/S+/X devices._
## Features
- Minimal configuration + Docker based
- Speculos/Qemu based emulation
- Easy JS API
- Mocha / Jest compatible
- Parallelized testing
- Abstracted device control (buttons, reset, etc.)
- Navigate thru screens and take screenshots of them
- Debugging (support for CLion and vscode, even mixed C/Rust)
## Docs
Check our documentation and quickstart at https://docs.zondax.ch
# Who we are?
We are Zondax, a company pioneering blockchain services. If you want to know more about us, please visit us at
[zondax.ch](https://zondax.ch)