Unity SDK Reference
Information includes method descriptions, parameters and return types.
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
The user's client ID.
The environment to connect to.
(Android, iOS, and macOS only) The URL where the browser will redirect after successful authentication. Only required for the PKCE login flow.
The URL where the browser will redirect after logout is complete.
(Windows only) Timeout duration in milliseconds to wait for the default Windows browser engine to start.
(Windows only) Custom Windows browser to use instead of the default browser in the SDK.
Returns
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
Length of timeout in milliseconds. Only required for the Device Code Authorisation login flow.
Returns
Login
Logs into Passport using Device Code Authorisation.
This will open the user's default browser and take them through Passport login.
If useCachedSession is true, stored credentials will be used to re-login the gamer. If re-login fails, it will not fall back to Device Code Authorisation.
Method parameters
If true, the saved access token or refresh token will be used to log the user in. If this fails, it will not fallback to Device Code Authorisation.
The maximum time, in milliseconds, the function is allowed to take before a TimeoutException is thrown. If not set, the function will wait indefinitely.
Returns
true if login is successful. Otherwise, false.
LoginPKCE
(Android, iOS and macOS only) Logs into Passport using Authorisation Code Flow with Proof Key for Code Exchange (PKCE).
HasCredentialsSaved
Checks if credentials exist but does not check if they're valid.
Returns
true if there are credentials saved. Otherwise, false.
GetAccessToken
Gets the currently saved access token without verifying its validity.
Returns
The current access token.
GetIDToken
Gets the currently saved ID token without verifying its validity.
Returns
The current ID token.
Logout
Logs the gamer out of Passport and removes any stored credentials.
It is recommended to be used alongside Login to keep the gamer experience consistent.
Method parameters
If false, the user will not be logged out of Passport in the browser. The default is true.
LogoutPKCE
Logs the gamer out of Passport and removes any stored credentials.
It is recommended to be used alongside LoginPKCE to keep the gamer experience consistent.
Method parameters
If false, the user will not be logged out of Passport in the browser. The default is true.
GetLinkedAddresses
Gets the list of external wallets the user has linked to their Passport account via the Dashboard.
Returns
External wallet addresses linked to the user’s Passport account.
GetEmail
Retrieves the email address of the user whose credentials are currently stored.
Returns
The email address of the current user.
GetPassportId
Retrieves the Passport ID of the user whose credentials are currently stored.
Returns
The Passport ID of the current user.
ConnectEvm
Instantiates the zkEVM provider.
Returns
ZkEvmRequestAccounts
Returns a list of wallet addresses owned by the user.
Returns
Wallet addresses owned by the user.
ZkEvmGetBalance
Gets the balance of the given address in wei.
Method parameters
Address to check for balance.
Integer block number, or the string "latest", "earliest" or "pending".
Returns
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
A transaction request containing to, data and value fields.
Returns
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
A transaction request containing to, data and value fields.
Returns
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
The hash of the given transaction.
Returns
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
The EIP-712 structured data in JSON string format.
Returns
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
If false, only the RAM/in-memory cache is cleared.
Returns
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.