@metamask/connect-solana

@metamask/connect-solana

Solana wallet-standard integration for connecting to MetaMask via the Multichain API.

@metamask/connect-solana provides a seamless way to integrate MetaMask as a Solana wallet in your dapp using the wallet-standard protocol. It wraps @metamask/solana-wallet-standard with MetaMask Connect to handle wallet discovery and session management automatically.

Features

• Wallet Standard Compatible - Automatically registers MetaMask with the wallet-standard registry
• Seamless Integration - Works with @solana/wallet-adapter-react out of the box
• Session Management - Handles session creation internally; disconnect revokes only Solana scopes
• Cross-Platform Support - Works with browser extensions and mobile applications

Installation

yarn add @metamask/connect-solana

or

npm install @metamask/connect-solana

Quick Start

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

const INFURA_API_KEY = 'YOUR_INFURA_API_KEY';

// Create a Solana client
// MetaMask is automatically registered with the wallet-standard registry on creation
const client = await createSolanaClient({
  dapp: {
    name: 'My Solana DApp',
    url: 'https://mydapp.com',
  },
  api: {
    supportedNetworks: getInfuraRpcUrls({
      infuraApiKey: INFURA_API_KEY,
      networks: ['mainnet', 'devnet'],
    }),
  },
});

Usage with Solana Wallet Adapter

The most common use case is integrating with @solana/wallet-adapter-react:

import {
  ConnectionProvider,
  WalletProvider,
} from '@solana/wallet-adapter-react';
import {
  WalletModalProvider,
  WalletMultiButton,
} from '@solana/wallet-adapter-react-ui';
import { createSolanaClient } from '@metamask/connect-solana';
import { useEffect } from 'react';

import '@solana/wallet-adapter-react-ui/styles.css';

function App() {
  useEffect(() => {
    // MetaMask is automatically registered with the wallet-standard registry on creation
    createSolanaClient({
      dapp: {
        name: 'My Solana DApp',
        url: window.location.origin,
      },
    });
  }, []);

  return (
    <ConnectionProvider endpoint="https://api.devnet.solana.com">
      <WalletProvider wallets={[]} autoConnect>
        <WalletModalProvider>
          <WalletMultiButton />
          {/* Your app content */}
        </WalletModalProvider>
      </WalletProvider>
    </ConnectionProvider>
  );
}

Wallet Adapter support

Note: There is a known issue with @solana/wallet-adapter-react that prevents connecting to MetaMask when using the Wallet Standard provider from @metamask/connect-solana in Chrome on Android.

See this patch file for details.

API Reference

createSolanaClient(options)

Creates a new Solana client instance. By default, the wallet is automatically registered with the wallet-standard registry on creation.

Parameters

Option	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
analytics.enabled	boolean	No	Enables dapp-side analytics. Defaults to true; set to false to disable analytics events and wallet correlation metadata.
analytics.integrationType	string	No	Integration type for analytics
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)

Returns

Promise<SolanaClient>

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

---

getInfuraRpcUrls(options)

Generates Solana Infura RPC URLs keyed by Solana network name. The return value can be passed directly to createSolanaClient({ api: { supportedNetworks } }).

Parameters

Name	Type	Required	Description
infuraApiKey	string	Yes	Your Infura API key
networks	SolanaNetwork[]	Yes	Solana networks to include (for example, ['mainnet', 'devnet'])

Returns

SolanaSupportedNetworks

import { getInfuraRpcUrls } from '@metamask/connect-solana';

const supportedNetworks = getInfuraRpcUrls({
  infuraApiKey: 'YOUR_INFURA_API_KEY',
  networks: ['mainnet', 'devnet'],
});

// {
//   mainnet: 'https://solana-mainnet.infura.io/v3/YOUR_INFURA_API_KEY',
//   devnet: 'https://solana-devnet.infura.io/v3/YOUR_INFURA_API_KEY',
// }

---

SolanaClient

The object returned by createSolanaClient.

Properties

Property	Type	Description
core	MultichainCore	The underlying MultichainCore instance

Methods

getWallet()

Returns a wallet-standard compatible MetaMask wallet instance.

Returns

Wallet - A wallet-standard compatible wallet.

registerWallet()

Registers the MetaMask wallet with the wallet-standard registry. This is a no-op if the wallet was already auto-registered during creation (i.e., skipAutoRegister was not set to true).

Returns

Promise<void>

disconnect()

Disconnects all Solana scopes from MetaMask. This only revokes the Solana-specific scopes (mainnet, devnet, testnet); it does not terminate the broader multichain session.

Returns

Promise<void>

---

Types

SolanaNetwork

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

SolanaSupportedNetworks

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

TypeScript

This package is written in TypeScript and includes full type definitions.

Development

This package is part of the MetaMask Connect monorepo. From the repo root:

# Build the package
yarn workspace @metamask/connect-solana run build

# Run tests
yarn workspace @metamask/connect-solana run test

# Run linting
yarn workspace @metamask/connect-solana run lint

Contributing

This package is part of a monorepo. Instructions for contributing can be found in the monorepo README.

License

MIT