WalletKit

WalletKit lets apps hold World ID credentials and prove things about their holder with World ID. It is part of the World ID SDK.

WalletKit is written in Rust. Apps use it in one of these forms:

• Rust: the walletkit crate.
• iOS: Swift bindings, generated with UniFFI.
• Android: Kotlin bindings, generated with UniFFI.
• Browser: the @worldcoin/walletkit-web npm package, which runs WalletKit as WebAssembly in a Web Worker.

All forms share the same core, walletkit-core, and expose the same objects, such as Authenticator and CredentialStore. The browser package omits a few of them; see Browser limitations.

Find what you need

• To add WalletKit to an app, see Install WalletKit.
• To learn how an account is registered and how credentials are stored, see Accounts and credentials.
• To answer a relying party’s proof request, see Generate a proof.
• To change WalletKit, see Develop WalletKit.
• To publish a release, see Release WalletKit.
• For the API reference of the Rust crates, see walletkit on docs.rs.

To preview this book locally, run the following command from the repository root and open the URL that it prints:

nix develop .#docs --command mdbook serve