Skip to content

Readme update #34

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jakubretajczykBD wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Readme update #34

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## Overview

This app adds support for the Solana native token to Ledger Nano S hardware wallet.
This app adds support for the Solana native token to Ledger Nano S Plus (NanoSP) hardware wallet.

Current Features:
- Pubkey queries
Expand All @@ -28,17 +28,17 @@ $ docker pull ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
Build the app in the container. The BOLOS_SDK variable is used to specify the target SDK, allowing to compile the application for each Ledger device. See [Ledger Application Builder](https://github.com/LedgerHQ/ledger-app-builder?tab=readme-ov-file#compile-your-app-in-the-container) for more details.

```sh
# E.g. for Nano S
# E.g. for NanoSP
$ sudo docker run --rm -ti -v "$(realpath .):/app" --user $(id -u $USER):$(id -g $USER) ghcr.io/ledgerhq/ledger-app-builder//ledger-app-dev-tools:latest
bash$ BOLOS_SDK=$NANOS_SDK make
bash$ BOLOS_SDK=$NANOSP_SDK make
```

### Clean

Within the running development container

```sh
bash$ BOLOS_SDK=$NANOS_SDK make clean
bash$ BOLOS_SDK=$NANOSP_SDK make clean
```

## Working with the device
Expand All @@ -49,15 +49,15 @@ See [Ledger Application Builder](https://github.com/LedgerHQ/ledger-app-builder?

```bash
$ sudo docker run --rm -ti -v "$(realpath .):/app" --privileged -v "/dev/bus/usb:/dev/bus/usb" --user $(id -u $USER):$(id -g $USER) ghcr.io/ledgerhq/ledger-app-builder/ledger-app-dev-tools:latest
bash$ BOLOS_SDK=$NANOS_SDK make load
bash$ BOLOS_SDK=$NANOSP_SDK make load
```

### Delete

Within the running development container

```sh
bash$ BOLOS_SDK=$NANOS_SDK make delete
bash$ BOLOS_SDK=$NANOSP_SDK make delete
```

## Test
Expand All @@ -80,8 +80,8 @@ Run Ragger tests:
# Install python test suite dependencies
bash$ pip install -r "tests/python/requirements.txt"

# Run test suite for the specific device, e.g. nanos
bash$ pytest tests/python/ --tb=short -v --device nanos -k ""
# Run test suite for the specific device, e.g. nanosp
bash$ pytest tests/python/ --tb=short -v --device nanosp -k ""
```

To regenerate golden snapshots, use `--golden_run` option.
Expand Down