Setup

​

Prerequisites

Before you begin, make sure you have set up your Privy app and obtained your app ID and client ID from the Privy Dashboard.

​

Initializing Privy

Initialize a Privy instance with your application context and a PrivyConfig object:

private val privy: Privy =
   Privy.init(
       context = applicationContext, // be sure to only pass in Application context
       config = PrivyConfig(
           appId = "YOUR_APP_ID",
           appClientId = "YOUR_APP_CLIENT_ID",
           logLevel = PrivyLogLevel.VERBOSE
       )
   )

​

Configuration

The configuration fields for the PrivyConfig are:

​

Waiting for Privy to be ready

When the Privy SDK is initialized, the user’s authentication state will be set to NotReady until Privy finishes initialization. This might include checking if the user has a wallet connected, refreshing expired auth tokens, fetching up-to-date user data, and more.

It’s important to wait until Privy has finished initializing before you consume Privy’s state and interfaces, to ensure that the state you consume is accurate and not stale.

For your convenience, we’ve added a suspending awaitReady() function that you can use to wait for Privy to finish initializing:

// Launch a coroutine in order to await Privy's ready state
viewModelScope.launch {
  // Show loading UI
  uiState = .loading

  // Await ready
  privy.awaitReady()

  // Check if user is authenticated
  val isPrivyUserAuthenticated = privy.authState.value.isAuthenticated()

  // Show loaded UI accordingly
  uiState = .loaded(isPrivyUserAuthenticated)
}