chore: rename MultichainSDK to MetaMaskConnectMultichain (#128)

* chore: rename MultichainSDK to MetaMaskConnectMultichain

* update variable names from multichainSDK to metamaskConnectMultichain

* revert changelog modifications

Author: adonesky1

packages/connect-multichain/src/index.browser.ts

@@ -2,7 +2,7 @@
 import './polyfills/buffer-shim';
 
 import type { CreateMultichainFN, StoreClient } from './domain';
-import { MultichainSDK } from './multichain';
+import { MetaMaskConnectMultichain } from './multichain';
 import { Store } from './store';
 import { ModalFactory } from './ui';
 
@@ -19,7 +19,7 @@ export const createMultichainClient: CreateMultichainFN = async (options) => {
     storage = options.storage;
   }
   const factory = new ModalFactory(uiModules);
-  return MultichainSDK.create({
+  return MetaMaskConnectMultichain.create({
     ...options,
     storage,
     ui: {

packages/connect-multichain/src/index.native.ts

@@ -2,7 +2,7 @@
 import './polyfills/buffer-shim';
 
 import type { CreateMultichainFN, StoreClient } from './domain';
-import { MultichainSDK } from './multichain';
+import { MetaMaskConnectMultichain } from './multichain';
 import { Store } from './store';
 import { ModalFactory } from './ui/index.native';
 
@@ -19,7 +19,7 @@ export const createMultichainClient: CreateMultichainFN = async (options) => {
     storage = options.storage;
   }
   const factory = new ModalFactory(uiModules);
-  return MultichainSDK.create({
+  return MetaMaskConnectMultichain.create({
     ...options,
     storage,
     ui: {

packages/connect-multichain/src/index.node.ts

@@ -1,5 +1,5 @@
 import type { CreateMultichainFN, StoreClient } from './domain';
-import { MultichainSDK } from './multichain';
+import { MetaMaskConnectMultichain } from './multichain';
 import { Store } from './store';
 import { ModalFactory } from './ui';
 
@@ -16,7 +16,7 @@ export const createMultichainClient: CreateMultichainFN = async (options) => {
     storage = options.storage;
   }
   const factory = new ModalFactory(uiModules);
-  return MultichainSDK.create({
+  return MetaMaskConnectMultichain.create({
     ...options,
     storage,
     ui: {

packages/connect-multichain/src/multichain/index.ts

@@ -66,7 +66,7 @@ export { getInfuraRpcUrls } from '../domain/multichain/api/infura';
 // ENFORCE NAMESPACE THAT CAN BE DISABLED
 const logger = createLogger('metamask-sdk:core');
 
-export class MultichainSDK extends MultichainCore {
+export class MetaMaskConnectMultichain extends MultichainCore {
   #provider: MultichainApiClient<RPCAPI>;
 
   #providerTransportWrapper: MultichainApiClientWrapperTransport;
@@ -146,8 +146,8 @@ export class MultichainSDK extends MultichainCore {
     this.#provider = getMultichainClient({ transport: this.#providerTransportWrapper });
   }
 
-  static async create(options: MultichainOptions): Promise<MultichainSDK> {
-    const instance = new MultichainSDK(options);
+  static async create(options: MultichainOptions): Promise<MetaMaskConnectMultichain> {
+    const instance = new MetaMaskConnectMultichain(options);
     const isEnabled = await isLoggerEnabled(
       'metamask-sdk:core',
       instance.options.storage,

packages/connect-multichain/src/multichain/transports/multichainApiClientWrapper/index.ts

@@ -7,7 +7,7 @@ import type {
 import { providerErrors } from '@metamask/rpc-errors';
 import type { CaipAccountId } from '@metamask/utils';
 import type { InvokeMethodOptions, RPCAPI, Scope } from 'src/domain';
-import type { MultichainSDK } from 'src/multichain';
+import type { MetaMaskConnectMultichain } from 'src/multichain';
 
 // uint32 (two's complement) max
 // more conservative than Number.MAX_SAFE_INTEGER
@@ -26,11 +26,11 @@ export class MultichainApiClientWrapperTransport implements Transport {
 
   private readonly notificationCallbacks = new Set<(data: unknown) => void>();
 
-  constructor(private readonly multichainSDK: MultichainSDK) {}
+  constructor(private readonly metamaskConnectMultichain: MetaMaskConnectMultichain) {}
 
   isTransportDefined(): boolean {
     try {
-      return Boolean(this.multichainSDK.transport);
+      return Boolean(this.metamaskConnectMultichain.transport);
     } catch (error) {
       return false;
     }
@@ -47,7 +47,7 @@ export class MultichainApiClientWrapperTransport implements Transport {
   }
 
   setupNotifcationListener() {
-    this.multichainSDK.transport.onNotification(
+    this.metamaskConnectMultichain.transport.onNotification(
       this.notifyCallbacks.bind(this),
     );
   }
@@ -104,7 +104,7 @@ export class MultichainApiClientWrapperTransport implements Transport {
       };
     }
 
-    return this.multichainSDK.transport.onNotification(callback);
+    return this.metamaskConnectMultichain.transport.onNotification(callback);
   }
 
   async #walletCreateSession(request: TransportRequestWithId) {
@@ -130,13 +130,13 @@ export class MultichainApiClientWrapperTransport implements Transport {
     const accounts = [...new Set(scopeAccounts)];
 
     console.log('📚 SDK connect');
-    await this.multichainSDK.connect(
+    await this.metamaskConnectMultichain.connect(
       scopes,
       accounts,
       createSessionParams.sessionProperties,
     );
     console.log('📚 SDK connected');
-    return this.multichainSDK.transport.request({
+    return this.metamaskConnectMultichain.transport.request({
       method: 'wallet_getSession',
     });
   }
@@ -151,7 +151,7 @@ export class MultichainApiClientWrapperTransport implements Transport {
         },
       };
     }
-    return this.multichainSDK.transport.request({
+    return this.metamaskConnectMultichain.transport.request({
       method: 'wallet_getSession',
     });
   }
@@ -162,7 +162,7 @@ export class MultichainApiClientWrapperTransport implements Transport {
     }
 
     try {
-      this.multichainSDK.disconnect();
+      this.metamaskConnectMultichain.disconnect();
       return { jsonrpc: '2.0', id: request.id, result: true };
     } catch (error) {
       return { jsonrpc: '2.0', id: request.id, result: false };
@@ -173,7 +173,7 @@ export class MultichainApiClientWrapperTransport implements Transport {
     if (!this.isTransportDefined()) {
       return { error: providerErrors.unauthorized() };
     }
-    const result = this.multichainSDK.invokeMethod(
+    const result = this.metamaskConnectMultichain.invokeMethod(
       request.params as InvokeMethodOptions,
     );
 

packages/connect-multichain/tests/fixtures.test.ts

@@ -19,7 +19,7 @@ import './mocks';
 import * as t from 'vitest';
 import { vi } from 'vitest';
 import type { MultichainOptions } from '../src/domain';
-import { MultichainSDK } from '../src/multichain';
+import { MetaMaskConnectMultichain } from '../src/multichain';
 
 // Import createSDK functions for convenience
 import { createMultichainClient as createMetamaskSDKWeb } from '../src/index.browser';
@@ -142,7 +142,7 @@ export const createTest: CreateTestFN = ({
   };
   let setupAnalyticsSpy!: t.MockInstance<any>;
   let initSpy!: t.MockInstance<any>;
-  let emitSpy!: t.MockInstance<MultichainSDK['emit']>;
+  let emitSpy!: t.MockInstance<MetaMaskConnectMultichain['emit']>;
   let showInstallModalSpy!: t.MockInstance<any>;
   let mockLogger!: t.MockInstance<debug.Debugger>;
   let mockDefaultTransport!: t.Mocked<any>;
@@ -260,7 +260,7 @@ export const createTest: CreateTestFN = ({
       // We'll spy on public methods or verify behavior through the public API instead
       initSpy = t.vi.fn() as any; // Placeholder - tests should verify behavior through public API
       setupAnalyticsSpy = t.vi.fn() as any; // Placeholder - tests should verify behavior through public API
-      emitSpy = t.vi.spyOn(MultichainSDK.prototype as any, 'emit');
+      emitSpy = t.vi.spyOn(MetaMaskConnectMultichain.prototype as any, 'emit');
       showInstallModalSpy = t.vi.fn() as any; // Placeholder - tests should verify behavior through public API
 
       mwpCoreActual.__mockStorage = nativeStorageStub.data;

packages/connect-multichain/tests/types.ts

@@ -4,7 +4,7 @@ import { SessionRequest } from '@metamask/mobile-wallet-protocol-core';
 import { DappClient } from '@metamask/mobile-wallet-protocol-dapp-client';
 import { Transport, SessionData } from '@metamask/multichain-api-client';
 import { MultichainOptions, MultichainCore } from '../src/domain';
-import { MultichainSDK } from '../src/multichain';
+import { MetaMaskConnectMultichain } from '../src/multichain';
 
 type GetItem = (key: string) => string | null;
 type SetItem = (key: string, value: string) => void;
@@ -22,7 +22,7 @@ export type NativeStorageStub = {
 export type MockedData = {
   initSpy: t.MockInstance<any>;
   setupAnalyticsSpy: t.MockInstance<any>;
-  emitSpy: t.MockInstance<MultichainSDK['emit']>;
+  emitSpy: t.MockInstance<MetaMaskConnectMultichain['emit']>;
   showInstallModalSpy: t.MockInstance<any>;
   nativeStorageStub: NativeStorageStub;
 

playground/node-playground/src/index.ts

@@ -30,14 +30,14 @@ const AVAILABLE_CHAINS = [
 const state: {
   app: AppState;
   connectorType: ConnectorType | null;
-  multichainSdk: Awaited<ReturnType<typeof createMultichainClient>> | null;
+  metamaskConnectMultichain: Awaited<ReturnType<typeof createMultichainClient>> | null;
   evmSdk: MetamaskConnectEVM | null;
   accounts: { [chainId: string]: string[] }; // Group accounts by chain
   spinner: Ora | null;
 } = {
   app: 'DISCONNECTED',
   connectorType: null,
-  multichainSdk: null,
+  metamaskConnectMultichain: null,
   evmSdk: null,
   accounts: {}, // Initialize as an empty object
   spinner: null,
@@ -141,7 +141,7 @@ const handleConnect = async () => {
   try {
     if (state.connectorType === 'multichain') {
       // Requesting accounts for Ethereum Mainnet and Solana Mainnet
-      await state.multichainSdk?.connect(
+      await state.metamaskConnectMultichain?.connect(
         ['eip155:1', 'solana:5eykt4UsFv8P8NJdTREpY1vzqKqZKvdp'],
         [],
       );
@@ -168,7 +168,7 @@ const handleDisconnect = async () => {
   state.spinner = ora('Disconnecting...').start();
   try {
     if (state.connectorType === 'multichain') {
-      await state.multichainSdk?.disconnect();
+      await state.metamaskConnectMultichain?.disconnect();
     } else if (state.connectorType === 'evm') {
       await state.evmSdk?.disconnect();
     }
@@ -210,7 +210,7 @@ const handleEthereumSign = async () => {
 
   try {
     if (state.connectorType === 'multichain') {
-      const result = await state.multichainSdk?.invokeMethod({
+      const result = await state.metamaskConnectMultichain?.invokeMethod({
         scope: chain,
         request: {
           method: 'personal_sign',
@@ -332,7 +332,7 @@ const handleSolanaSign = async () => {
   ).start();
 
   try {
-    const result = await state.multichainSdk?.invokeMethod({
+    const result = await state.metamaskConnectMultichain?.invokeMethod({
       scope: chain,
       request: {
         method: 'signMessage',
@@ -367,7 +367,7 @@ const main = async (): Promise<void> => {
   const supportedNetworks = getInfuraRpcUrls(infuraApiKey);
 
   // Initialize Multichain SDK
-  state.multichainSdk = await createMultichainClient({
+  state.metamaskConnectMultichain = await createMultichainClient({
     dapp: {
       name: 'Node.js Playground',
       url: 'https://playground.metamask.io',
@@ -452,7 +452,7 @@ const main = async (): Promise<void> => {
   });
 
   // --- Multichain SDK Event Handler ---
-  state.multichainSdk.on('wallet_sessionChanged', (session?: SessionData) => {
+  state.metamaskConnectMultichain.on('wallet_sessionChanged', (session?: SessionData) => {
     if (state.app !== 'CONNECTING') {
       // Only clear the console if we are not in the middle of a connection flow
       console.clear();