Class Passport

Constructors

constructor

Methods

connectImxSilent connectImx connectEvm login loginCallback loginWithPKCEFlow loginWithPKCEFlowCallback storeTokens logout getLogoutUrl logoutSilentCallback getUserInfo getIdToken getAccessToken getLinkedAddresses linkExternalWallet

Constructors

constructor

Methods

connectImxSilent

  • connectImxSilent(): Promise<null | IMXProvider>

  • Attempts to connect to IMX silently without user interaction.

    Returns Promise<null | IMXProvider>

    A promise that resolves to an IMX provider if successful, or null if no cached session exists

    Deprecated

    The method login with an argument of { useCachedSession: true } should be used in conjunction with connectImx instead

connectImx

  • connectImx(): Promise<IMXProvider>

  • Connects to IMX, prompting user interaction if necessary.

    Returns Promise<IMXProvider>

    A promise that resolves to an IMX provider

connectEvm

  • connectEvm(options?): Promise<Provider>

  • Connects to EVM and optionally announces the provider.

    Parameters

    Returns Promise<Provider>

    The EVM provider instance

login

  • login(options?): Promise<null | UserProfile>

  • Initiates the login process.

    Parameters

    Returns Promise<null | UserProfile>

    A promise that resolves to the user profile if logged in, null otherwise

    Throws

    If retrieving the cached user session fails (except for "Unknown or invalid refresh token" errors) and useCachedSession is true

loginCallback

  • loginCallback(): Promise<void>

  • Handles the login callback.

    Returns Promise<void>

    A promise that resolves when the callback is processed

loginWithPKCEFlow

  • loginWithPKCEFlow(directLoginOptions?, imPassportTraceId?): Promise<string>

  • Initiates a PKCE flow login.

    Parameters

    • OptionaldirectLoginOptions: DirectLoginOptions

      If provided, directly redirects to the specified login method

    • OptionalimPassportTraceId: string

      The trace ID for the PKCE flow

    Returns Promise<string>

    The authorization URL for the PKCE flow

loginWithPKCEFlowCallback

  • loginWithPKCEFlowCallback(authorizationCode, state): Promise<UserProfile>

  • Handles the PKCE flow login callback.

    Parameters

    • authorizationCode: string

      The authorization code received from the OAuth provider

    • state: string

      The state parameter for CSRF protection

    Returns Promise<UserProfile>

    A promise that resolves to the user profile

storeTokens

logout

  • logout(): Promise<void>

  • Logs out the current user.

    Returns Promise<void>

    A promise that resolves when the logout is complete

getLogoutUrl

  • getLogoutUrl(): Promise<null | string>

  • Returns the logout URL for the current user.

    Returns Promise<null | string>

    The logout URL

logoutSilentCallback

  • logoutSilentCallback(url): Promise<void>

  • Handles the silent logout callback.

    Parameters

    • url: string

      The callback URL to process

    Returns Promise<void>

    A promise that resolves when the silent logout is complete

getUserInfo

  • getUserInfo(): Promise<undefined | UserProfile>

  • Retrieves the current user's information.

    Returns Promise<undefined | UserProfile>

    A promise that resolves to the user profile if logged in, undefined otherwise

getIdToken

  • getIdToken(): Promise<undefined | string>

  • Retrieves the current user's ID token.

    Returns Promise<undefined | string>

    A promise that resolves to the ID token if available, undefined otherwise

getAccessToken

  • getAccessToken(): Promise<undefined | string>

  • Retrieves the current user's access token.

    Returns Promise<undefined | string>

    A promise that resolves to the access token if available, undefined otherwise

getLinkedAddresses

  • getLinkedAddresses(): Promise<string[]>

  • Retrieves the addresses linked to the current user's account.

    Returns Promise<string[]>

    A promise that resolves to an array of linked addresses

linkExternalWallet

  • linkExternalWallet(params): Promise<LinkedWallet>

  • Links an external wallet to the current user's account.

    Parameters

    Returns Promise<LinkedWallet>

    A promise that resolves to the linked wallet information

    Throws

    When:

    • User is not logged in (NOT_LOGGED_IN_ERROR)
    • User is not registered (USER_NOT_REGISTERED_ERROR)
    • Wallet is already linked (LINK_WALLET_ALREADY_LINKED_ERROR)
    • Maximum number of wallets reached (LINK_WALLET_MAX_WALLETS_LINKED_ERROR)
    • Duplicate nonce used (LINK_WALLET_DUPLICATE_NONCE_ERROR)
    • Validation fails (LINK_WALLET_VALIDATION_ERROR)
    • Other generic errors (LINK_WALLET_GENERIC_ERROR)

Settings

Member Visibility

On This Page

Constructors
Methods