Skip to content

Commit

Permalink
Add some docs about the app sdk
Browse files Browse the repository at this point in the history
  • Loading branch information
bigspider committed Dec 17, 2024
1 parent 8e5bba1 commit 59733a7
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions app-sdk/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,15 @@
The `vanadium-app-sdk` crate is the V-app SDK. V-app are built using it.

It provides abstractions to the services provided via calls to the OS in the target platform (ECALLs).

Functionalities include:
- Communication primitives;
- BIP32 derivations, and the master key fingerprint;
- Big integers;
- Elliptic Curve points, private keys and pubkeys;
- Hash functions;
- UX functionality (TODO)

# Design principles

The public exports of this library try to keep an interface that is not directly tied to the underlying ecalls. This allows to abstract differences between targets, where some ECALLs might be unavailable or different, or simply unstable and subject to change.

0 comments on commit 59733a7

Please sign in to comment.