Commerce Build 3.9.8

packages/wallet-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coinbase/wallet-sdk",
-  "version": "3.9.7",
+  "version": "3.9.8",
   "description": "Coinbase Wallet JavaScript SDK",
   "keywords": [
     "cipher",

packages/wallet-sdk/src/core/util.ts

@@ -3,6 +3,7 @@
 
 import BN from 'bn.js';
 
+import { getCommerceCorrelationId } from '../telemetry/commerceCorrelationId';
 import { standardErrors } from './error';
 import { AddressString, BigIntString, HexString, IntNumber, RegExpString } from './type';
 
@@ -133,7 +134,7 @@
 
 export function ensureBN(val: unknown): BN {
   if (val !== null && (BN.isBN(val) || isBigNumber(val))) {
     return new BN((val as any).toString(10), 10);
   }
   if (typeof val === 'number') {
     return new BN(ensureIntNumber(val));
@@ -162,10 +163,10 @@
 }
 
 export function isBigNumber(val: unknown): boolean {
   if (val == null || typeof (val as any).constructor !== 'function') {
     return false;
   }
   const { constructor } = val as any;
   return typeof constructor.config === 'function' && typeof constructor.EUCLID === 'number';
 }
 
@@ -200,16 +201,21 @@
   serverUrl: string,
   isParentConnection: boolean,
   version: string,
-  chainId: number
+  chainId: number,
+  isMobileRelay?: boolean | undefined
 ): string {
   const sessionIdKey = isParentConnection ? 'parent-id' : 'id';
+  const commerceCorrelationId = getCommerceCorrelationId();
 
   const query = new URLSearchParams({
     [sessionIdKey]: sessionId,
     secret: sessionSecret,
     server: serverUrl,
     v: version,
     chainId: chainId.toString(),
+    pl: 't', // this is custom build of SDK for Payment Link
+    ...(isMobileRelay ? { m: 't' } : {}),
+    ...(commerceCorrelationId ? { cid: commerceCorrelationId } : {}),
   }).toString();
 
   const qrUrl = `${serverUrl}/#/link?${query}`;

packages/wallet-sdk/src/index.ts

@@ -8,6 +8,8 @@
 export { CoinbaseWalletProvider } from './provider/CoinbaseWalletProvider';
 export default CoinbaseWalletSDK;
 
+export { setCommerceCorrelationId } from './telemetry/commerceCorrelationId';
+
 declare global {
   interface Window {
     CoinbaseWalletSDK: typeof CoinbaseWalletSDK;
@@ -15,7 +17,7 @@
     /**
      * For CoinbaseWalletSDK, window.ethereum is `CoinbaseWalletProvider`
      */
     ethereum?: any;
     coinbaseWalletExtension?: CoinbaseWalletProvider;
 
     /**

packages/wallet-sdk/src/provider/CoinbaseWalletProvider.ts

@@ -27,6 +27,13 @@ import { RelayEventManager } from '../relay/RelayEventManager';
 import { Session } from '../relay/Session';
 import { EthereumTransactionParams } from '../relay/walletlink/type/EthereumTransactionParams';
 import { isErrorResponse, Web3Response } from '../relay/walletlink/type/Web3Response';
+import { getCommerceCorrelationId } from '../telemetry/commerceCorrelationId';
+import {
+  logRequestCompleted,
+  logRequestError,
+  logRequestStarted,
+} from '../telemetry/events/provider';
+import { parseErrorMessageFromAny } from '../telemetry/utils';
 import eip712 from '../vendor-js/eth-eip712-util';
 import { DiagnosticLogger, EVENTS } from './DiagnosticLogger';
 import { FilterPolyfill } from './FilterPolyfill';
@@ -37,8 +44,6 @@ import {
   SubscriptionResult,
 } from './SubscriptionManager';
 import { RequestArguments, Web3Provider } from './Web3Provider';
-import { logRequestCompleted, logRequestError, logRequestStarted } from '../telemetry/events/provider';
-import { parseErrorMessageFromAny } from '../telemetry/utils';
 
 const DEFAULT_CHAIN_ID_KEY = 'DefaultChainId';
 const DEFAULT_JSON_RPC_URL = 'DefaultJsonRpcUrl';
@@ -471,17 +476,19 @@ export class CoinbaseWalletProvider extends EventEmitter implements Web3Provider
   }
 
   public async request<T>(args: RequestArguments): Promise<T> {
-    logRequestStarted({ method: args.method });
+    const commerceCorrelationId = getCommerceCorrelationId();
+    logRequestStarted({ method: args.method, commerceCorrelationId });
     try {
       const result = await this._request<T>(args).catch((error) => {
         throw serializeError(error, args.method);
       });
-      logRequestCompleted({ method: args.method });
+      logRequestCompleted({ method: args.method, commerceCorrelationId });
       return result;
     } catch (error) {
       logRequestError({
         method: args.method,
         errorMessage: parseErrorMessageFromAny(error),
+        commerceCorrelationId,
       });
       return Promise.reject(serializeError(error, args.method));
     }

packages/wallet-sdk/src/relay/mobile/MobileRelay.ts

@@ -1,4 +1,6 @@
-import { getLocation } from '../../core/util';
+import { createQrUrl, getLocation } from '../../core/util';
+import { getCommerceCorrelationId } from '../../telemetry/commerceCorrelationId';
+import { logMobileWalletLinkRequestAccountsDeeplinked } from '../../telemetry/events/walletlink';
 import { CancelablePromise } from '../RelayAbstract';
 import { WalletLinkResponseEventData } from '../walletlink/type/WalletLinkEventData';
 import { Web3Request } from '../walletlink/type/Web3Request';
@@ -41,10 +43,13 @@ export class MobileRelay extends WalletLinkRelay {
     // For mobile relay requests, open the Coinbase Wallet app
     switch (request.method) {
       case 'requestEthereumAccounts':
-      case 'connectAndSignIn':
+      case 'connectAndSignIn': {
         navigatedToCBW = true;
+        const commerceCorrelationId = getCommerceCorrelationId();
+        logMobileWalletLinkRequestAccountsDeeplinked({ commerceCorrelationId });
         this.ui.openCoinbaseWalletDeeplink(this.getQRCodeUrl());
         break;
+      }
       case 'switchEthereumChain':
         // switchEthereumChain doesn't need to open the app
         return;
@@ -73,6 +78,19 @@ export class MobileRelay extends WalletLinkRelay {
     }
   }
 
+  // override
+  getQRCodeUrl() {
+    return createQrUrl(
+      this._session.id,
+      this._session.secret,
+      this.linkAPIUrl,
+      false,
+      this.options.version,
+      this.dappDefaultChain,
+      true // adding isMobileWalletlink flag to the query params
+    );
+  }
+
   // override
   handleWeb3ResponseMessage(message: WalletLinkResponseEventData) {
     super.handleWeb3ResponseMessage(message);

packages/wallet-sdk/src/relay/walletlink/WalletLinkRelay.ts

@@ -49,17 +49,17 @@ export interface WalletLinkRelayOptions {
 export class WalletLinkRelay extends RelayAbstract implements WalletLinkConnectionUpdateListener {
   private static accountRequestCallbackIds = new Set<string>();
 
-  private readonly linkAPIUrl: string;
+  protected readonly linkAPIUrl: string;
   protected readonly storage: ScopedLocalStorage;
-  private _session: Session;
+  protected _session: Session;
   private readonly relayEventManager: RelayEventManager;
   protected readonly diagnostic?: DiagnosticLogger;
   protected connection: WalletLinkConnection;
   private accountsCallback: ((account: string[], isDisconnect?: boolean) => void) | null = null;
   private chainCallbackParams = { chainId: '', jsonRpcUrl: '' }; // to implement distinctUntilChanged
   private chainCallback: ((chainId: string, jsonRpcUrl: string) => void) | null = null;
   protected dappDefaultChain = 1;
-  private readonly options: WalletLinkRelayOptions;
+  protected readonly options: WalletLinkRelayOptions;
 
   protected ui: RelayUI;
 

packages/wallet-sdk/src/telemetry/commerceCorrelationId.ts

@@ -0,0 +1,9 @@
+let commerceCorrelationId: string | null = null;
+
+export function setCommerceCorrelationId(id: string) {
+  commerceCorrelationId = id;
+}
+
+export function getCommerceCorrelationId() {
+  return commerceCorrelationId;
+}

packages/wallet-sdk/src/telemetry/events/provider.ts

@@ -1,12 +1,19 @@
 import { ActionType, AnalyticsEventImportance, ComponentType, logEvent } from '../logEvent';
 
-export function logRequestStarted({ method }: { method: string }) {
+export function logRequestStarted({
+  method,
+  commerceCorrelationId,
+}: {
+  method: string;
+  commerceCorrelationId: string | null;
+}) {
   logEvent(
     'commerce.sdk.request_started',
     {
       action: ActionType.measurement,
       componentType: ComponentType.unknown,
       method,
+      commerceCorrelationId: commerceCorrelationId ?? '',
     },
     AnalyticsEventImportance.high
   );
@@ -15,9 +22,11 @@ export function logRequestStarted({ method }: { method: string }) {
 export function logRequestError({
   method,
   errorMessage,
+  commerceCorrelationId,
 }: {
   method: string;
   errorMessage: string;
+  commerceCorrelationId: string | null;
 }) {
   logEvent(
     'commerce.sdk.request_error',
@@ -26,18 +35,26 @@ export function logRequestError({
       componentType: ComponentType.unknown,
       method,
       errorMessage,
+      commerceCorrelationId: commerceCorrelationId ?? '',
     },
     AnalyticsEventImportance.high
   );
 }
 
-export function logRequestCompleted({ method }: { method: string }) {
+export function logRequestCompleted({
+  method,
+  commerceCorrelationId,
+}: {
+  method: string;
+  commerceCorrelationId: string | null;
+}) {
   logEvent(
     'commerce.sdk.request_completed',
     {
       action: ActionType.measurement,
       componentType: ComponentType.unknown,
       method,
+      commerceCorrelationId: commerceCorrelationId ?? '',
     },
     AnalyticsEventImportance.high
   );

packages/wallet-sdk/src/telemetry/events/walletlink.ts

@@ -20,4 +20,20 @@ export const logWalletLinkConnectionFetchUnseenEventsFailed = () => {
     },
     AnalyticsEventImportance.high
   );
+};
+
+export const logMobileWalletLinkRequestAccountsDeeplinked = ({
+  commerceCorrelationId,
+}: {
+  commerceCorrelationId: string | null;
+}) => {
+  logEvent(
+    'commerce.walletlink_connection.mobile_request_accounts_deeplinked',
+    {
+      action: ActionType.measurement,
+      componentType: ComponentType.unknown,
+      commerceCorrelationId: commerceCorrelationId ?? '',
+    },
+    AnalyticsEventImportance.high
+  );
 };

packages/wallet-sdk/src/version.ts

@@ -1 +1 @@
-export const LIB_VERSION = '3.9.7';
+export const LIB_VERSION = '3.9.8';