Skip to main content

Android SDK

The Privacy Boost Android SDK is a native Kotlin library that wraps the Rust core via UniFFI. It exposes idiomatic Kotlin APIs (suspend functions, sealed classes, data classes) for shielding, unshielding, and private transfers.

Features

  • Native Kotlin library — no JavaScript bridge, no WebView
  • suspend functions integrated with Kotlin coroutines
  • SdkException sealed class — exhaustive when matching on error variants
  • Optional default delegate implementations for Android Keystore and CredentialManager Passkey
  • Wallet-agnostic — implement WalletDelegate once for any signer
  • Identical core to the TypeScript / iOS / React Native SDKs (same proofs, same network protocol)

Installation

Add the Maven artifact to your build.gradle.kts. See the installation guide for full details.
Then import:

Quick Example

Core Operations

All operations are suspend functions — call them from a coroutine scope (lifecycleScope, viewModelScope, etc.).

Documentation

Getting Started

Guides

Advanced

Reference

Requirements

  • Android API 26+ (Android 8.0 Oreo)
  • API 34+ (Android 14) required for Passkey delegate helpers
  • Kotlin 1.9+
  • AndroidX