Skip to content

Documentation / react-auth / ConnectedSolanaWallet

Interface: ConnectedSolanaWallet

Object representation of a connected Solana wallet for the user.

Extends

  • BaseConnectedSolanaWallet.PrivyConnectedWallet

Properties

address

address: string

The wallet address.

Inherited from

BaseConnectedSolanaWallet.address


connectedAt

connectedAt: number

The first time this wallet was connected without break.

Inherited from

BaseConnectedSolanaWallet.connectedAt


connectorType

connectorType: string

The connector used to initiate the connection with the wallet client. e.g. injected, wallet_connect, coinbase_wallet, etc.

Inherited from

BaseConnectedSolanaWallet.connectorType


disconnect

disconnect: () => void

Experimental: This property is subject to change at any time.

Not all wallet clients support programmatic disconnects (e.g. MetaMask, Phantom). In kind, if the wallet's client does not support programmatic disconnects, this method will no-op.

Returns

void

Inherited from

BaseConnectedSolanaWallet.disconnect


fund

fund: (fundWalletConfig?) => Promise<void>

Prompt the user to go through the funding flow and for the connected wallet.

This will open the modal with a prompt for the user to select a funding method (if multiple are enabled).

Once the user continues to the funding flow, Privy will display the funding status screen, and wait for the transaction to complete.

Note: Even after a successful funding, funds can take a few minutes to arrive in the user's wallet.

Privy currently supports funding via external wallets and Moonpay.

Parameters

fundWalletConfig?: FundWalletConfig

Funding configuration to specify chain and funding amount (if enabled) *

Returns

Promise<void>

Inherited from

PrivyConnectedWallet.fund


getProvider

getProvider: () => Promise<SolanaProvider>

Returns a light provider for interfacing with this wallet. Support message signing on embedded and external wallets using an internal interface.

Returns

Promise<SolanaProvider>

Inherited from

BaseConnectedSolanaWallet.getProvider


imported

imported: boolean

Whether the wallet is imported.

Inherited from

BaseConnectedSolanaWallet.imported


isConnected

isConnected: () => Promise<boolean>

Returns true if the wallet is connected, false otherwise

Returns

Promise<boolean>

Inherited from

BaseConnectedSolanaWallet.isConnected


linked

linked: boolean

True if this wallet is linked to the authenticated user. False if it is not yet linked or the user has not yet authenticated.

Inherited from

PrivyConnectedWallet.linked


loginOrLink: () => Promise<void>

Login with this wallet or link this wallet to the authenticated user.

Throws a PrivyClientError if the wallet is not connected.

Returns

Promise<void>

Inherited from

PrivyConnectedWallet.loginOrLink


meta

meta: ConnectedWalletMetadata

Metadata for the wallet.

Inherited from

BaseConnectedSolanaWallet.meta


sendTransaction

sendTransaction: undefined | (transaction, connection, options?) => Promise<string>

Inherited from

BaseConnectedSolanaWallet.sendTransaction


signMessage

signMessage: undefined | (message) => Promise<Uint8Array>

Inherited from

BaseConnectedSolanaWallet.signMessage


signTransaction

signTransaction: undefined | <T>(transaction) => Promise<T>

Inherited from

BaseConnectedSolanaWallet.signTransaction


unlink: () => Promise<void>

Unlink this wallet to the authenticated user. Throws a PrivyClientError if the user is not authenticated.

Returns

Promise<void>

Inherited from

PrivyConnectedWallet.unlink


walletClientType

walletClientType: WalletClientType

The wallet client where this key-pair is stored. e.g. metamask, rainbow, coinbase_wallet, etc.

Inherited from

BaseConnectedSolanaWallet.walletClientType