Migration Guide from v7 to v8 for Web3Auth PnP iOS SDK

Overview

This migration guide provides steps for upgrading from version 7(v7) to version 8(v8) of the Web3Auth PnP iOS SDK. The guide outlines significant changes and enhancements, including the introduction of enableMFA method to initiate MFA setup flow, request method for transaction confirmation screens, and launchWalletServices method for template wallet interface.

Changes in Detail

enableMFA method

From v8, developers can now use the enableMFA method to initiate MFA setup flow for already logged in users.

Default Verifier

Usage

do {
	let isMFAEnabled = try await self.web3Auth.enableMFA()
} catch {
	print(error.localizedDescription)
	// Handle Error
}

Custom JWT Verifier

Usage

do {
	let loginParams = W3ALoginParams(
		.JWT,
		extraLoginOptions: .init(id_token: "your_jwt_token")
  	)

    let isMFAEnabled = try await self.web3Auth.enableMFA(loginParams)

} catch {
  print(error.localizedDescription)
  // Handle Error
}

launchWalletServices method

From v8, developers can use the launchWalletServices to launches a WebView which allows them to use the templated wallet UI services. Developers can pass the ChainConfig in W3AInitParams to open wallet services with a specific chain selected.

note

Access to Wallet Services is gated. You can use this feature in sapphire_devnet for free. The minimum pricing plan to use this feature in a production environment is the Scale Plan.

ChainConfig Arguments

Parameter	Description
chainNamespace	Custom configuration for your preferred blockchain. As of now only EVM supported. Default value is ChainNamespace.eip155.
decimals?	Number of decimals for the currency ticker. Default value is 18, and accepts int as value.
blockExplorerUrl?	Blockchain's explorer URL. (eg: https://etherscan.io)
chainId	The chain id of the selected blockchain in hex String.
displayName?	Display Name for the chain.
logo?	Logo for the selected chainNamespace & chainId.
rpcTarget	RPC Target URL for the selected chainNamespace & chainId.
ticker?	Default currency ticker of the network (e.g: ETH)
tickerName?	Name for currency ticker (e.g: Ethereum)

Usage

Usage

do {
  var chainConfig = ChainConfig(
    chainNamespace: ChainNamespace.eip155,
    chainId: "0x1",
    rpcTarget: "https://mainnet.infura.io/v3/${key}",
    ticker: "ETH"
  )

  val web3Auth = await Web3Auth(.init(
    clientId: clientID,
    network: network,
    buildEnv: buildEnv,
    chainConfig: chainConfig
  ))

  try await web3Auth?.launchWalletServices(
    W3ALoginParams(loginProvider: .GOOGLE),
  )
} catch {
  // Handle error
}

request method

Now, developers can use the request method to use the templated transaction confirmation screens for signing transactions. To retrive the signature for the request, developers can use the getSignResponse static method.

Usage

var params = [Any]()
params.append("Hello, Web3Auth from Android!")
params.append("0x764dd67c0420b43a39ab337463d8995622f226a2")
params.append("Web3Auth")

do {
  try await self.web3Auth?.request(
    W3ALoginParams(loginProvider: .GOOGLE, mfaLevel: .NONE),
    method: "personal_sign",
    requestParams: params
  )
} catch {
  // Handle error
}