@metamask/connect-multichain 0.1.0 → 0.2.1

package/dist/browser/umd/connect-multichain.d.ts

@@ -1,5 +1,5 @@
 import debug from 'debug';
-import { SessionData, Transport, MultichainApiClient } from '@metamask/multichain-api-client';
+import { SessionData, Transport, TransportRequest, TransportResponse, MultichainApiClient } from '@metamask/multichain-api-client';
 export { SessionData } from '@metamask/multichain-api-client';
 import { CaipAccountId, Json } from '@metamask/utils';
 import { SessionRequest } from '@metamask/mobile-wallet-protocol-core';
@@ -84,6 +84,32 @@ declare class EventEmitter<TEvents extends Record<string, unknown[]>> {
      * @param handler - The specific handler function to remove
      */
     off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
+    /**
+     * Removes a specific event handler for the specified event.
+     * Added for compatibility as some libraries use this method name.
+     *
+     * @template TEventName - The name of the event to remove the handler from (must be a key of TEvents)
+     * @param eventName - The name of the event to remove the handler from
+     * @param handler - The specific handler function to remove
+     */
+    removeListener<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void;
+    /**
+     * Registers an event handler for the specified event that will only be called once.
+     *
+     * @template TEventName - The name of the event to listen for (must be a key of TEvents)
+     * @param eventName - The name of the event to listen for
+     * @param handler - The function to call when the event is emitted (only once)
+     * @returns A function to remove the listener
+     */
+    once<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): () => void;
+    /**
+     * Returns the number of listeners registered for the specified event.
+     *
+     * @template TEventName - The name of the event to count listeners for (must be a key of TEvents)
+     * @param eventName - The name of the event to count listeners for
+     * @returns The number of listeners registered for the event
+     */
+    listenerCount<TEventName extends keyof TEvents & string>(eventName: TEventName): number;
 }
 
 type StoreOptions = Record<string, any>;
@@ -304,7 +330,7 @@ declare class ModalFactory<T extends FactoryModals = FactoryModals> {
     createUniversalLink(connectionRequest?: ConnectionRequest): string;
     private onCloseModal;
     private onStartDesktopOnboarding;
-    renderInstallModal(preferDesktop: boolean, createConnectionRequest: () => Promise<ConnectionRequest>, successCallback: (error?: Error) => Promise<void>): Promise<void>;
+    renderInstallModal(showInstallModal: boolean, createConnectionRequest: () => Promise<ConnectionRequest>, successCallback: (error?: Error) => Promise<void>): Promise<void>;
     renderOTPCodeModal(createOTPCode: () => Promise<OTPCode>, successCallback: (error?: Error) => Promise<void>, updateOTPCode: (otpCode: OTPCode, modal: AbstractOTPCodeModal) => void): Promise<void>;
 }
 
@@ -361,11 +387,9 @@ type MultichainOptions = {
     /** Dapp identification and branding settings */
     dapp: DappSettings;
     /** Optional API configuration for external services */
-    api?: {
-        /** The Infura API key to use for RPC requests */
-        infuraAPIKey?: string;
-        /** A map of RPC URLs to use for read-only requests */
-        readonlyRPCMap?: RpcUrlsMap;
+    api: {
+        /** A map of `caipChainIds` -> RPC Urls for all networks supported by the app*/
+        supportedNetworks: RpcUrlsMap;
     };
     /** Analytics configuration */
     analytics?: {
@@ -381,7 +405,7 @@ type MultichainOptions = {
         factory: ModalFactory;
         headless?: boolean;
         preferExtension?: boolean;
-        preferDesktop?: boolean;
+        showInstallModal?: boolean;
     };
     mobile?: {
         preferredOpenLink?: (deeplink: string, target?: string) => void;
@@ -415,7 +439,11 @@ type ExtendedTransport = Omit<Transport, 'connect'> & {
     connect: (props?: {
         scopes: Scope[];
         caipAccountIds: CaipAccountId[];
+        forceRequest?: boolean;
     }) => Promise<void>;
+    sendEip1193Message: <TRequest extends TransportRequest, TResponse extends TransportResponse>(request: TRequest, options?: {
+        timeout?: number;
+    }) => Promise<TResponse>;
 };
 
 declare const infuraRpcUrls: RpcUrlsMap;
@@ -427,7 +455,7 @@ declare function getInfuraRpcUrls(infuraAPIKey: string): RpcUrlsMap;
 type SDKState = 'pending' | 'loaded' | 'disconnected' | 'connected' | 'connecting';
 declare enum TransportType {
     Browser = "browser",
-    MPW = "mwp",
+    MWP = "mwp",
     UNKNOWN = "unknown"
 }
 /**
@@ -441,13 +469,14 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
     abstract storage: StoreClient;
     abstract state: SDKState;
     abstract provider: MultichainApiClient<RPCAPI>;
-    abstract transport: Transport;
+    abstract transport: ExtendedTransport;
+    abstract transportType: TransportType;
     /**
      * Establishes a connection to the multichain provider, or re-use existing session
      *
      * @returns Promise that resolves to the session data
      */
-    abstract connect(scopes: Scope[], caipAccountIds: CaipAccountId[]): Promise<void>;
+    abstract connect(scopes: Scope[], caipAccountIds: CaipAccountId[], forceRequest?: boolean): Promise<void>;
     /**
      * Disconnects from the multichain provider.
      *
@@ -461,6 +490,7 @@ declare abstract class MultichainCore extends EventEmitter<SDKEvents> {
      * @returns Promise that resolves to the method result
      */
     abstract invokeMethod(options: InvokeMethodOptions): Promise<Json>;
+    abstract openDeeplinkIfNeeded(): void;
     constructor(options: MultichainOptions);
 }
 declare function getTransportType(type: string): TransportType;
@@ -534,7 +564,7 @@ type ModalFactoryOptions = Pick<MultichainOptions, 'mobile' | 'transport'> & {
     ui: {
         headless?: boolean;
         preferExtension?: boolean;
-        preferDesktop?: boolean;
+        showInstallModal?: boolean;
     };
     onConnection: (transport: Transport, options: ModalFactoryConnectOptions) => Promise<void>;
     getCurrentSession: () => Promise<SessionData | undefined>;
@@ -573,6 +603,30 @@ declare abstract class Modal<Options, Data extends DataType = DataType> {
     set data(data: Data);
 }
 
+/**
+ * Checks if an error represents a user rejection.
+ *
+ * @param error - The error object to check
+ * @returns True if the error indicates a user rejection, false otherwise
+ */
+declare function isRejectionError(error: unknown): boolean;
+/**
+ * Gets analytics properties specific to wallet action events.
+ *
+ * @param options - Multichain options containing dapp and analytics config
+ * @param storage - Storage client for getting anonymous ID
+ * @param invokeOptions - The invoke method options containing method and scope
+ * @returns Wallet action analytics properties
+ */
+declare function getWalletActionAnalyticsProperties(options: MultichainOptions, storage: StoreClient, invokeOptions: InvokeMethodOptions): Promise<{
+    mmconnect_version: string;
+    dapp_id: string;
+    method: string;
+    integration_type: string;
+    caip_chain_id: string;
+    anon_id: string;
+}>;
+
 /**
  * Returns the version of the Multichain SDK.
  *
@@ -582,4 +636,4 @@ declare function getVersion(): string;
 
 declare const createMetamaskConnect: CreateMultichainFN;
 
-export { type ConnectionRequest, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, type SDKState, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMetamaskConnect, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isSecure };
+export { type ConnectionRequest, type CreateMultichainFN, type DappSettings, type DataType, type DomainErrorCodes, type Enumerate, type ErrorCodeRange, type ErrorCodes, EventEmitter, type EventTypes, type ExtendedTransport, type InstallWidgetProps, type InvokeMethodOptions, type LoggerNameSpaces, Modal, type ModalFactoryConnectOptions, type ModalFactoryOptions, MultichainCore, type MultichainOptions, type NotificationCallback, type OTPCode, type OTPCodeWidgetProps, PlatformType, type QRLink, type RPCAPI, type RPCErrorCodes, RPCHttpErr, RPCInvokeMethodErr, RPCReadonlyRequestErr, RPCReadonlyResponseErr, type RPCResponse, RPC_HANDLED_METHODS, type RpcMethod, type RpcUrlsMap, type SDKEvents, type SDKState, SDK_HANDLED_METHODS, type Scope, type StorageErrorCodes, StoreAdapter, StoreClient, type StoreOptions, TransportType, createLogger, createMetamaskConnect, enableDebug, getInfuraRpcUrls, getPlatformType, getTransportType, getVersion, getWalletActionAnalyticsProperties, hasExtension, infuraRpcUrls, isEnabled, isMetamaskExtensionInstalled, isRejectionError, isSecure };