Repository files navigation

bolos-rs is a 3rd party (experimental) BOLOS SDK written in Rust for developing applications for the Ledger hardware security devices. At this time, it is primarily a research project that explores what benefits a Rust based SDK can bring to the Ledger developer experience.

Check outdemos/ folder for instructions on how to build this code.

While developing Ledger applications with theofficial Ledger C SDK, I saw and experienced quite a few ways to shoot oneself painfully in the foot. I got to thinking several times how a more powerful type system (like the one Rust features) could be used to model APIs in a way that would protect the users. And some time later I found myself scratching that itch.

The overall direction forbolos-rs is to create a superior developer experience than that of the official C SDK.

• Quick and easy development environment setup by relying on the Rust infrastructure
• Application code should be 100% safe Rust
• Opinionated APIs that enforce (or nudge towards) safety

It is not possible to build anything useful currently. APIs will have a lot of breaking changes, there is no documentation nor tests. In short - you shouldn't use it.

What works:

• Rendering of user interfaces

What doesn't work:

• Communicating with the host computer via USB
• Communicating with the browser via U2F
• Invoking various cryptography related fuctions from the firmware
• (and many other smaller things)

This code is intentionally without a license. I haven't decided on the license yet, so you may not use this code in any way. If you do, however, happen to read through it and want to give some feedback, then pleaseopen an issue.