@aptos-labs/wallet-adapter-core 3.8.0 → 3.10.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @aptos-labs/wallet-adapter-core
 
+## 3.10.0
+
+### Minor Changes
+
+- 41f9485: Implement GA4
+
+## 3.9.0
+
+### Minor Changes
+
+- 6be2a06: Convert uppercase network name to lowercase in NetworkInfo
+
 ## 3.8.0
 
 ### Minor Changes

package/dist/index.d.ts

@@ -187,6 +187,7 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
     private readonly walletStandardCore;
     private _connecting;
     private _connected;
+    private readonly ga4;
     /**
      * Core functionality constructor.
      * For legacy wallet adapter v1 support we expect the dapp to pass in wallet plugins,
@@ -206,6 +207,7 @@ declare class WalletCore extends EventEmitter<WalletCoreEvents> {
      * @param standardWallet An AIP-62 standard compatible wallet
      */
     private standardizeStandardWalletToPluginWalletType;
+    private recordEvent;
     /**
      * Helper function to ensure wallet exists
      *

package/dist/index.js

@@ -514,6 +514,41 @@ var WalletStandardCore = class {
   }
 };
 
+// src/ga/index.ts
+var GA4 = class {
+  constructor() {
+    this.aptosGAID = "G-GNVVWBL3J9";
+    this.injectGA(this.aptosGAID);
+  }
+  gtag(a, b, c) {
+    let dataLayer = window.dataLayer || [];
+    dataLayer.push(arguments);
+  }
+  injectGA(gaID) {
+    if (typeof window === "undefined")
+      return;
+    if (!gaID)
+      return;
+    const head = document.getElementsByTagName("head")[0];
+    var myScript = document.createElement("script");
+    myScript.setAttribute(
+      "src",
+      `https://www.googletagmanager.com/gtag/js?id=${gaID}`
+    );
+    const that = this;
+    myScript.onload = function() {
+      that.gtag("js", new Date());
+      that.gtag("config", `${gaID}`, {
+        send_page_view: false
+      });
+    };
+    head.insertBefore(myScript, head.children[1]);
+  }
+};
+
+// src/version.ts
+var WALLET_ADAPTER_CORE_VERSION = "3.10.0";
+
 // src/WalletCore.ts
 var WalletCore = class extends import_eventemitter32.default {
   constructor(plugins) {
@@ -528,6 +563,7 @@ var WalletCore = class extends import_eventemitter32.default {
     this.walletStandardCore = new WalletStandardCore();
     this._connecting = false;
     this._connected = false;
+    this.ga4 = new GA4();
     this.standardizeStandardWalletToPluginWalletType = (standardWallet) => {
       var _a, _b;
       let standardWalletConvertedToWallet = {
@@ -604,6 +640,16 @@ var WalletCore = class extends import_eventemitter32.default {
     });
     this._standard_wallets = aptosStandardWallets;
   }
+  recordEvent(eventName, additionalInfo) {
+    var _a, _b;
+    this.ga4.gtag("event", `wallet_adapter_${eventName}`, {
+      wallet: (_a = this._wallet) == null ? void 0 : _a.name,
+      network: (_b = this._network) == null ? void 0 : _b.name,
+      adapter_core_version: WALLET_ADAPTER_CORE_VERSION,
+      send_to: "G-GNVVWBL3J9",
+      ...additionalInfo
+    });
+  }
   ensureWalletExists(wallet) {
     if (!wallet) {
       throw new WalletNotConnectedError().name;
@@ -683,21 +729,32 @@ var WalletCore = class extends import_eventemitter32.default {
     return;
   }
   setNetwork(network) {
-    var _a;
+    var _a, _b, _c;
     if (network === null) {
       this._network = null;
       return;
     }
     if ((_a = this._wallet) == null ? void 0 : _a.isAIP62Standard) {
       const standardizeNetwork = network;
+      this.recordEvent("network_change", {
+        from: (_b = this._network) == null ? void 0 : _b.name,
+        to: standardizeNetwork.name
+      });
       this._network = {
-        name: standardizeNetwork.name,
+        name: standardizeNetwork.name.toLowerCase(),
         chainId: standardizeNetwork.chainId.toString(),
         url: standardizeNetwork.url
       };
       return;
     }
-    this._network = { ...network };
+    this.recordEvent("network_change", {
+      from: (_c = this._network) == null ? void 0 : _c.name,
+      to: network.name
+    });
+    this._network = {
+      ...network,
+      name: network.name.toLowerCase()
+    };
   }
   isConnected() {
     return this._connected;
@@ -784,6 +841,7 @@ var WalletCore = class extends import_eventemitter32.default {
       await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
+      this.recordEvent("wallet_connect");
       this.emit("connect", account);
     } catch (error) {
       this.clearData();
@@ -798,6 +856,7 @@ var WalletCore = class extends import_eventemitter32.default {
       this.ensureWalletExists(this._wallet);
       await this._wallet.disconnect();
       this.clearData();
+      this.recordEvent("wallet_disconnect");
       this.emit("disconnect");
     } catch (error) {
       const errMsg = generalizedErrorMessage(error);
@@ -808,6 +867,7 @@ var WalletCore = class extends import_eventemitter32.default {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
+      this.recordEvent("sign_and_submit_transaction");
       const payloadData = transactionInput.data;
       const aptosConfig = new import_ts_sdk5.AptosConfig({
         network: convertNetwork(this._network)
@@ -852,7 +912,7 @@ var WalletCore = class extends import_eventemitter32.default {
     var _a, _b;
     try {
       this.ensureWalletExists(this._wallet);
-      console.log("this._account", this._account);
+      this.recordEvent("sign_transaction");
       if (this._wallet.signTransaction) {
         if (this._wallet.isAIP62Standard) {
           if ("rawTransaction" in transactionOrPayload) {
@@ -909,6 +969,7 @@ var WalletCore = class extends import_eventemitter32.default {
   async signMessage(message) {
     try {
       this.ensureWalletExists(this._wallet);
+      this.recordEvent("sign_message");
       if (this._wallet.isAIP62Standard) {
         return await this.walletStandardCore.signMessage(message, this._wallet);
       }
@@ -923,11 +984,15 @@ var WalletCore = class extends import_eventemitter32.default {
   async submitTransaction(transaction) {
     try {
       this.ensureWalletExists(this._wallet);
+      const { additionalSignersAuthenticators } = transaction;
+      const transactionType = additionalSignersAuthenticators !== void 0 ? "multi-agent" : "simple";
+      this.recordEvent("submit_transaction", {
+        transaction_type: transactionType
+      });
       if (this._wallet.submitTransaction) {
         const pendingTransaction = await this._wallet.submitTransaction(transaction);
         return pendingTransaction;
       }
-      const { additionalSignersAuthenticators } = transaction;
       const aptosConfig = new import_ts_sdk5.AptosConfig({
         network: convertNetwork(this.network)
       });
@@ -953,6 +1018,7 @@ var WalletCore = class extends import_eventemitter32.default {
         async (data) => {
           this.setAccount(data);
           await this.setAnsName();
+          this.recordEvent("account_change");
           this.emit("accountChange", this._account);
         }
       );
@@ -980,6 +1046,7 @@ var WalletCore = class extends import_eventemitter32.default {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
+      this.recordEvent("sign_message_and_verify");
       if (this._wallet.isAIP62Standard) {
         return this.walletStandardCore.signMessageAndVerify(
           message,

package/dist/index.mjs

@@ -489,6 +489,41 @@ var WalletStandardCore = class {
   }
 };
 
+// src/ga/index.ts
+var GA4 = class {
+  constructor() {
+    this.aptosGAID = "G-GNVVWBL3J9";
+    this.injectGA(this.aptosGAID);
+  }
+  gtag(a, b, c) {
+    let dataLayer = window.dataLayer || [];
+    dataLayer.push(arguments);
+  }
+  injectGA(gaID) {
+    if (typeof window === "undefined")
+      return;
+    if (!gaID)
+      return;
+    const head = document.getElementsByTagName("head")[0];
+    var myScript = document.createElement("script");
+    myScript.setAttribute(
+      "src",
+      `https://www.googletagmanager.com/gtag/js?id=${gaID}`
+    );
+    const that = this;
+    myScript.onload = function() {
+      that.gtag("js", new Date());
+      that.gtag("config", `${gaID}`, {
+        send_page_view: false
+      });
+    };
+    head.insertBefore(myScript, head.children[1]);
+  }
+};
+
+// src/version.ts
+var WALLET_ADAPTER_CORE_VERSION = "3.10.0";
+
 // src/WalletCore.ts
 var WalletCore = class extends EventEmitter2 {
   constructor(plugins) {
@@ -503,6 +538,7 @@ var WalletCore = class extends EventEmitter2 {
     this.walletStandardCore = new WalletStandardCore();
     this._connecting = false;
     this._connected = false;
+    this.ga4 = new GA4();
     this.standardizeStandardWalletToPluginWalletType = (standardWallet) => {
       var _a, _b;
       let standardWalletConvertedToWallet = {
@@ -579,6 +615,16 @@ var WalletCore = class extends EventEmitter2 {
     });
     this._standard_wallets = aptosStandardWallets;
   }
+  recordEvent(eventName, additionalInfo) {
+    var _a, _b;
+    this.ga4.gtag("event", `wallet_adapter_${eventName}`, {
+      wallet: (_a = this._wallet) == null ? void 0 : _a.name,
+      network: (_b = this._network) == null ? void 0 : _b.name,
+      adapter_core_version: WALLET_ADAPTER_CORE_VERSION,
+      send_to: "G-GNVVWBL3J9",
+      ...additionalInfo
+    });
+  }
   ensureWalletExists(wallet) {
     if (!wallet) {
       throw new WalletNotConnectedError().name;
@@ -658,21 +704,32 @@ var WalletCore = class extends EventEmitter2 {
     return;
   }
   setNetwork(network) {
-    var _a;
+    var _a, _b, _c;
     if (network === null) {
       this._network = null;
       return;
     }
     if ((_a = this._wallet) == null ? void 0 : _a.isAIP62Standard) {
       const standardizeNetwork = network;
+      this.recordEvent("network_change", {
+        from: (_b = this._network) == null ? void 0 : _b.name,
+        to: standardizeNetwork.name
+      });
       this._network = {
-        name: standardizeNetwork.name,
+        name: standardizeNetwork.name.toLowerCase(),
         chainId: standardizeNetwork.chainId.toString(),
         url: standardizeNetwork.url
       };
       return;
     }
-    this._network = { ...network };
+    this.recordEvent("network_change", {
+      from: (_c = this._network) == null ? void 0 : _c.name,
+      to: network.name
+    });
+    this._network = {
+      ...network,
+      name: network.name.toLowerCase()
+    };
   }
   isConnected() {
     return this._connected;
@@ -759,6 +816,7 @@ var WalletCore = class extends EventEmitter2 {
       await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
+      this.recordEvent("wallet_connect");
       this.emit("connect", account);
     } catch (error) {
       this.clearData();
@@ -773,6 +831,7 @@ var WalletCore = class extends EventEmitter2 {
       this.ensureWalletExists(this._wallet);
       await this._wallet.disconnect();
       this.clearData();
+      this.recordEvent("wallet_disconnect");
       this.emit("disconnect");
     } catch (error) {
       const errMsg = generalizedErrorMessage(error);
@@ -783,6 +842,7 @@ var WalletCore = class extends EventEmitter2 {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
+      this.recordEvent("sign_and_submit_transaction");
       const payloadData = transactionInput.data;
       const aptosConfig = new AptosConfig2({
         network: convertNetwork(this._network)
@@ -827,7 +887,7 @@ var WalletCore = class extends EventEmitter2 {
     var _a, _b;
     try {
       this.ensureWalletExists(this._wallet);
-      console.log("this._account", this._account);
+      this.recordEvent("sign_transaction");
       if (this._wallet.signTransaction) {
         if (this._wallet.isAIP62Standard) {
           if ("rawTransaction" in transactionOrPayload) {
@@ -884,6 +944,7 @@ var WalletCore = class extends EventEmitter2 {
   async signMessage(message) {
     try {
       this.ensureWalletExists(this._wallet);
+      this.recordEvent("sign_message");
       if (this._wallet.isAIP62Standard) {
         return await this.walletStandardCore.signMessage(message, this._wallet);
       }
@@ -898,11 +959,15 @@ var WalletCore = class extends EventEmitter2 {
   async submitTransaction(transaction) {
     try {
       this.ensureWalletExists(this._wallet);
+      const { additionalSignersAuthenticators } = transaction;
+      const transactionType = additionalSignersAuthenticators !== void 0 ? "multi-agent" : "simple";
+      this.recordEvent("submit_transaction", {
+        transaction_type: transactionType
+      });
       if (this._wallet.submitTransaction) {
         const pendingTransaction = await this._wallet.submitTransaction(transaction);
         return pendingTransaction;
       }
-      const { additionalSignersAuthenticators } = transaction;
       const aptosConfig = new AptosConfig2({
         network: convertNetwork(this.network)
       });
@@ -928,6 +993,7 @@ var WalletCore = class extends EventEmitter2 {
         async (data) => {
           this.setAccount(data);
           await this.setAnsName();
+          this.recordEvent("account_change");
           this.emit("accountChange", this._account);
         }
       );
@@ -955,6 +1021,7 @@ var WalletCore = class extends EventEmitter2 {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
+      this.recordEvent("sign_message_and_verify");
       if (this._wallet.isAIP62Standard) {
         return this.walletStandardCore.signMessageAndVerify(
           message,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aptos-labs/wallet-adapter-core",
-  "version": "3.8.0",
+  "version": "3.10.0",
   "description": "Aptos Wallet Adapter Core",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",
@@ -29,6 +29,7 @@
   ],
   "devDependencies": {
     "@types/jest": "^29.2.4",
+    "@types/node": "^20.10.4",
     "eslint": "^8.15.0",
     "jest": "^29.3.1",
     "ts-jest": "^29.0.3",
@@ -48,8 +49,10 @@
     "aptos": "^1.21.0"
   },
   "scripts": {
-    "build": "tsup src/index.ts --format esm,cjs --dts",
-    "dev": "tsup src/index.ts --format esm,cjs --watch --dts",
+    "update-version": "node -p \"'export const WALLET_ADAPTER_CORE_VERSION = ' + JSON.stringify(require('./package.json').version) + ';'\" > src/version.ts",
+    "build-package": "export $(cat .env | xargs) && tsup src/index.ts --format esm,cjs --dts --env.GAID $GAID",
+    "build": "pnpm run update-version && pnpm run build-package",
+    "dev": "export $(cat .env | xargs) && tsup src/index.ts --format esm,cjs --watch --dts --env.GAID $GAID",
     "test": "jest",
     "lint": "TIMING=1 eslint \"src/**/*.ts*\"",
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf dist"

package/src/WalletCore.ts

@@ -1,5 +1,6 @@
 import { TxnBuilderTypes, Types, BCS } from "aptos";
 import {
+  Network,
   AnyRawTransaction,
   AccountAuthenticator,
   AccountAuthenticatorEd25519,
@@ -62,6 +63,8 @@ import {
   AptosStandardWallet,
   WalletStandardCore,
 } from "./AIP62StandardWallets/WalletStandard";
+import { GA4 } from "./ga";
+import { WALLET_ADAPTER_CORE_VERSION } from "./version";
 
 export type IAptosWallet = AptosStandardWallet & Wallet;
 
@@ -98,6 +101,9 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   // Indicates whether the dapp is connected with a wallet
   private _connected: boolean = false;
 
+  // Google Analytics 4 module
+  private readonly ga4: GA4 = new GA4();
+
   /**
    * Core functionality constructor.
    * For legacy wallet adapter v1 support we expect the dapp to pass in wallet plugins,
@@ -215,6 +221,16 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     this.emit("standardWalletsAdded", standardWalletConvertedToWallet);
   };
 
+  private recordEvent(eventName: string, additionalInfo?: object) {
+    this.ga4.gtag("event", `wallet_adapter_${eventName}`, {
+      wallet: this._wallet?.name,
+      network: this._network?.name,
+      adapter_core_version: WALLET_ADAPTER_CORE_VERSION,
+      send_to: process.env.GAID,
+      ...additionalInfo,
+    });
+  }
+
   /**
    * Helper function to ensure wallet exists
    *
@@ -382,14 +398,27 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     }
     if (this._wallet?.isAIP62Standard) {
       const standardizeNetwork = network as StandardNetworkInfo;
+      this.recordEvent("network_change", {
+        from: this._network?.name,
+        to: standardizeNetwork.name,
+      });
       this._network = {
-        name: standardizeNetwork.name,
+        name: standardizeNetwork.name.toLowerCase() as Network,
         chainId: standardizeNetwork.chainId.toString(),
         url: standardizeNetwork.url,
       };
+
       return;
     }
-    this._network = { ...(network as NetworkInfo) };
+
+    this.recordEvent("network_change", {
+      from: this._network?.name,
+      to: network.name,
+    });
+    this._network = {
+      ...(network as NetworkInfo),
+      name: network.name.toLowerCase() as Network,
+    };
   }
 
   /**
@@ -542,6 +571,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       await this.setAnsName();
       setLocalStorage(selectedWallet.name);
       this._connected = true;
+      this.recordEvent("wallet_connect");
       this.emit("connect", account);
     } catch (error: any) {
       this.clearData();
@@ -564,6 +594,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       this.ensureWalletExists(this._wallet);
       await this._wallet.disconnect();
       this.clearData();
+      this.recordEvent("wallet_disconnect");
       this.emit("disconnect");
     } catch (error: any) {
       const errMsg = generalizedErrorMessage(error);
@@ -586,7 +617,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
-
+      this.recordEvent("sign_and_submit_transaction");
       // get the payload piece from the input
       const payloadData = transactionInput.data;
       const aptosConfig = new AptosConfig({
@@ -658,7 +689,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   ): Promise<AccountAuthenticator> {
     try {
       this.ensureWalletExists(this._wallet);
-      console.log("this._account", this._account);
+      this.recordEvent("sign_transaction");
       // Make sure wallet supports signTransaction
       if (this._wallet.signTransaction) {
         // If current connected wallet is AIP-62 standard compatible
@@ -749,7 +780,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
   async signMessage(message: SignMessagePayload): Promise<SignMessageResponse> {
     try {
       this.ensureWalletExists(this._wallet);
-
+      this.recordEvent("sign_message");
       if (this._wallet.isAIP62Standard) {
         return await this.walletStandardCore.signMessage(message, this._wallet);
       }
@@ -774,6 +805,14 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     try {
       this.ensureWalletExists(this._wallet);
 
+      const { additionalSignersAuthenticators } = transaction;
+      const transactionType =
+        additionalSignersAuthenticators !== undefined
+          ? "multi-agent"
+          : "simple";
+      this.recordEvent("submit_transaction", {
+        transaction_type: transactionType,
+      });
       // If wallet supports submitTransaction transaction function
       if (this._wallet.submitTransaction) {
         const pendingTransaction =
@@ -782,7 +821,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
       }
 
       // Else have the adpater submits the transaction
-      const { additionalSignersAuthenticators } = transaction;
+
       const aptosConfig = new AptosConfig({
         network: convertNetwork(this.network),
       });
@@ -814,6 +853,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
         async (data: AccountInfo | StandardAccountInfo) => {
           this.setAccount(data);
           await this.setAnsName();
+          this.recordEvent("account_change");
           this.emit("accountChange", this._account);
         }
       );
@@ -853,7 +893,7 @@ export class WalletCore extends EventEmitter<WalletCoreEvents> {
     try {
       this.ensureWalletExists(this._wallet);
       this.ensureAccountExists(this._account);
-
+      this.recordEvent("sign_message_and_verify");
       // If current connected wallet is AIP-62 standard compatible
       if (this._wallet.isAIP62Standard) {
         return this.walletStandardCore.signMessageAndVerify(

package/src/ga/index.ts

@@ -0,0 +1,37 @@
+export class GA4 {
+  readonly aptosGAID: string | undefined = process.env.GAID;
+
+  constructor() {
+    // Inject Aptos Google Analytics 4 script
+    this.injectGA(this.aptosGAID);
+  }
+
+  gtag(a: string, b: string | object, c?: object) {
+    let dataLayer = (window as any).dataLayer || [];
+    dataLayer.push(arguments);
+  }
+
+  private injectGA(gaID?: string) {
+    if (typeof window === "undefined") return;
+    if (!gaID) return;
+
+    const head = document.getElementsByTagName("head")[0];
+
+    var myScript = document.createElement("script");
+
+    myScript.setAttribute(
+      "src",
+      `https://www.googletagmanager.com/gtag/js?id=${gaID}`
+    );
+
+    const that = this;
+    myScript.onload = function () {
+      that.gtag("js", new Date());
+      that.gtag("config", `${gaID}`, {
+        send_page_view: false,
+      });
+    };
+
+    head.insertBefore(myScript, head.children[1]);
+  }
+}

package/src/version.ts

@@ -0,0 +1 @@
+export const WALLET_ADAPTER_CORE_VERSION = "3.10.0";