Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosmos/ledger-cosmos
https://github.com/cosmos/ledger-cosmos
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/cosmos/ledger-cosmos
- Owner: cosmos
- License: apache-2.0
- Created: 2018-10-02T13:02:03.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-07-24T13:57:57.000Z (about 2 months ago)
- Last Synced: 2024-07-24T17:24:48.668Z (about 2 months ago)
- Language: C
- Size: 19.1 MB
- Stars: 52
- Watchers: 19
- Forks: 109
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-ccamel - cosmos/ledger-cosmos - (C)
README
# Ledger Cosmos app
[](https://opensource.org/licenses/Apache-2.0)
[](https://github.com/cosmos/ledger-cosmos/blob/main/.github/workflows/main.yaml)
---
_Please visit our website at [zondax.ch](zondax.ch)_
You can also visit [Zondax Hub](https://hub.zondax.ch/cosmos) to test any of the versions of the app
---
This project contains the Cosmos app for Ledger Nano S, Nano S+, X and Stax.
- Ledger Nano S/S+/X/Stax Cosmos app
- Specs / Documentation
- C++ unit tests
- Zemu tests
## ATTENTION
Please:
- **Do not use in production**
- **Do not use a Ledger device with funds for development purposes.**
- **Have a separate and marked device that is used ONLY for development and testing**
Tip:
- In releases, you will find a precompiled test app. If you are just curious, you can run `zxtool.sh` and avoid building.
## Download and install a prerelease
*Once the app is approved by Ledger, it will be available in their app store (Ledger Live).
You can get builds generated by CircleCI from the release tab. THESE ARE UNVETTED DEVELOPMENT RELEASES*
Download a release from here (https://github.com/Zondax/ledger-cosmos/releases). You only need `zxtool.sh`
If the file is not executable, run
```sh
chmod +x ./zxtool.sh
```
then run:
```sh
./installer_s.sh load
```
# Development
## Preconditions
- Be sure you checkout submodules too:
```
git submodule update --init --recursive
```
- Install Docker CE
- Instructions can be found here: https://docs.docker.com/install/
- We only officially support Ubuntu. Install the following packages:
```
sudo apt update && apt-get -y install build-essential git wget cmake \
libssl-dev libgmp-dev autoconf libtool
```
- Install `node > v13.0`. We typically recommend using `n`
- You will need python 3 and then run
- `make deps`
- This project requires Ledger firmware 2.0
- The current repository keeps track of Ledger's SDK but it is possible to override it by changing the git submodule.
*Warning*: Some IDEs may not use the same python interpreter or virtual enviroment as the one you used when running `pip`.
If you see conan is not found, check that you installed the package in the same interpreter as the one that launches `cmake`.
## How to build ?
> We like clion or vscode but let's have some reproducible command line steps
>
- Building the app itself
If you installed the what is described above, just run:
```bash
make
```
## Running tests
- Running rust tests (x64)
If you installed the what is described above, just run:
```bash
make rust_test
```
- Running C/C++ tests (x64)
If you installed the what is described above, just run:
```bash
make cpp_test
```
- Running device emulation+integration tests!!
```bash
Use Zemu! Explained below!
```
## How to test with Zemu?
> What is Zemu?? Great you asked!!
> As part of this project, we are making public a beta version of our internal testing+emulation framework for Ledger apps.
>
> Npm Package here: https://www.npmjs.com/package/@zondax/zemu
>
> Repo here: https://github.com/Zondax/zemu
Let's go! First install everything:
> At this moment, if you change the app you will need to run `make` before running the test again.
```bash
make zemu_install
```
Then you can run JS tests:
```bash
make zemu_test
```
To run a single specific test:
> At the moment, the recommendation is to run from the IDE. Remember to run `make` if you change the app.
## Using a real device
### How to prepare your DEVELOPMENT! device:
> You can use an emulated device for development. This is only required if you are using a physical device
>
> **Please do not use a Ledger device with funds for development purposes.**
>>
> **Have a separate and marked device that is used ONLY for development and testing**
There are a few additional steps that increase reproducibility and simplify development:
**1 - Ensure your device works in your OS**
- In Linux hosts it might be necessary to adjust udev rules, etc.
Refer to Ledger documentation: https://support.ledger.com/hc/en-us/articles/115005165269-Fix-connection-issues
**2 - Set a test mnemonic**
Many of our integration tests expect the device to be configured with a known test mnemonic.
- Plug your device while pressing the right button
- Your device will show "Recovery" in the screen
- Double click
- Run `make dev_init`. This will take about 2 minutes. The device will be initialized to:
```
PIN: 5555
Mnemonic: equip will roof matter pink blind book anxiety banner elbow sun young
```
**3 - Add a development certificate**
- Plug your device while pressing the right button
- Your device will show "Recovery" in the screen
- Click both buttons at the same time
- Enter your pin if necessary
- Run `make dev_ca`. The device will receive a development certificate to avoid constant manual confirmations.
### Loading into your development device
The Makefile will build the firmware in a docker container and leave the binary in the correct directory.
- Build
```
make # Builds the app
```
- Upload to a device
The following command will upload the application to the ledger. _Warning: The application will be deleted before uploading._
```
make load # Builds and loads the app to the device
```
## APDU Specifications
### DISCLAIMER
Ledger NanoS does not support Cosmos Textual Mode due to memory restriction
- [APDU Protocol](docs/APDUSPEC.md)
- [Transaction format](docs/TXSPEC.md)