Unity Passport Reference

Immutable's Unity SDK reference covers all publicly available Unity SDK methods, enabling you to easily integrate Passport into your Unity-based game.

Information includes method descriptions, parameters and return types.

💡WHO IS THIS FOR?

Developers implementing Immutable Passport in Unity.

---

Init

Initialises Passport with the specified parameters.

This sets up the Passport instance, configures the web browser, and waits for the ready signal.

Method parameters

---

stringclientIdREQUIRED

The user's client ID.

stringenvironmentREQUIRED

The environment to connect to.

stringredirectUriREQUIRED

The URL where the browser will redirect after successful authentication.

stringlogoutRedirectUriREQUIRED

The URL where the browser will redirect after logout is complete.

intengineStartupTimeoutMs

(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.

IWindowsWebBrowserClientwebBrowserClient

(Windows only) Custom Windows browser to use instead of the default browser in the SDK.

Returns

---

Passport

The initialised Passport object.

---

SetCallTimeout

Sets the timeout time for waiting for each call to respond (in milliseconds).

This only applies to functions that use the browser communications manager.

Method parameters

---

intmsREQUIRED

Length of timeout in milliseconds.

Returns

---

void

---

Login

Logs into Passport using Authorisation Code Flow with Proof Key for Code Exchange (PKCE).

This opens the user's default browser on desktop or an in-app browser on mobile.

If useCachedSession is set to true, Passport will attempt to re-authenticate the player using stored credentials. If re-authentication fails, it won't automatically prompt the user to log in again.

Method parameters

---

booluseCachedSessionREQUIRED

If true, the saved access token or refresh token will be used to log the user in. If this fails, it won't automatically prompt the user to log in again.

DirectLoginMethoddirectLoginMethod

Optional parameter to bypass the provider selection page and redirect directly to a specific authentication provider. Use DirectLoginMethod.Google, DirectLoginMethod.Apple, DirectLoginMethod.Facebook, or DirectLoginMethod.None for default behavior.

Returns

---

bool

true if login is successful. Otherwise, false.

---

Logout

Logs the gamer out of Passport and removes any stored credentials.

Method parameters

---

boolhardLogout

If false, the user will not be logged out of Passport in the browser. The default is true.

Returns

---

UniTask

A UniTask object representing the asynchronous operation.

---

HasCredentialsSaved

Checks if credentials exist but does not check if they're valid.

Returns

---

bool

true if there are credentials saved. Otherwise, false.

---

GetAccessToken

Gets the currently saved access token without verifying its validity.

Returns

---

string

The current access token.

---

GetIDToken

Gets the currently saved ID token without verifying its validity.

Returns

---

string

The current ID token.

---

GetLinkedAddresses

Gets the list of external wallets the user has linked to their Passport account via the Dashboard.

Returns

---

List<string>

External wallet addresses linked to the user's Passport account.

---

GetEmail

Retrieves the email address of the user whose credentials are currently stored.

Returns

---

string

The email address of the current user.

---

GetPassportId

Retrieves the Passport ID of the user whose credentials are currently stored.

Returns

---

string

The Passport ID of the current user.

---

ConnectEvm

Instantiates the zkEVM provider.

Returns

---

void

---

ZkEvmRequestAccounts

Returns a list of wallet addresses owned by the user.

Returns

---

List<string>

Wallet addresses owned by the user.

---

ZkEvmGetBalance

Gets the balance of the given address in wei.

Method parameters

---

stringaddressREQUIRED

Address to check for balance.

stringblockNumberOrTagREQUIRED

Integer block number, or the string "latest", "earliest" or "pending".

Returns

---

string

The balance of the given address in wei.

---

ZkEvmSendTransaction

Sends a transaction to the network and signs it using the logged-in Passport account.

Method parameters

---

TransactionRequestrequestREQUIRED

A transaction request containing to, data and value fields.

Returns

---

string

The transaction hash, or the zero hash if the transaction is not yet available.

---

ZkEvmSendTransactionWithConfirmation

Sends a transaction to the network, signs it using the logged-in Passport account, and waits for the transaction to be included in a block.

Similar to ZkEvmSendTransaction.

Method parameters

---

TransactionRequestrequestREQUIRED

A transaction request containing to, data and value fields.

Returns

---

TransactionReceiptResponse

The receipt of the transaction or null if it is still processing.

---

ZkEvmGetTransactionReceipt

Retrieves the transaction information of a given transaction hash using the Ethereum JSON-RPC eth_getTransactionReceipt method.

Method parameters

---

stringhashREQUIRED

The hash of the given transaction.

Returns

---

TransactionReceiptResponse

The receipt of the transaction or null if it is still processing.

---

ZkEvmSignTypedDataV4

Signs the EIP-712 structured message in JSON string format using the logged-in Passport account.

Method parameters

---

stringpayloadREQUIRED

The EIP-712 structured data in JSON string format.

Returns

---

string

The signed payload string.

---

ClearCache

Clears the underlying WebView resource cache. On Android, note that the cache is per-application, so this will clear the cache for all WebViews used.

Method parameters

---

boolincludeDiskFilesREQUIRED

If false, only the RAM/in-memory cache is cleared.

Returns

---

void

---

ClearStorage

Clears all the underlying WebView storage currently being used by the JavaScript storage APIs, including Web SQL Database and the HTML5 Web Storage APIs.

Returns

---

void