MetaMask Connect Solana SDK methods

MetaMask Connect Solana (@metamask/connect-solana) provides a wallet-standard integration for connecting to MetaMask as a Solana wallet. It wraps @metamask/connect-multichain and handles wallet discovery and session management automatically.

createSolanaClient

Creates a new Solana client instance. By default, the wallet is automatically registered with the wallet-standard registry on creation, making MetaMask discoverable by Solana dapps and wallet adapters.

Under the hood, createSolanaClient delegates to createMultichainClient, which is a singleton. Calling createSolanaClient multiple times returns the same underlying multichain core and session.

Parameters

Name	Type	Required	Description
dapp.name	string	Yes	Name of your dApp.
dapp.url	string	No	URL of your dApp.
dapp.iconUrl	string	No	Icon URL for your dApp.
api.supportedNetworks	SolanaSupportedNetworks	No	Map of network names (mainnet, devnet, testnet) to RPC URLs.
debug	boolean	No	Reserved for future use; not currently forwarded to the underlying client.
skipAutoRegister	boolean	No	Skip auto-registering the wallet during creation (defaults to false).

note

createSolanaClient does not accept eventHandlers. To listen for lower-level multichain events (such as session changes), use client.core.on() after creating the client. See the multichain event methods.

Returns

A promise that resolves to a SolanaClient instance.

Example

import { createSolanaClient } from '@metamask/connect-solana'

const client = await createSolanaClient({
  dapp: {
    name: 'My Solana DApp',
    url: 'https://mydapp.com',
  },
  api: {
    supportedNetworks: {
      mainnet: 'https://api.mainnet-beta.solana.com',
      devnet: 'https://api.devnet.solana.com',
    },
  },
})

getWallet

Returns a wallet-standard compatible MetaMask wallet instance. Use this to access wallet features directly outside of the Solana wallet adapter.

Returns

A wallet-standard Wallet object.

Example

const wallet = client.getWallet()
console.log('Wallet name:', wallet.name)

registerWallet

Registers the MetaMask wallet with the wallet-standard registry, making it automatically discoverable by Solana dapps. This is a no-op if the wallet was already auto-registered during creation (that is, skipAutoRegister was not set to true).

Returns

A promise that resolves when registration is complete.

Example

const client = await createSolanaClient({
  dapp: { name: 'My Solana DApp', url: 'https://mydapp.com' },
  skipAutoRegister: true,
})

// Register manually when ready
await client.registerWallet()

disconnect

Disconnects all Solana scopes from MetaMask. This only revokes the Solana-specific scopes:

• solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp (mainnet)
• solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1 (devnet)
• solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z (testnet)

It does not terminate the broader multichain session if non-Solana scopes (such as EVM) are also active.

Returns

A promise that resolves when the disconnect is complete.

Example

await client.disconnect()

Properties

Property	Type	Description
core	MultichainCore	The underlying MultichainCore instance.

The core property exposes the full multichain client, giving access to lower-level methods such as connect, getSession, invokeMethod, on, and off.

Example

const session = await client.core.getSession()
const solAccounts =
  session.sessionScopes['solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp']?.accounts || []
console.log('Solana accounts:', solAccounts)

Supported wallet-standard features

The wallet returned by getWallet() implements the following wallet-standard features. Access them via wallet.features['<feature>'].

Feature	Description
standard:connect	Connect to the wallet and receive the user's accounts.
standard:disconnect	Disconnect from the wallet.
standard:events	Subscribe to account and chain change events.
solana:signMessage	Sign an arbitrary message (returns a signature).
solana:signTransaction	Sign a transaction without broadcasting it.
solana:signAndSendTransaction	Sign a transaction and broadcast it to the network.

Example

const wallet = client.getWallet()

const { accounts } = await wallet.features['standard:connect'].connect()

const message = new TextEncoder().encode('Hello Solana')
const [{ signature }] = await wallet.features['solana:signMessage'].signMessage({
  account: accounts[0],
  message,
})

Types

SolanaNetwork

type SolanaNetwork = 'mainnet' | 'devnet' | 'testnet'

SolanaSupportedNetworks

A partial record mapping SolanaNetwork names to RPC URL strings.

type SolanaSupportedNetworks = Partial<Record<SolanaNetwork, string>>

SolanaConnectOptions

Configuration options passed to createSolanaClient.

Field	Type	Required	Description
dapp	object	Yes	Dapp identification and branding settings.
dapp.name	string	Yes	Name of your dApp.
dapp.url	string	No	URL of your dApp.
dapp.iconUrl	string	No	Icon URL for your dApp.
api	object	No	Optional API configuration.
api.supportedNetworks	SolanaSupportedNetworks	No	Map of network names (mainnet, devnet, testnet) to RPC URLs.
debug	boolean	No	Reserved for future use; not currently forwarded to the underlying client.
skipAutoRegister	boolean	No	Skip auto-registering the wallet during creation (defaults to false).

SolanaClient

The object returned by createSolanaClient.

Property / Method	Type	Description
core	MultichainCore	The underlying MultichainCore instance.
getWallet()	() => Wallet	Returns a wallet-standard compatible MetaMask wallet instance.
registerWallet()	() => Promise<void>	Registers MetaMask with the wallet-standard registry.
disconnect()	() => Promise<void>	Disconnects all Solana scopes from MetaMask.