1 unstable release
0.2.1 | Sep 25, 2023 |
---|
#147 in #ledger
Used in nanos_ui
2.5MB
57K
SLoC
Ledger wallets SDK for Rust Applications
Crate that allows developing Ledger Nano apps in Rust with a default configuration.
Contains:
- low-level pre-generated bindings to the C SDK version 2.0
- some safe wrappers over common syscalls
- IO abstractions
- signature abstractions
This SDK is incomplete in the sense that wrappers are currently missing, and not all wrappers have a nice Rust abstraction on top, but two apps were made using it:
You can submit an issue or even a pull request if you wish to contribute, we will check what we can do.
Supported devices
Nano S | Nano X | Nano S Plus |
---|---|---|
✔️ | ✔️ | ✔️ |
Usage
Building requires adding rust-src
to your Rust installation, and both Clang and arm-none-eabi-gcc.
On Ubuntu, gcc-multilib
might also be required.
Using rustc nightly builds is mandatory as some unstable features are required.
rustup default nightly
rustup component add rust-src
- install Clang.
- install an ARM gcc toolchain
If you wish to install the ARM gcc toolchain using your distribution's packages, these commands should work:
# On Debian and Ubuntu
sudo apt install clang gcc-arm-none-eabi gcc-multilib
# On Fedora or Red Hat Entreprise Linux
sudo dnf install clang arm-none-eabi-gcc arm-none-eabi-newlib
# On ArchLinux
sudo pacman -S clang arm-none-eabi-gcc arm-none-eabi-newlib
This SDK provides three custom target files for Nano S, Nano X and Nano S+.
Building for Nano S
cargo build --release -Z build-std=core --target=./nanos.json
Building for Nano X
cargo build --release -Z build-std=core --target=./nanox.json
Building for Nano S+
cargo build --release -Z build-std=core --target=./nanosplus.json
Building with rustc < 1.54
Building before rustc 1.54 should fail with error[E0635]: unknown feature const_fn_trait_bound
.
This is solved by activating a specific feature: cargo build --features pre1_54
Contributing
Make sure you've followed the installation steps above. In order for your PR to be accepted, it will have to pass the CI, which performs the following checks:
- Check if the code builds on nightly
- Check that
clippy
does not emit any warnings - check that your code follows
rustfmt
's format (usingcargo fmt
)