Web3Auth iOS SDK

Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.

📖 Documentation

Checkout the official Web3Auth Documentation and SDK Reference to get started!

🔁 Migrating from v10 → v11

Auth v11 uses citadel session tokens (sessionId, accessToken, refreshToken, idToken) and Wallet Services v6.

This iOS release is 13.0.0 (next major after 12.x) and targets Auth v11.

Steps

1. Bump the dependency to 13.x:

   pod 'Web3Auth', '13.0.0'
   

   SPM: update the web3auth-swift-sdk package (requires session-manager-swift 7.0.1, torus-utils-swift 11.0.0, and fetch-node-details-swift 9.0.1).
2. Remove any MFALevel.DEFAULT usages. Use only OPTIONAL, MANDATORY, or NONE.
3. Stop hard-coding /v10 auth or dashboard URLs. Rely on SDK defaults from authBuildEnv (production / staging use /v11; testing stays unversioned).
4. Constructing Web3Auth(options:) already rehydrates the session via citadel (SFA falls back to session-service when citadel authorize fails).
5. Prefer getAccessToken() and getUserInfoAsync() when you need token-backed identity data. Use refreshSession() to re-authorize; logout() clears citadel tokens and invalidates the session-service row.
6. Optional whitelabel legal links:

   WhiteLabelData(
       appName: "My App",
       tncLink: "https://example.com/terms",
       privacyPolicy: "https://example.com/privacy"
   )

7. Re-test login, session restore, MFA, showWalletUI() / request(), and logout on staging and production.

Breaking notes

Area	Change
Session	Citadel tokens via AuthSessionManager (SFA still falls back to session-service)
Key reconstruction	torus-utils-swift 11.0.0 + fetch-node-details-swift 9.0.1 (SFA retrieveShares now sends recordId + authConnection)
Auth / dashboard URLs	/v11 (do not hard-code /v10)
Wallet Services	Host /v6; launch passes citadel sessionId + accessToken
MFA	MFALevel.DEFAULT removed
Login audit	/start b64Params include recordId and loginSource (web3auth-ios / web3auth-flutter)
Whitelabel	Optional tncLink, privacyPolicy
Project config	Fetched from dashboard public API by buildEnv

💡 Features

• Plug and Play, OAuth based Web3 Authentication Service
• Fully decentralized, non-custodial key infrastructure
• End to end Whitelabelable solution
• Threshold Cryptography based Key Reconstruction
• Multi Factor Authentication Setup & Recovery (Includes password, backup phrase, device factor editing/deletion etc)
• Support for WebAuthn & Passwordless Login
• Support for connecting to multiple wallets
• DApp Active Session Management

...and a lot more

⏪ Requirements

• iOS 14
• Xcode 12.x+
• Swift 5.x

⚡ Installation

SPM

If you are using the Swift Package Manager, open the following menu item in Xcode:

File > Swift Packages > Add Package Dependency...

In the Choose Package Repository prompt add this url:

https://github.com/web3auth/web3auth-swift-sdk

Cocoapods

If you are using cocoapods , open the pod file and add

pod 'Web3Auth', '13.0.0'

🌟 Configuration

Checkout SDK Reference to configure the iOS App.

Getting State

import Web3Auth

let web3auth = try Web3Auth(Web3AuthOptions(
  // Get your Web3Auth Client Id from dashboard.web3auth.io
  clientId: "YOUR_WEB3AUTH_CLIENT_ID",
  web3AuthNetwork: .sapphire_mainnet,
  redirectUrl: "bundleId://auth"
))

// Login
let result = try await web3Auth.login(LoginParams(loginProvider: .GOOGLE))

// Logout
try await web3auth.logout()

🩹 Examples

Checkout the examples for your preferred blockchain and platform in our examples

🌐 Demo

Checkout the Web3Auth Demo to see how Web3Auth can be used in an application.

Have a look at our Web3Auth PnP iOS Quick Start to help you quickly integrate a basic instance of Web3Auth Plug and Play in your iOS app.

Further checkout the demo folder within this repository, which contains a sample app.

💬 Troubleshooting and Support

• Have a look at our Community Portal to see if anyone has any questions or issues you might be having. Feel free to create new topics and we'll help you out as soon as possible.
• Checkout our Troubleshooting Documentation Page to know the common issues and solutions.
• For Priority Support, please have a look at our Pricing Page for the plan that suits your needs.