@metamask/connect-solana 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- Initial release
+
+[Unreleased]: https://github.com/MetaMask/connect-monorepo/compare/@metamask/connect-solana@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/connect-monorepo/releases/tag/@metamask/connect-solana@0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,136 @@
+# `@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](https://github.com/wallet-standard/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 and revocation internally
+- **Cross-Platform Support** - Works with browser extensions and mobile applications
+
+## Installation
+
+```bash
+yarn add @metamask/connect-solana
+```
+
+or
+
+```bash
+npm install @metamask/connect-solana
+```
+
+## Quick Start
+
+```typescript
+import { createSolanaClient } from '@metamask/connect-solana';
+
+// Create a Solana client
+const client = await createSolanaClient({
+  dapp: {
+    name: 'My Solana DApp',
+    url: 'https://mydapp.com',
+  },
+});
+
+// Register MetaMask with the wallet-standard registry
+// This makes MetaMask automatically discoverable by Solana dapps
+await client.registerWallet();
+```
+
+## Usage with Solana Wallet Adapter
+
+The most common use case is integrating with `@solana/wallet-adapter-react`:
+
+```tsx
+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(() => {
+    // Register MetaMask wallet on app initialization
+    createSolanaClient({
+      dapp: {
+        name: 'My Solana DApp',
+        url: window.location.origin,
+      },
+    }).then((client) => {
+      client.registerWallet();
+    });
+  }, []);
+
+  return (
+    <ConnectionProvider endpoint="https://api.devnet.solana.com">
+      <WalletProvider wallets={[]} autoConnect>
+        <WalletModalProvider>
+          <WalletMultiButton />
+          {/* Your app content */}
+        </WalletModalProvider>
+      </WalletProvider>
+    </ConnectionProvider>
+  );
+}
+```
+
+## API Reference
+
+### `createSolanaClient(options)`
+
+Creates a new Solana client instance.
+
+#### Parameters
+
+- `options.dapp.name` (required) - The name of your dapp
+- `options.dapp.url` (optional) - The URL of your dapp
+- `options.dapp.iconUrl` (optional) - The icon URL of your dapp
+- `options.api.supportedNetworks` (optional) - Map of CAIP chain IDs to RPC URLs
+- `options.debug` (optional) - Enable debug logging
+
+#### Returns
+
+A `SolanaClient` object with:
+
+- `core` - The underlying MultichainCore instance
+- `getWallet(walletName?)` - Returns a wallet-standard compatible wallet
+- `registerWallet(walletName?)` - Registers the wallet with the wallet-standard registry
+- `disconnect()` - Disconnects and revokes the session
+
+## 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:
+
+```bash
+# 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](https://github.com/MetaMask/connect-monorepo#readme).
+
+## License
+
+MIT

package/dist/browser/es/connect-solana.mjs

@@ -0,0 +1,80 @@
+var __async = (__this, __arguments, generator) => {
+  return new Promise((resolve, reject) => {
+    var fulfilled = (value) => {
+      try {
+        step(generator.next(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var rejected = (value) => {
+      try {
+        step(generator.throw(value));
+      } catch (e) {
+        reject(e);
+      }
+    };
+    var step = (x) => x.done ? resolve(x.value) : Promise.resolve(x.value).then(fulfilled, rejected);
+    step((generator = generator.apply(__this, __arguments)).next());
+  });
+};
+
+// src/connect.ts
+import { createMultichainClient } from "@metamask/connect-multichain";
+import {
+  getWalletStandard,
+  registerSolanaWalletStandard
+} from "@metamask/solana-wallet-standard";
+
+// src/networks.ts
+var SOLANA_CAIP_IDS = {
+  mainnet: "solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp",
+  devnet: "solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1",
+  testnet: "solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z"
+};
+function convertNetworksToCAIP(networks) {
+  return Object.entries(networks).reduce(
+    (acc, [network, rpcUrl]) => {
+      const caipId = SOLANA_CAIP_IDS[network];
+      if (caipId && rpcUrl) {
+        acc[caipId] = rpcUrl;
+      }
+      return acc;
+    },
+    {}
+  );
+}
+
+// src/connect.ts
+function createSolanaClient(options) {
+  return __async(this, null, function* () {
+    var _a, _b;
+    const defaultNetworks = {
+      mainnet: "https://api.mainnet-beta.solana.com"
+    };
+    const supportedNetworks = convertNetworksToCAIP(
+      (_b = (_a = options.api) == null ? void 0 : _a.supportedNetworks) != null ? _b : defaultNetworks
+    );
+    const core = yield createMultichainClient({
+      dapp: options.dapp,
+      api: {
+        supportedNetworks
+      }
+    });
+    const client = core.provider;
+    return {
+      core,
+      getWallet: (walletName) => getWalletStandard({ client, walletName }),
+      registerWallet: (walletName = "MetaMask Connect") => __async(null, null, function* () {
+        return registerSolanaWalletStandard({ client, walletName });
+      }),
+      disconnect: () => __async(null, null, function* () {
+        return yield core.disconnect();
+      })
+    };
+  });
+}
+export {
+  createSolanaClient
+};
+//# sourceMappingURL=connect-solana.mjs.map

package/dist/browser/es/connect-solana.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/connect.ts","../../../src/networks.ts"],"sourcesContent":["import { createMultichainClient } from '@metamask/connect-multichain';\nimport {\n  getWalletStandard,\n  registerSolanaWalletStandard,\n} from '@metamask/solana-wallet-standard';\n\nimport { convertNetworksToCAIP } from './networks';\nimport type {\n  SolanaClient,\n  SolanaConnectOptions,\n  SolanaSupportedNetworks,\n} from './types';\n\n/**\n * Creates a new Solana client for connecting to MetaMask via wallet-standard.\n *\n * This function initializes the MultichainSDK and provides methods to get or register\n * a wallet-standard compatible wallet. The wallet handles session creation internally\n * when users connect through the Solana wallet adapter UI.\n *\n * @param options - Configuration options for the Solana client\n * @param options.dapp - Dapp identification and branding settings\n * @param options.api - Optional API configuration with supported networks\n * @param options.api.supportedNetworks - Record mapping network names (mainnet, devnet, testnet) to RPC URLs\n * @param options.debug - Enable debug logging\n * @returns A promise that resolves to the Solana client instance\n *\n * @example\n * ```typescript\n * import { createSolanaClient } from '@metamask/connect-solana';\n *\n * const client = await createSolanaClient({\n *   dapp: {\n *     name: 'My Solana DApp',\n *     url: 'https://mydapp.com',\n *   },\n *   api: {\n *     supportedNetworks: {\n *       mainnet: 'https://api.mainnet-beta.solana.com',\n *       devnet: 'https://api.devnet.solana.com',\n *     },\n *   },\n * });\n *\n * // Register the wallet to make it discoverable by Solana dapps\n * await client.registerWallet();\n *\n * // Or get the wallet instance directly\n * const wallet = client.getWallet();\n * ```\n */\nexport async function createSolanaClient(\n  options: SolanaConnectOptions,\n): Promise<SolanaClient> {\n  const defaultNetworks: SolanaSupportedNetworks = {\n    mainnet: 'https://api.mainnet-beta.solana.com',\n  };\n\n  const supportedNetworks = convertNetworksToCAIP(\n    options.api?.supportedNetworks ?? defaultNetworks,\n  );\n\n  const core = await createMultichainClient({\n    dapp: options.dapp,\n    api: {\n      supportedNetworks,\n    },\n  });\n\n  const client = core.provider;\n\n  return {\n    core,\n    getWallet: (walletName?: string) =>\n      getWalletStandard({ client, walletName }),\n    registerWallet: async (walletName = 'MetaMask Connect') =>\n      registerSolanaWalletStandard({ client, walletName }),\n    disconnect: async () => await core.disconnect(),\n  };\n}\n","import type { SolanaNetwork, SolanaSupportedNetworks } from './types';\n\n/**\n * CAIP-2 chain IDs for Solana networks.\n * The reference is the first 32 characters of the Base58-encoded genesis hash.\n */\nexport const SOLANA_CAIP_IDS: Record<SolanaNetwork, string> = {\n  mainnet: 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp',\n  devnet: 'solana:EtWTRABZaYq6iMfeYKouRu166VU2xqa1',\n  testnet: 'solana:4uhcVJyU9pJkvQyS88uRDiswHXSCkY3z',\n};\n\n/**\n * Converts a record of network names to RPC URLs into a record of CAIP IDs to RPC URLs.\n *\n * @param networks - A record of network names to RPC URLs\n * @returns A record of CAIP IDs to RPC URLs\n */\nexport function convertNetworksToCAIP(\n  networks: SolanaSupportedNetworks,\n): Record<string, string> {\n  return Object.entries(networks).reduce<Record<string, string>>(\n    (acc, [network, rpcUrl]) => {\n      const caipId = SOLANA_CAIP_IDS[network as SolanaNetwork];\n      if (caipId && rpcUrl) {\n        acc[caipId] = rpcUrl;\n      }\n      return acc;\n    },\n    {},\n  );\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAAA,SAAS,8BAA8B;AACvC;AAAA,EACE;AAAA,EACA;AAAA,OACK;;;ACEA,IAAM,kBAAiD;AAAA,EAC5D,SAAS;AAAA,EACT,QAAQ;AAAA,EACR,SAAS;AACX;AAQO,SAAS,sBACd,UACwB;AACxB,SAAO,OAAO,QAAQ,QAAQ,EAAE;AAAA,IAC9B,CAAC,KAAK,CAAC,SAAS,MAAM,MAAM;AAC1B,YAAM,SAAS,gBAAgB,OAAwB;AACvD,UAAI,UAAU,QAAQ;AACpB,YAAI,MAAM,IAAI;AAAA,MAChB;AACA,aAAO;AAAA,IACT;AAAA,IACA,CAAC;AAAA,EACH;AACF;;;ADoBA,SAAsB,mBACpB,SACuB;AAAA;AArDzB;AAsDE,UAAM,kBAA2C;AAAA,MAC/C,SAAS;AAAA,IACX;AAEA,UAAM,oBAAoB;AAAA,OACxB,mBAAQ,QAAR,mBAAa,sBAAb,YAAkC;AAAA,IACpC;AAEA,UAAM,OAAO,MAAM,uBAAuB;AAAA,MACxC,MAAM,QAAQ;AAAA,MACd,KAAK;AAAA,QACH;AAAA,MACF;AAAA,IACF,CAAC;AAED,UAAM,SAAS,KAAK;AAEpB,WAAO;AAAA,MACL;AAAA,MACA,WAAW,CAAC,eACV,kBAAkB,EAAE,QAAQ,WAAW,CAAC;AAAA,MAC1C,gBAAgB,CAAO,aAAa,uBAAoB;AACtD,4CAA6B,EAAE,QAAQ,WAAW,CAAC;AAAA;AAAA,MACrD,YAAY,MAAS;AAAG,qBAAM,KAAK,WAAW;AAAA;AAAA,IAChD;AAAA,EACF;AAAA;","names":[]}

package/dist/types/index.d.ts

@@ -0,0 +1,102 @@
+import { MultichainOptions, MultichainCore } from '@metamask/connect-multichain';
+import { Wallet } from '@wallet-standard/base';
+
+/**
+ * Solana network names supported by the client.
+ */
+type SolanaNetwork = 'mainnet' | 'devnet' | 'testnet';
+/**
+ * A record mapping Solana network names to their RPC URLs.
+ *
+ * @example
+ * ```typescript
+ * const networks: SolanaSupportedNetworks = {
+ *   mainnet: 'https://api.mainnet-beta.solana.com',
+ *   devnet: 'https://api.devnet.solana.com',
+ * };
+ * ```
+ */
+type SolanaSupportedNetworks = Partial<Record<SolanaNetwork, string>>;
+/**
+ * Configuration options for creating a Solana client.
+ *
+ * Derived from MultichainOptions to ensure consistency with the core SDK.
+ */
+type SolanaConnectOptions = Pick<MultichainOptions, 'dapp'> & {
+    /**
+     * Optional API configuration.
+     * Maps network names (mainnet, devnet, testnet) to RPC URLs.
+     */
+    api?: {
+        supportedNetworks?: SolanaSupportedNetworks;
+    };
+    /** Enable debug logging */
+    debug?: boolean;
+};
+/**
+ * The Solana client instance returned by createSolanaClient.
+ */
+type SolanaClient = {
+    /** The underlying MultichainCore instance */
+    core: MultichainCore;
+    /**
+     * Gets a wallet-standard compatible wallet instance.
+     *
+     * @param walletName - Optional custom name for the wallet
+     * @returns The wallet instance
+     */
+    getWallet: (walletName?: string) => Wallet;
+    /**
+     * Registers the MetaMask wallet with the wallet-standard registry.
+     * This makes MetaMask automatically discoverable by Solana dapps.
+     *
+     * @param walletName - Optional custom name for the wallet
+     */
+    registerWallet: (walletName?: string) => Promise<void>;
+    /**
+     * Disconnects from the wallet and revokes the session.
+     */
+    disconnect: () => Promise<void>;
+};
+
+/**
+ * Creates a new Solana client for connecting to MetaMask via wallet-standard.
+ *
+ * This function initializes the MultichainSDK and provides methods to get or register
+ * a wallet-standard compatible wallet. The wallet handles session creation internally
+ * when users connect through the Solana wallet adapter UI.
+ *
+ * @param options - Configuration options for the Solana client
+ * @param options.dapp - Dapp identification and branding settings
+ * @param options.api - Optional API configuration with supported networks
+ * @param options.api.supportedNetworks - Record mapping network names (mainnet, devnet, testnet) to RPC URLs
+ * @param options.debug - Enable debug logging
+ * @returns A promise that resolves to the Solana client instance
+ *
+ * @example
+ * ```typescript
+ * 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',
+ *     },
+ *   },
+ * });
+ *
+ * // Register the wallet to make it discoverable by Solana dapps
+ * await client.registerWallet();
+ *
+ * // Or get the wallet instance directly
+ * const wallet = client.getWallet();
+ * ```
+ */
+declare function createSolanaClient(options: SolanaConnectOptions): Promise<SolanaClient>;
+
+export { type SolanaClient, type SolanaConnectOptions, type SolanaNetwork, type SolanaSupportedNetworks, createSolanaClient };

package/package.json

@@ -0,0 +1,80 @@
+{
+  "name": "@metamask/connect-solana",
+  "version": "0.1.0",
+  "description": "Solana Layer for MetaMask Connect",
+  "keywords": [
+    "MetaMask",
+    "Solana"
+  ],
+  "homepage": "https://github.com/MetaMask/connect-monorepo/tree/main/packages/connect-solana#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/connect-monorepo/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/connect-monorepo.git"
+  },
+  "license": "MIT",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/browser/es/connect-solana.mjs"
+      },
+      "require": {
+        "types": "./dist/types/index.d.ts",
+        "default": "./dist/browser/es/connect-solana.mjs"
+      },
+      "default": "./dist/browser/es/connect-solana.mjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/browser/es/connect-solana.mjs",
+  "module": "./dist/browser/es/connect-solana.mjs",
+  "browser": "./dist/browser/es/connect-solana.mjs",
+  "types": "./dist/types/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "yarn tsup",
+    "build:docs": "typedoc",
+    "changelog:format": "../../scripts/format-changelog.sh @metamask/connect-solana",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/connect-solana",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/connect-solana",
+    "clean": "npx rimraf ./dist",
+    "dev": "tsup --watch",
+    "publish:preview": "yarn npm publish --tag preview",
+    "since-latest-release": "../../scripts/since-latest-release.sh",
+    "test": "vitest run",
+    "test:ci": "vitest run --coverage --coverage.reporter=text --silent",
+    "test:unit": "vitest run",
+    "test:verbose": "vitest run --reporter=verbose",
+    "test:watch": "vitest watch"
+  },
+  "dependencies": {
+    "@metamask/connect-multichain": "^0.5.3",
+    "@metamask/solana-wallet-standard": "^0.6.0",
+    "@wallet-standard/base": "^1.1.0"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/jsdom": "^21.1.7",
+    "@vitest/coverage-v8": "^3.2.4",
+    "jsdom": "^26.1.0",
+    "prettier": "^3.3.3",
+    "tsup": "^8.4.0",
+    "typedoc": "^0.28.14",
+    "typedoc-plugin-missing-exports": "^4.1.2",
+    "typescript": "^5.9.3",
+    "vitest": "^3.1.2"
+  },
+  "engines": {
+    "node": ">=20.19.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}