Swift SDK API Reference

The Para Swift SDK provides a comprehensive toolkit for integrating non-custodial wallet functionality, passkey-based authentication, and blockchain interactions into your native iOS applications.

ParaManager Class

The ParaManager class is the central component for managing user authentication, wallet operations, and session state.

Properties

wallets

[Wallet]

An array of Wallet objects currently associated with the authenticated user. This list is updated after operations like fetchWallets() or createWallet().

sessionState

ParaSessionState

The current session state of the Para SDK (e.g., .unknown, .inactive, .active, .activeLoggedIn).

environment

ParaEnvironment

The environment configuration for the Para SDK (e.g., .beta, .prod).

apiKey

String

The API key used for authenticating with Para services.

isReady

Bool

Indicates if the ParaManager and its underlying WebView are initialized and ready to process requests.

Initialization

init(environment:apiKey:appScheme:)

Function

Initializes a new ParaManager instance.

Hide Parameters

environment

ParaEnvironment

The Para environment to use (e.g., .beta, .prod).

apiKey

String

Your Para API key.

appScheme

String?

Optional. Your app’s custom URL scheme (e.g., “yourapp://”). Defaults to the app’s bundle identifier. Used for OAuth and other redirection flows.

Authentication Methods

initiateAuthFlow(auth:)

Function

Starts the authentication (signup or login) process for a user with the specified email or phone number.

Hide Parameters

auth

Auth

The authentication identifier: .email(String) for email or .phone(String) for a full phone number (e.g., “+15551234567”).

Hide Returns

authState

AuthState

An AuthState object indicating the next step in the flow (e.g., .verify for new users, .login for existing users).

handleVerificationCode(verificationCode:)

Function

Submits the verification code (OTP) received by the user via email or SMS.

Hide Parameters

verificationCode

String

The verification code entered by the user.

Hide Returns

authState

AuthState

An AuthState object, typically with stage == .signup, indicating the user is verified and needs to choose a signup method (passkey or password).

resendVerificationCode()

Function

Requests a new verification code to be sent to the user’s email or phone.

Checks if a specific signup method (passkey or password) is available based on the current AuthState.

Hide Parameters

method

SignupMethod

The signup method to check (e.g., .passkey).

authState

AuthState

The current AuthState (should have stage == .signup).

Hide Returns

isAvailable

Bool

true if the method is available, false otherwise.

Completes the signup process for a new, verified user using the chosen method (passkey or password). This typically includes creating a passkey/password and the first wallet.

Hide Parameters

authState

AuthState

The current AuthState (must have stage == .signup).

method

SignupMethod

The chosen signup method (.passkey or .password).

authorizationController

AuthorizationController

An ASAuthorizationController instance for handling Passkey UI operations.

webAuthenticationSession

WebAuthenticationSession

A WebAuthenticationSession conforming object for handling web-based authentication (e.g., password setup).

Checks if a specific login method (passkey or password) is available for an existing user.

Hide Parameters

method

LoginMethod

The login method to check (e.g., .passkey).

authState

AuthState

The current AuthState (should have stage == .login).

Hide Returns

isAvailable

Bool

true if the method is available, false otherwise.

Logs in an existing user, automatically determining and using the preferred available method (passkey or password).

Hide Parameters

authState

AuthState

The current AuthState (must have stage == .login).

authorizationController

AuthorizationController

An ASAuthorizationController instance for Passkey UI.

webAuthenticationSession

WebAuthenticationSession

A WebAuthenticationSession for web-based login (e.g., password).

Logs in a user directly using their passkey.

Hide Parameters

authorizationController

AuthorizationController

An ASAuthorizationController instance for Passkey UI.

String?

Optional. The user’s email if known, to help filter passkeys.

phone

String?

Optional. The user’s full phone number if known, to help filter passkeys. If both email and phone are nil, the system prompts for any available passkey.

generatePasskey(identifier:biometricsId:authorizationController:)

Function

Generates and registers a new passkey for the user. Typically called during signup when authState.stage == .signup and SignupMethod.passkey is chosen.

Hide Parameters

identifier

String

The user’s identifier (email or full phone number).

biometricsId

String

The passkeyId obtained from AuthState.passkeyId when authState.stage == .signup.

authorizationController

AuthorizationController

An ASAuthorizationController instance for Passkey UI.

presentPasswordUrl(_ url:webAuthenticationSession:)

Function

Presents a web URL (typically for password setup/login) using a web authentication session.

Hide Parameters

url

String

The URL to present (e.g., authState.passwordUrl).

webAuthenticationSession

WebAuthenticationSession

A WebAuthenticationSession conforming object.

Hide Returns

callbackURL

URL?

The callback URL if authentication was successful via direct callback, or nil on failure/cancellation.

handleOAuth(provider:webAuthenticationSession:authorizationController:)

Function

Initiates and handles the entire OAuth flow with the specified provider (e.g., Google, Apple, Discord). This includes user authentication with the provider, Para account lookup/creation, and passkey setup if it’s a new Para user.

Hide Parameters

provider

OAuthProvider

The OAuth provider to use (e.g., .google).

webAuthenticationSession

WebAuthenticationSession

A WebAuthenticationSession for handling the OAuth web flow.

authorizationController

AuthorizationController

An ASAuthorizationController for potential passkey setup.

Hide Returns

result

Void

Returns nothing on success. Throws ParaError or other authentication-related errors on failure.

Logs into Para using an externally managed wallet (e.g., MetaMask).

Hide Parameters

wallet

ExternalWalletInfo

Information about the external wallet, including its address and type.

Session Management Methods

isFullyLoggedIn()

Function

Checks if there is an active session and the user is fully authenticated (e.g., passkey/password set up).

Hide Returns

isLoggedIn

Bool

true if the user is fully logged in, false otherwise.

isSessionActive()

Function

Checks if there is any active session with Para, even if the user is not fully logged in (e.g., pending verification).

Hide Returns

isActive

Bool

true if there is any active session, false otherwise.

exportSession()

Function

Exports the current session for backup or transfer purposes.

Hide Returns

sessionData

String

The session data as a string that can be saved and restored later.

logout()

Function

Logs out the current user and clears all session data.

getCurrentUserAuthDetails()

Function

Gets the current user’s persisted authentication details.

Hide Returns

authState

AuthState?

The current user’s authentication state, or nil if no user is authenticated. The ‘stage’ will be set to ‘login’ for active sessions.

checkSessionState()

Function

Manually checks and updates the current session state. This method waits for the Para WebView to be ready and updates the session state accordingly.

Wallet Management Methods

fetchWallets()

Function

Retrieves all wallets associated with the current user.

Hide Returns

wallets

[Wallet]

An array of Wallet objects associated with the user.

createWallet(type:skipDistributable:)

Function

Creates a new wallet for the authenticated user. This method initiates wallet creation and refreshes the internal wallets list. Observe the paraManager.wallets property for the new wallet.

Hide Parameters

type

WalletType

The type of wallet to create (e.g., .evm, .solana, .cosmos).

skipDistributable

Bool

Whether to skip the distributable key generation step.

getEmail()

Function

Retrieves the email of the currently authenticated user, if available and the session was initiated with an email.

Hide Returns

String

The user’s email address.

(Advanced) Distributes a new share for an existing wallet.

Hide Parameters

walletId

String

The ID of the wallet.

The user share to distribute.

getBalance(walletId:token:rpcUrl:chainPrefix:denom:)

Function

Gets the balance for any wallet type. This unified method works with all wallet types (EVM, Solana, Cosmos).

Hide Parameters

walletId

String

The ID of the wallet.

token

String?

Optional token identifier (contract address for EVM, mint address for Solana, etc.).

rpcUrl

String?

Optional RPC URL (recommended for Solana and Cosmos to avoid 403/CORS issues).

chainPrefix

String?

Optional bech32 prefix for Cosmos (e.g., “juno”, “stars”).

denom

String?

Optional denom for Cosmos balances (e.g., “ujuno”, “ustars”).

Hide Returns

balance

String

The balance as a string (format depends on the chain).

synchronizeRequiredWallets()

Function

Synchronizes required wallets by creating any missing non-optional wallet types. This should be called after successful authentication for new users.

Hide Returns

wallets

[Wallet]

Array of newly created wallets, if any.

Transfer Methods

transfer(walletId:to:amount:chainId:rpcUrl:)

Function

Transfers tokens using an EVM wallet. This method builds, signs, and broadcasts the transaction in one call.

Hide Parameters

walletId

String

The ID of the EVM wallet to use for the transfer.

String

The recipient address.

amount

String

The amount to send in wei (smallest unit).

chainId

String?

Optional. The chain ID for the EVM network. If not provided, uses the wallet’s default chain.

rpcUrl

String?

Optional. Custom RPC URL for the transaction. If not provided, uses the default RPC for the chain.

Hide Returns

result

TransferResult

A TransferResult object containing transaction details.

Hide Note

This method is only available for EVM wallets. Solana and Cosmos wallets must use signing methods only.

Signing Methods

signMessage(walletId:message:timeoutMs:)

Function

Signs an arbitrary message using the specified wallet.

Hide Parameters

walletId

String

The ID of the wallet to use for signing.

message

String

The raw message string to sign. The SDK will Base64-encode this string before signing.

timeoutMs

Int?

Optional. Timeout for the signing operation in milliseconds.

Hide Returns

result

SignatureResult

A SignatureResult object containing the signature and metadata.

signTransaction(walletId:transaction:timeoutMs:)

Function

Signs a transaction object using the specified wallet. The method accepts any Encodable transaction type (EVMTransaction, SolanaTransaction, CosmosTransaction) and handles chain-specific formatting internally.

Hide Parameters

walletId

String

The ID of the wallet to use for signing.

transaction

Encodable

The transaction object to sign. Can be EVMTransaction, SolanaTransaction, or CosmosTransaction.

timeoutMs

Int?

Optional. Timeout for the signing operation in milliseconds.

Hide Returns

signedTransaction

String

The signed transaction as a hex string for EVM transactions or base64 for other chains.

signTransaction(walletId:rlpEncodedTx:chainId:timeoutMs:)

Function

Signs an RLP-encoded EVM transaction string using the private key of the specified wallet. This method is maintained for backward compatibility.

Hide Parameters

walletId

String

The ID of the EVM wallet to use for signing.

rlpEncodedTx

String

The RLP-encoded transaction as a hex string. The SDK will Base64-encode this string.

chainId

String

The chain ID of the EVM network.

timeoutMs

Int?

Optional. Timeout for the signing operation in milliseconds.

Hide Returns

signature

String

The resulting transaction signature as a hex string.

Two-Factor Authentication (2FA) Methods

setup2fa()

Function

Initiates the setup process for 2FA.

Hide Returns

response

TwoFactorSetupResponse

Returns .alreadySetup if 2FA is already configured, or .needsSetup(uri: String) containing the URI to be displayed in an authenticator app (e.g., as a QR code).

enable2fa(verificationCode:)

Function

Enables 2FA for the user after they have scanned the URI and entered the code from their authenticator app.

Hide Parameters

verificationCode

String

The 2FA code from the user’s authenticator app.

MetaMaskConnector Class

The MetaMaskConnector class enables integration with MetaMask wallet for external wallet operations and authentication.

Properties

isConnected

Bool

Indicates whether the connector is currently connected to MetaMask.

accounts

[String]

Array of connected MetaMask account addresses.

chainId

String?

The current chain ID from MetaMask (e.g., “0x1” for Ethereum mainnet, “0xaa36a7” for Sepolia).

Initialization

init(para:appUrl:config:)

Function

Initializes a new MetaMaskConnector instance.

Hide Parameters

para

ParaManager

The ParaManager instance.

appUrl

String

Your app’s URL scheme for deep link callbacks.

config

MetaMaskConfig

Configuration object containing app metadata.

Methods

handleURL(_:)

Function

Processes incoming deep link URLs from MetaMask responses.

Hide Parameters

url

URL

The incoming URL to process.

connect()

Function

Initiates connection to MetaMask and requests account access. This method is async throws. Upon successful connection, the accounts, chainId, and isConnected properties of the MetaMaskConnector instance are updated. ParaManager.loginExternalWallet is also called internally.

signMessage(_:account:)

Function

Requests MetaMask to sign a message with the specified account.

Hide Parameters

message

String

The message string to be signed.

account

String

The account address to use for signing.

Hide Returns

signature

String

The resulting signature from MetaMask.

sendTransaction(_:account:)

Function

Sends a transaction through MetaMask using the specified account.

Hide Parameters

transaction

EVMTransaction or [String: String]

The transaction object or dictionary containing transaction parameters.

account

String

The account address to use for the transaction.

Hide Returns

transactionHash

String

The transaction hash returned by MetaMask.

Error Types

ParaError

Error

The main error type for Para SDK operations.

Hide Cases

bridgeError(String)

Case

An error occurred while executing JavaScript bridge code.

bridgeTimeoutError

Case

The JavaScript bridge did not respond in time.

error(String)

Case

A general error occurred.

notImplemented(String)

Case

Feature not implemented yet.

MetaMaskError

Error

Errors specific to MetaMask connector operations.

Hide Cases

alreadyProcessing

Case

Another MetaMask operation is already in progress.

invalidURL

Case

Failed to construct a valid URL for MetaMask communication.

invalidResponse

Case

Received an invalid or unexpected response from MetaMask.

metaMaskError(code: Int, message: String)

Case

An error reported by the MetaMask app itself (e.g., user rejection code 4001).

notInstalled

Case

MetaMask app is not installed on the device.

CosmosTransactionError

Error

Errors specific to CosmosTransaction operations.

Hide Cases

invalidAddress(String)

Case

Invalid address format.

invalidAmount(String)

Case

Invalid amount format.

invalidDenom(String)

Case

Invalid denomination.

invalidPrefix(String)

Case

Invalid chain prefix.

encodingFailed(String)

Case

Transaction encoding failed.

AuthorizationHandlingError

Error

Errors related to authorization handling in external wallet operations.

Hide Cases

invalidResponse

Case

Invalid response received from authorization process.

authorizationCancelled

Case

Authorization was cancelled by the user.

CosmosChain

Enum

Supported Cosmos chains with testnet configurations.

Hide Cases

cosmos

Case

Cosmos Hub network with chain ID “provider”, prefix “cosmos” and default denom “uatom” (testnet).

osmosis

Case

Osmosis network with chain ID “osmo-test-5”, prefix “osmo” and default denom “uosmo” (testnet).

juno

Case

Juno network with chain ID “uni-6”, prefix “juno” and default denom “ujuno” (testnet).

stargaze

Case

Stargaze network with chain ID “elgafar-1”, prefix “stars” and default denom “ustars” (testnet).

Hide Properties

chainId

String

The chain ID for this network.

prefix

String

The bech32 prefix for this chain.

defaultDenom

String

Default denomination for this chain.

rpcUrl

String

Default RPC URL for this chain’s testnet.

CosmosSigningMethod

Enum

Signing method for Cosmos transactions.

Hide Cases

amino

Case

Legacy Amino JSON signing method for backward compatibility.

proto

Case

Modern Proto/Direct binary signing method (recommended - more efficient).

CosmosTransaction

Struct

A struct representing a Cosmos transaction with messages, fees, and metadata.

Hide Properties

messages

[CosmosMessage]

The transaction messages.

fee

CosmosFee

Transaction fee.

memo

String?

Optional memo.

signingMethod

CosmosSigningMethod

Preferred signing method (defaults to proto).

Hide Static Methods

transfer(fromAddress:toAddress:amount:denom:feeDenom:feeAmount:gas:memo:signingMethod:)

Function

Convenience initializer for creating token transfer transactions.

CosmosSignResponse

Struct

Response from a Cosmos transaction signing operation.

Hide Properties

signature

CosmosSignature

The signature information.

signedDoc

[String: Any]

The signed document.

CosmosCoin

Struct

Represents a coin amount in Cosmos with denomination and amount.

Hide Properties

denom

String

The token denomination (e.g., “uatom”).

amount

String

The amount as a string in the smallest unit.

Hide Initializers

init(denom:amount:)

Function

Creates a new coin with string amount.

init(denom:amount:)

Function

Creates a new coin with UInt64 amount.

CosmosFee

Struct

Represents transaction fees in Cosmos.

Hide Properties

amount

[CosmosCoin]

Array of fee coins.

gas

String

Gas limit as a string.

Hide Initializers

init(amount:gas:)

Function

Creates a fee with array of coins.

init(denom:amount:gas:)

Function

Convenience initializer for simple fee.

Type Definitions

SignatureResult

Struct

Result of a message or transaction signing operation.

Hide Properties

signature

String

The signature string (hex format for most chains).

walletId

String

The ID of the wallet that performed the signing.

type

String

The wallet type that signed (e.g., “evm”, “solana”, “cosmos”).

AuthState

Struct

Authentication state returned by authentication operations.

Hide Properties

stage

AuthStage

The stage of authentication (.verify, .signup, .login).

userId

String

The Para userId for the currently authenticating user.

String?

Email address if using email auth.

phone

String?

Phone number if using phone auth.

displayName

String?

Display name for the authenticating user.

pfpUrl

String?

Profile picture URL for the authenticating user.

username

String?

Username for the authenticating user.

passkeyUrl

String?

URL for passkey authentication.

passkeyId

String?

ID for the passkey.

passkeyKnownDeviceUrl

String?

URL for passkey authentication on a known device.

passwordUrl

String?

URL for password authentication.

biometricHints

[BiometricHint]?

Biometric hints for the user’s devices.

TransferResult

Struct

Result returned from a successful EVM transfer operation.

Hide Properties

hash

String

The transaction hash on the blockchain.

from

String

The sender address.

String

The recipient address.

amount

String

The amount transferred in wei (smallest unit).

chainId

String

The chain ID where the transaction was broadcast.

Auth

Enum

Authentication type for initiateAuthFlow method.

Hide Cases

email(String)

Case

Email-based authentication.

phone(String)

Case

Phone-based authentication with full phone number including country code.

OAuthProvider

Enum

Supported OAuth provider types for authentication.

Hide Cases

google

Case

Google authentication provider.

discord

Case

Discord authentication provider.

apple

Case

Apple authentication provider.

SignupMethod & LoginMethod

The possible methods for signup when the stage is .signup.

Hide Cases

passkey

Case

Passkey-based signup.

password

Case

Password-based signup.

The possible methods for login when the stage is .login.

Hide Cases

passkey

Case

Passkey-based login.

password

Case

Password-based login.

passkeyKnownDevice

Case

Passkey login on a known device.

Wallet

Struct

Represents a wallet associated with a Para user account.

Hide Properties

String

Unique identifier for the wallet.

type

WalletType

The type of wallet (e.g., .evm, .solana, .cosmos).

address

String?

Primary public address of the wallet.

addressSecondary

String?

Secondary address (e.g., Cosmos bech32 address for Cosmos wallets).

publicKey

String?

Public key of the wallet.

scheme

String?

Scheme used by the wallet.

createdAt

Date?

Timestamp when the wallet was created.

WalletType

Enum

Supported wallet types for Para wallets.

Hide Cases

evm

Case

Ethereum Virtual Machine compatible wallet (Ethereum, Polygon, etc.).

solana

Case

Solana blockchain wallet.

cosmos

Case

Cosmos ecosystem wallet supporting bech32 addresses.

MetaMaskConfig

Struct

Configuration object for MetaMask connector initialization.

Hide Properties

appName

String

The name of your application as displayed in MetaMask.

appId

String

Your application’s identifier (typically the bundle identifier).

apiVersion

String

The API version to use (e.g., “1.0”).

Getting Started

Framework Setup

Authentication & Users

External Wallets

Web3 Library Guides

Reference & Support

Swift SDK API Reference

ParaManager Class

Properties

Initialization

Authentication Methods

Session Management Methods

Wallet Management Methods

Transfer Methods

Signing Methods

Two-Factor Authentication (2FA) Methods

MetaMaskConnector Class

Properties

Initialization

Methods

Error Types

CosmosChain

CosmosSigningMethod

CosmosTransaction

CosmosSignResponse

CosmosCoin

CosmosFee

Type Definitions

SignatureResult

AuthState

TransferResult

Auth

OAuthProvider

SignupMethod & LoginMethod

Wallet

WalletType

MetaMaskConfig

Getting Started

Framework Setup

Authentication & Users

External Wallets

Web3 Library Guides

Reference & Support

​ParaManager Class

​Properties

​Initialization

​Authentication Methods

​Session Management Methods

​Wallet Management Methods

​Transfer Methods

​Signing Methods

​Two-Factor Authentication (2FA) Methods

​MetaMaskConnector Class

​Properties

​Initialization

​Methods

​Error Types

​CosmosChain

​CosmosSigningMethod

​CosmosTransaction

​CosmosSignResponse

​CosmosCoin

​CosmosFee

​Type Definitions

​SignatureResult

​AuthState

​TransferResult

​Auth

​OAuthProvider

​SignupMethod & LoginMethod

​Wallet

​WalletType

​MetaMaskConfig

ParaManager Class

Properties

Initialization

Authentication Methods

Session Management Methods

Wallet Management Methods

Transfer Methods

Signing Methods

Two-Factor Authentication (2FA) Methods

MetaMaskConnector Class

Properties

Initialization

Methods

Error Types

CosmosChain

CosmosSigningMethod

CosmosTransaction

CosmosSignResponse

CosmosCoin

CosmosFee

Type Definitions

SignatureResult

AuthState

TransferResult

Auth

OAuthProvider

SignupMethod & LoginMethod

Wallet

WalletType

MetaMaskConfig