Appearance

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>

Parameters ​

• fundWalletConfig?: SolanaFundingConfig

Returns ​

Promise<void>

Deprecated ​

use the useFundWallet hook from the solana package instead.

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: (transaction, connection, options?) => Promise<string>

Parameters ​

• transaction: Transaction | VersionedTransaction

• connection: Connection

• options?: SendTransactionOptions

Returns ​

Promise<string>

Inherited from ​

BaseConnectedSolanaWallet.sendTransaction

signMessage ​

signMessage: (message) => Promise<Uint8Array>

Parameters ​

• message: Uint8Array

Returns ​

Promise<Uint8Array>

Inherited from ​

BaseConnectedSolanaWallet.signMessage

signTransaction ​

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

Type parameters ​

• T extends Transaction | VersionedTransaction

Parameters ​

• transaction: T

Returns ​

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

walletIndex? ​

walletIndex?: number

The HD wallet index

Inherited from ​

PrivyConnectedWallet.walletIndex