Swift Quickstart

Requirements

The Privy Swift SDK requires iOS 16 or higher.

Installation

Install the Privy Swift SDK via the Swift Package Manager.

In Xcode, navigate to File > Add Package Dependencies.

In the "Search or Enter Package URL" search box enter this URL:

https://github.com/privy-io/privy-ios

TIP

Before integrating, you must register your allowed application IDs in the Privy Developer Dashboard, under App Settings > Clients.

Initialization

First, import the Privy SDK by adding on top of the file.

import PrivySDK

Initialize a Privy instance with PrivyConfig object.

The configuration fields for the PrivyConfig are:

Field	Type	Required?	Description
appId	String	Yes	Your Privy application ID, which can be obtained from the Privy Developer Dashboard, under Configuration > App Settings > Basics
appClientId	String	Yes	Your app client ID, which can be obtained from the Privy Developer Dashboard, under App Settings > Configuration > Clients
loggingConfig	PrivyLoggingConfig?	No	(Optional) Your preferred log level and logging method. If no log level is specified, it will default to PrivyLogLevel.NONE.
customAuthConfig	LoginWithCustomAuthConfig?	No	(Optional) Only use this if you plan to use custom authentication. Find more information here.

let config = PrivyConfig(
    appId: "YOUR_APP_ID",
    appClientId: "YOUR_APP_CLIENT_ID",
    loggingConfig: .init(
        logLevel: .verbose
    )
)

let privy: Privy = PrivySdk.initialize(config: config)

TIP

Be sure to maintain a single instance of Privy across the lifetime of your application. Initializing multiple instances of Privy will result in unexpected errors.

Await Ready

When the Privy SDK is initialized, the user's authentication state will be set to NotReady until Privy finishes initialization. During this time, we suggest you show a loading state to your user. For you convenience, we've added an async awaitReady() function. Here's an example with some pseudocode:

private func awaitPrivySDKReady() {
    Task {
        // Show loading UI

        // Await privy ready
        await privy.awaitReady()

        print("Privy SDK is ready!")

        // Check user auth state
        if case .authenticated(let privyUser) = privy.authState {
            // User is authenticated
        } else {
            // User is not authenticated
        }
    }
}

INFO

Call awaitReady() to suspend execution until Privy is ready.

That's it! You can now use the Privy SDK to securely authenticate and provision embedded wallets for your users. 🎉