loginWithWallet()

Package: react-wallet-kit

Overview

Logs in a user using the specified wallet provider.

• This function logs in a user by authenticating with the provided wallet provider via a wallet-based signature.
• If a public key is not provided, a new one will be generated for authentication.
• Optionally accepts a custom session key and session expiration time.
• Stores the resulting session token under the specified session key, or the default session key if not provided.
• Throws an error if a public key cannot be found or generated, or if the login process fails.

Parameters

params · LoginWithWalletParams · required

Show params details

params.expirationSeconds

string

optional session expiration time in seconds (defaults to the configured default).

params.organizationId

string

organization ID to target (defaults to the session’s organization ID or the parent organization ID).

params.publicKey

string

optional public key to associate with the session (generated if not provided).

params.sessionKey

string

optional key to store the session under (defaults to the default session key).

params.walletProvider

WalletProvider

required

wallet provider to use for authentication.

Response

A successful response returns the following fields:

returns · WalletAuthResult · required

A promise that resolves to a WalletAuthResult, which includes:

• sessionToken: the signed JWT session token.
• address: the authenticated wallet address.