@0xsequence/provider 1.7.2 → 1.8.0

package/dist/0xsequence-provider.cjs.dev.js

@@ -9,6 +9,7 @@ var network = require('@0xsequence/network');
 var core = require('@0xsequence/core');
 var auth = require('@0xsequence/auth');
 var abi = require('@0xsequence/abi');
+var tracker = require('@databeat/tracker');
 
 function _extends() {
   _extends = Object.assign ? Object.assign.bind() : function (target) {
@@ -3571,9 +3572,47 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
   }
 }
 
+// Analytics sub-class to add some custom helper methods
+class Analytics extends tracker.Databeat {}
+
+// Setup analytics tracker
+const setupAnalytics = (projectAccessKey, server) => {
+  if (!server) {
+    server = 'https://nodes.sequence.app';
+  }
+
+  // disable tracking if projectAccessKey is not set
+  const noop = !projectAccessKey;
+
+  // auth
+  const auth = {};
+  if (projectAccessKey) {
+    auth.headers = {
+      'X-Access-Key': projectAccessKey
+    };
+  }
+  return new Analytics(server, auth, {
+    noop: noop,
+    defaultEnabled: true,
+    privacy: {
+      userIdHash: true,
+      userAgentSalt: false
+    },
+    initProps: () => {
+      if (!tracker.isBrowser()) {
+        return {};
+      } else {
+        return {
+          origin: window.location.origin
+        };
+      }
+    }
+  });
+};
+
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.7.2",
+	version: "1.8.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3602,6 +3641,7 @@ var packageJson = {
 		"@0xsequence/relayer": "workspace:*",
 		"@0xsequence/utils": "workspace:*",
 		"@0xsequence/wallet": "workspace:*",
+		"@databeat/tracker": "^0.8.1",
 		eventemitter2: "^6.4.5",
 		"webextension-polyfill": "^0.10.0"
 	},
@@ -3610,8 +3650,8 @@ var packageJson = {
 	},
 	devDependencies: {
 		"@types/webextension-polyfill": "^0.10.0",
-		hardhat: "^2.12.2",
-		ethers: "^5.7.2"
+		ethers: "^5.7.2",
+		hardhat: "^2.12.2"
 	},
 	files: [
 		"src",
@@ -3705,14 +3745,15 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 
 // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options, projectAccessKey) {
+  constructor(transport, store, options) {
     var _options$defaultEIP;
-    this.projectAccessKey = projectAccessKey;
     this.session = void 0;
     this.defaultChainId = void 0;
     this.callbacks = {};
     this.transport = void 0;
     this.defaultEIP6492 = void 0;
+    this.projectAccessKey = void 0;
+    this.analytics = void 0;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3720,8 +3761,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
-    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
-    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
+    const defaultChainId = options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3772,6 +3813,14 @@ class SequenceClient {
       const chainIdHex = ethers.ethers.utils.hexValue(chainId);
       (_this$callbacks$chain2 = this.callbacks.chainChanged) == null || _this$callbacks$chain2.forEach(cb => cb(chainIdHex));
     });
+    if (options != null && options.projectAccessKey) {
+      this.projectAccessKey = options.projectAccessKey;
+    }
+    if (this.projectAccessKey && options != null && options.analytics) {
+      this.analytics = setupAnalytics(this.projectAccessKey);
+    } else {
+      this.analytics = setupAnalytics(''); // noop analytics
+    }
   }
 
   // Callbacks
@@ -3985,7 +4034,14 @@ class SequenceClient {
     return method;
   }
   async signMessage(message, options) {
+    var _this$analytics;
     const method = this.signMethod(options);
+    (_this$analytics = this.analytics) == null || _this$analytics.track({
+      event: 'SIGN_MESSAGE_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3994,6 +4050,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
+    var _this$analytics2;
     const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
@@ -4005,14 +4062,27 @@ class SequenceClient {
     // - The one provided in the typedData.domain.chainId
     // - The default chainId
 
+    (_this$analytics2 = this.analytics) == null || _this$analytics2.track({
+      event: 'SIGN_TYPED_DATA_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method,
       params: [this.getAddress(), encoded]
     }, (options == null ? void 0 : options.chainId) || typedData.domain.chainId && ethers.ethers.BigNumber.from(typedData.domain.chainId).toNumber() || this.getChainId());
   }
   async sendTransaction(tx, options) {
+    var _this$analytics3;
     const sequenceTxs = Array.isArray(tx) ? tx : [tx];
     const extendedTxs = toExtended(sequenceTxs);
+    (_this$analytics3 = this.analytics) == null || _this$analytics3.track({
+      event: 'SEND_TRANSACTION_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method: 'eth_sendTransaction',
       params: [extendedTxs]
@@ -4048,7 +4118,8 @@ const DefaultProviderConfig = {
       enabled: false
     }
   },
-  defaultNetwork: 1
+  defaultNetwork: 1,
+  analytics: true
 };
 let sequenceWalletProvider;
 
@@ -4121,8 +4192,10 @@ const initWallet = (projectAccessKey, partialConfig) => {
   // Create client, provider and return signer
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
-    defaultEIP6492: config.defaultEIP6492
-  }, projectAccessKey);
+    defaultEIP6492: config.defaultEIP6492,
+    projectAccessKey: projectAccessKey,
+    analytics: config.analytics
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

package/dist/0xsequence-provider.cjs.prod.js

@@ -9,6 +9,7 @@ var network = require('@0xsequence/network');
 var core = require('@0xsequence/core');
 var auth = require('@0xsequence/auth');
 var abi = require('@0xsequence/abi');
+var tracker = require('@databeat/tracker');
 
 function _extends() {
   _extends = Object.assign ? Object.assign.bind() : function (target) {
@@ -3571,9 +3572,47 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
   }
 }
 
+// Analytics sub-class to add some custom helper methods
+class Analytics extends tracker.Databeat {}
+
+// Setup analytics tracker
+const setupAnalytics = (projectAccessKey, server) => {
+  if (!server) {
+    server = 'https://nodes.sequence.app';
+  }
+
+  // disable tracking if projectAccessKey is not set
+  const noop = !projectAccessKey;
+
+  // auth
+  const auth = {};
+  if (projectAccessKey) {
+    auth.headers = {
+      'X-Access-Key': projectAccessKey
+    };
+  }
+  return new Analytics(server, auth, {
+    noop: noop,
+    defaultEnabled: true,
+    privacy: {
+      userIdHash: true,
+      userAgentSalt: false
+    },
+    initProps: () => {
+      if (!tracker.isBrowser()) {
+        return {};
+      } else {
+        return {
+          origin: window.location.origin
+        };
+      }
+    }
+  });
+};
+
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.7.2",
+	version: "1.8.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3602,6 +3641,7 @@ var packageJson = {
 		"@0xsequence/relayer": "workspace:*",
 		"@0xsequence/utils": "workspace:*",
 		"@0xsequence/wallet": "workspace:*",
+		"@databeat/tracker": "^0.8.1",
 		eventemitter2: "^6.4.5",
 		"webextension-polyfill": "^0.10.0"
 	},
@@ -3610,8 +3650,8 @@ var packageJson = {
 	},
 	devDependencies: {
 		"@types/webextension-polyfill": "^0.10.0",
-		hardhat: "^2.12.2",
-		ethers: "^5.7.2"
+		ethers: "^5.7.2",
+		hardhat: "^2.12.2"
 	},
 	files: [
 		"src",
@@ -3705,14 +3745,15 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 
 // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options, projectAccessKey) {
+  constructor(transport, store, options) {
     var _options$defaultEIP;
-    this.projectAccessKey = projectAccessKey;
     this.session = void 0;
     this.defaultChainId = void 0;
     this.callbacks = {};
     this.transport = void 0;
     this.defaultEIP6492 = void 0;
+    this.projectAccessKey = void 0;
+    this.analytics = void 0;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3720,8 +3761,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
-    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
-    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
+    const defaultChainId = options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3772,6 +3813,14 @@ class SequenceClient {
       const chainIdHex = ethers.ethers.utils.hexValue(chainId);
       (_this$callbacks$chain2 = this.callbacks.chainChanged) == null || _this$callbacks$chain2.forEach(cb => cb(chainIdHex));
     });
+    if (options != null && options.projectAccessKey) {
+      this.projectAccessKey = options.projectAccessKey;
+    }
+    if (this.projectAccessKey && options != null && options.analytics) {
+      this.analytics = setupAnalytics(this.projectAccessKey);
+    } else {
+      this.analytics = setupAnalytics(''); // noop analytics
+    }
   }
 
   // Callbacks
@@ -3985,7 +4034,14 @@ class SequenceClient {
     return method;
   }
   async signMessage(message, options) {
+    var _this$analytics;
     const method = this.signMethod(options);
+    (_this$analytics = this.analytics) == null || _this$analytics.track({
+      event: 'SIGN_MESSAGE_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3994,6 +4050,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
+    var _this$analytics2;
     const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
@@ -4005,14 +4062,27 @@ class SequenceClient {
     // - The one provided in the typedData.domain.chainId
     // - The default chainId
 
+    (_this$analytics2 = this.analytics) == null || _this$analytics2.track({
+      event: 'SIGN_TYPED_DATA_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method,
       params: [this.getAddress(), encoded]
     }, (options == null ? void 0 : options.chainId) || typedData.domain.chainId && ethers.ethers.BigNumber.from(typedData.domain.chainId).toNumber() || this.getChainId());
   }
   async sendTransaction(tx, options) {
+    var _this$analytics3;
     const sequenceTxs = Array.isArray(tx) ? tx : [tx];
     const extendedTxs = toExtended(sequenceTxs);
+    (_this$analytics3 = this.analytics) == null || _this$analytics3.track({
+      event: 'SEND_TRANSACTION_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method: 'eth_sendTransaction',
       params: [extendedTxs]
@@ -4048,7 +4118,8 @@ const DefaultProviderConfig = {
       enabled: false
     }
   },
-  defaultNetwork: 1
+  defaultNetwork: 1,
+  analytics: true
 };
 let sequenceWalletProvider;
 
@@ -4121,8 +4192,10 @@ const initWallet = (projectAccessKey, partialConfig) => {
   // Create client, provider and return signer
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
-    defaultEIP6492: config.defaultEIP6492
-  }, projectAccessKey);
+    defaultEIP6492: config.defaultEIP6492,
+    projectAccessKey: projectAccessKey,
+    analytics: config.analytics
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

package/dist/0xsequence-provider.esm.js

@@ -5,6 +5,7 @@ import { findSupportedNetwork, ChainId, findNetworkConfig, allNetworks, JsonRpcR
 import { commons } from '@0xsequence/core';
 import { signAuthorization } from '@0xsequence/auth';
 import { walletContracts } from '@0xsequence/abi';
+import { isBrowser, Databeat } from '@databeat/tracker';
 
 function _extends() {
   _extends = Object.assign ? Object.assign.bind() : function (target) {
@@ -3567,9 +3568,47 @@ class SingleNetworkSequenceProvider extends SequenceProvider {
   }
 }
 
+// Analytics sub-class to add some custom helper methods
+class Analytics extends Databeat {}
+
+// Setup analytics tracker
+const setupAnalytics = (projectAccessKey, server) => {
+  if (!server) {
+    server = 'https://nodes.sequence.app';
+  }
+
+  // disable tracking if projectAccessKey is not set
+  const noop = !projectAccessKey;
+
+  // auth
+  const auth = {};
+  if (projectAccessKey) {
+    auth.headers = {
+      'X-Access-Key': projectAccessKey
+    };
+  }
+  return new Analytics(server, auth, {
+    noop: noop,
+    defaultEnabled: true,
+    privacy: {
+      userIdHash: true,
+      userAgentSalt: false
+    },
+    initProps: () => {
+      if (!isBrowser()) {
+        return {};
+      } else {
+        return {
+          origin: window.location.origin
+        };
+      }
+    }
+  });
+};
+
 var packageJson = {
 	name: "@0xsequence/provider",
-	version: "1.7.2",
+	version: "1.8.0",
 	description: "provider sub-package for Sequence",
 	repository: "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
 	source: "src/index.ts",
@@ -3598,6 +3637,7 @@ var packageJson = {
 		"@0xsequence/relayer": "workspace:*",
 		"@0xsequence/utils": "workspace:*",
 		"@0xsequence/wallet": "workspace:*",
+		"@databeat/tracker": "^0.8.1",
 		eventemitter2: "^6.4.5",
 		"webextension-polyfill": "^0.10.0"
 	},
@@ -3606,8 +3646,8 @@ var packageJson = {
 	},
 	devDependencies: {
 		"@types/webextension-polyfill": "^0.10.0",
-		hardhat: "^2.12.2",
-		ethers: "^5.7.2"
+		ethers: "^5.7.2",
+		hardhat: "^2.12.2"
 	},
 	files: [
 		"src",
@@ -3701,14 +3741,15 @@ DefaultChainIdTracker.SESSION_CHAIN_ID_KEY = '@sequence.session.defaultChainId';
 
 // TODO: rename Client to transport.. or something.. like SequenceTransport ..
 class SequenceClient {
-  constructor(transport, store, options, projectAccessKey) {
+  constructor(transport, store, options) {
     var _options$defaultEIP;
-    this.projectAccessKey = projectAccessKey;
     this.session = void 0;
     this.defaultChainId = void 0;
     this.callbacks = {};
     this.transport = void 0;
     this.defaultEIP6492 = void 0;
+    this.projectAccessKey = void 0;
+    this.analytics = void 0;
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport);
     } else if (isProviderTransport(transport)) {
@@ -3716,8 +3757,8 @@ class SequenceClient {
     } else {
       throw new Error('Invalid transport');
     }
-    const defaultChainId = typeof options === 'number' ? options : options == null ? void 0 : options.defaultChainId;
-    this.defaultEIP6492 = typeof options === 'number' ? false : (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
+    const defaultChainId = options == null ? void 0 : options.defaultChainId;
+    this.defaultEIP6492 = (_options$defaultEIP = options == null ? void 0 : options.defaultEIP6492) != null ? _options$defaultEIP : false;
     this.session = new SequenceClientSession(store);
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId);
     this.transport.on('accountsChanged', accounts => {
@@ -3768,6 +3809,14 @@ class SequenceClient {
       const chainIdHex = ethers.utils.hexValue(chainId);
       (_this$callbacks$chain2 = this.callbacks.chainChanged) == null || _this$callbacks$chain2.forEach(cb => cb(chainIdHex));
     });
+    if (options != null && options.projectAccessKey) {
+      this.projectAccessKey = options.projectAccessKey;
+    }
+    if (this.projectAccessKey && options != null && options.analytics) {
+      this.analytics = setupAnalytics(this.projectAccessKey);
+    } else {
+      this.analytics = setupAnalytics(''); // noop analytics
+    }
   }
 
   // Callbacks
@@ -3981,7 +4030,14 @@ class SequenceClient {
     return method;
   }
   async signMessage(message, options) {
+    var _this$analytics;
     const method = this.signMethod(options);
+    (_this$analytics = this.analytics) == null || _this$analytics.track({
+      event: 'SIGN_MESSAGE_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
 
     // Address is ignored by the wallet webapp
     return this.send({
@@ -3990,6 +4046,7 @@ class SequenceClient {
     }, options == null ? void 0 : options.chainId);
   }
   async signTypedData(typedData, options) {
+    var _this$analytics2;
     const method = this.signTypedDataMethod(options);
 
     // TODO: Stop using ethers for this, this is the only place where we use it
@@ -4001,14 +4058,27 @@ class SequenceClient {
     // - The one provided in the typedData.domain.chainId
     // - The default chainId
 
+    (_this$analytics2 = this.analytics) == null || _this$analytics2.track({
+      event: 'SIGN_TYPED_DATA_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method,
       params: [this.getAddress(), encoded]
     }, (options == null ? void 0 : options.chainId) || typedData.domain.chainId && ethers.BigNumber.from(typedData.domain.chainId).toNumber() || this.getChainId());
   }
   async sendTransaction(tx, options) {
+    var _this$analytics3;
     const sequenceTxs = Array.isArray(tx) ? tx : [tx];
     const extendedTxs = toExtended(sequenceTxs);
+    (_this$analytics3 = this.analytics) == null || _this$analytics3.track({
+      event: 'SEND_TRANSACTION_REQUEST',
+      props: {
+        chainId: `${(options == null ? void 0 : options.chainId) || this.getChainId()}`
+      }
+    });
     return this.send({
       method: 'eth_sendTransaction',
       params: [extendedTxs]
@@ -4044,7 +4114,8 @@ const DefaultProviderConfig = {
       enabled: false
     }
   },
-  defaultNetwork: 1
+  defaultNetwork: 1,
+  analytics: true
 };
 let sequenceWalletProvider;
 
@@ -4117,8 +4188,10 @@ const initWallet = (projectAccessKey, partialConfig) => {
   // Create client, provider and return signer
   const client = new SequenceClient(config.transports, itemStore, {
     defaultChainId: defaultNetwork,
-    defaultEIP6492: config.defaultEIP6492
-  }, projectAccessKey);
+    defaultEIP6492: config.defaultEIP6492,
+    projectAccessKey: projectAccessKey,
+    analytics: config.analytics
+  });
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId);
   return sequenceWalletProvider;
 };

package/dist/declarations/src/analytics.d.ts

@@ -0,0 +1,13 @@
+import { Databeat, Event as DatabeatEvent } from '@databeat/tracker';
+export declare enum EventType {
+    INIT = 0,
+    VIEW = 1,
+    SIGN_MESSAGE_REQUEST = 2,
+    SIGN_TYPED_DATA_REQUEST = 3,
+    SEND_TRANSACTION_REQUEST = 4
+}
+export type EventTypes = keyof typeof EventType;
+export type Event = DatabeatEvent<EventTypes>;
+export declare class Analytics extends Databeat<EventTypes> {
+}
+export declare const setupAnalytics: (projectAccessKey: string, server?: string) => Analytics;

package/dist/declarations/src/client.d.ts

@@ -2,6 +2,7 @@ import { JsonRpcRequest, NetworkConfig } from '@0xsequence/network';
 import { ConnectDetails, ConnectOptions, ItemStore, MuxTransportTemplate, OpenWalletIntent, OptionalChainId, OptionalEIP6492, ProviderTransport, WalletEventTypes, WalletSession } from "./index.js";
 import { commons } from '@0xsequence/core';
 import { TypedData } from '@0xsequence/utils';
+import { Analytics } from "./analytics.js";
 import { ethers } from 'ethers';
 /**
  *  This session class is meant to persist the state of the wallet connection
@@ -36,6 +37,8 @@ export declare class DefaultChainIdTracker {
 export type SequenceClientOptions = {
     defaultChainId?: number;
     defaultEIP6492?: boolean;
+    projectAccessKey?: string;
+    analytics?: boolean;
 };
 /**
  *  This is a wallet client for sequence wallet-webapp. It connects using *some* transport
@@ -44,13 +47,14 @@ export type SequenceClientOptions = {
  *  It doesn't implement a full ethereum Provider, it doesn't include read-only methods.
  */
 export declare class SequenceClient {
-    projectAccessKey?: string | undefined;
     private readonly session;
     private readonly defaultChainId;
     private readonly callbacks;
     readonly transport: ProviderTransport;
     readonly defaultEIP6492: boolean;
-    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions | number, projectAccessKey?: string | undefined);
+    readonly projectAccessKey?: string;
+    readonly analytics?: Analytics;
+    constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions);
     registerCallback<K extends keyof WalletEventTypes>(eventName: K, callback: WalletEventTypes[K]): () => void;
     onOpen(callback: WalletEventTypes['open']): () => void;
     onClose(callback: WalletEventTypes['close']): () => void;

package/dist/declarations/src/init.d.ts

@@ -8,6 +8,7 @@ export interface ProviderConfig {
     defaultEIP6492?: boolean;
     networks?: Partial<NetworkConfig>[];
     transports?: MuxTransportTemplate;
+    analytics?: boolean;
 }
 export declare const DefaultProviderConfig: {
     transports: {
@@ -20,6 +21,7 @@ export declare const DefaultProviderConfig: {
         };
     };
     defaultNetwork: number;
+    analytics: boolean;
 };
 /**
  * Initializes a wallet with the provided project access key and optional configuration.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/provider",
-  "version": "1.7.2",
+  "version": "1.8.0",
   "description": "provider sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/provider",
   "source": "src/index.ts",
@@ -9,25 +9,26 @@
   "author": "Horizon Blockchain Games",
   "license": "Apache-2.0",
   "dependencies": {
+    "@databeat/tracker": "^0.8.1",
     "eventemitter2": "^6.4.5",
     "webextension-polyfill": "^0.10.0",
-    "@0xsequence/abi": "1.7.2",
-    "@0xsequence/account": "1.7.2",
-    "@0xsequence/auth": "1.7.2",
-    "@0xsequence/core": "1.7.2",
-    "@0xsequence/migration": "1.7.2",
-    "@0xsequence/network": "1.7.2",
-    "@0xsequence/relayer": "1.7.2",
-    "@0xsequence/utils": "1.7.2",
-    "@0xsequence/wallet": "1.7.2"
+    "@0xsequence/abi": "1.8.0",
+    "@0xsequence/account": "1.8.0",
+    "@0xsequence/auth": "1.8.0",
+    "@0xsequence/core": "1.8.0",
+    "@0xsequence/migration": "1.8.0",
+    "@0xsequence/network": "1.8.0",
+    "@0xsequence/relayer": "1.8.0",
+    "@0xsequence/utils": "1.8.0",
+    "@0xsequence/wallet": "1.8.0"
   },
   "peerDependencies": {
     "ethers": ">=5.5 < 6"
   },
   "devDependencies": {
     "@types/webextension-polyfill": "^0.10.0",
-    "hardhat": "^2.12.2",
-    "ethers": "^5.7.2"
+    "ethers": "^5.7.2",
+    "hardhat": "^2.12.2"
   },
   "files": [
     "src",

package/src/analytics.ts

@@ -0,0 +1,47 @@
+import { Databeat, Event as DatabeatEvent, Auth, isBrowser } from '@databeat/tracker'
+
+export enum EventType {
+  // Core types part of Databeat
+  INIT,
+  VIEW,
+
+  // Provider specific
+  SIGN_MESSAGE_REQUEST,
+  SIGN_TYPED_DATA_REQUEST,
+  SEND_TRANSACTION_REQUEST
+}
+
+export type EventTypes = keyof typeof EventType
+export type Event = DatabeatEvent<EventTypes>
+
+// Analytics sub-class to add some custom helper methods
+export class Analytics extends Databeat<EventTypes> {}
+
+// Setup analytics tracker
+export const setupAnalytics = (projectAccessKey: string, server?: string) => {
+  if (!server) {
+    server = 'https://nodes.sequence.app'
+  }
+
+  // disable tracking if projectAccessKey is not set
+  const noop = !projectAccessKey
+
+  // auth
+  const auth: Auth = {}
+  if (projectAccessKey) {
+    auth.headers = { 'X-Access-Key': projectAccessKey }
+  }
+
+  return new Analytics(server, auth, {
+    noop: noop,
+    defaultEnabled: true,
+    privacy: { userIdHash: true, userAgentSalt: false },
+    initProps: () => {
+      if (!isBrowser()) {
+        return {}
+      } else {
+        return { origin: window.location.origin }
+      }
+    }
+  })
+}

package/src/client.ts

@@ -17,6 +17,7 @@ import {
 import { commons } from '@0xsequence/core'
 import { TypedData } from '@0xsequence/utils'
 import { toExtended } from './extended'
+import { Analytics, setupAnalytics } from './analytics'
 import { ethers } from 'ethers'
 
 import packageJson from '../package.json'
@@ -117,6 +118,8 @@ export class DefaultChainIdTracker {
 export type SequenceClientOptions = {
   defaultChainId?: number
   defaultEIP6492?: boolean
+  projectAccessKey?: string
+  analytics?: boolean
 }
 
 /**
@@ -135,13 +138,10 @@ export class SequenceClient {
   public readonly transport: ProviderTransport
 
   public readonly defaultEIP6492: boolean
+  public readonly projectAccessKey?: string
+  public readonly analytics?: Analytics
 
-  constructor(
-    transport: ProviderTransport | MuxTransportTemplate,
-    store: ItemStore,
-    options?: SequenceClientOptions | number,
-    public projectAccessKey?: string
-  ) {
+  constructor(transport: ProviderTransport | MuxTransportTemplate, store: ItemStore, options?: SequenceClientOptions) {
     if (isMuxTransportTemplate(transport)) {
       this.transport = MuxMessageProvider.new(transport)
     } else if (isProviderTransport(transport)) {
@@ -150,8 +150,8 @@ export class SequenceClient {
       throw new Error('Invalid transport')
     }
 
-    const defaultChainId = typeof options === 'number' ? options : options?.defaultChainId
-    this.defaultEIP6492 = typeof options === 'number' ? false : options?.defaultEIP6492 ?? false
+    const defaultChainId = options?.defaultChainId
+    this.defaultEIP6492 = options?.defaultEIP6492 ?? false
 
     this.session = new SequenceClientSession(store)
     this.defaultChainId = new DefaultChainIdTracker(store, defaultChainId)
@@ -206,6 +206,15 @@ export class SequenceClient {
       const chainIdHex = ethers.utils.hexValue(chainId)
       this.callbacks.chainChanged?.forEach(cb => cb(chainIdHex))
     })
+
+    if (options?.projectAccessKey) {
+      this.projectAccessKey = options.projectAccessKey
+    }
+    if (this.projectAccessKey && options?.analytics) {
+      this.analytics = setupAnalytics(this.projectAccessKey)
+    } else {
+      this.analytics = setupAnalytics('') // noop analytics
+    }
   }
 
   // Callbacks
@@ -454,6 +463,8 @@ export class SequenceClient {
   async signMessage(message: ethers.BytesLike, options?: OptionalEIP6492 & OptionalChainId): Promise<string> {
     const method = this.signMethod(options)
 
+    this.analytics?.track({ event: 'SIGN_MESSAGE_REQUEST', props: { chainId: `${options?.chainId || this.getChainId()}` } })
+
     // Address is ignored by the wallet webapp
     return this.send({ method, params: [message, this.getAddress()] }, options?.chainId)
   }
@@ -470,6 +481,8 @@ export class SequenceClient {
     // - The one provided in the typedData.domain.chainId
     // - The default chainId
 
+    this.analytics?.track({ event: 'SIGN_TYPED_DATA_REQUEST', props: { chainId: `${options?.chainId || this.getChainId()}` } })
+
     return this.send(
       { method, params: [this.getAddress(), encoded] },
       options?.chainId ||
@@ -485,6 +498,8 @@ export class SequenceClient {
     const sequenceTxs = Array.isArray(tx) ? tx : [tx]
     const extendedTxs = toExtended(sequenceTxs)
 
+    this.analytics?.track({ event: 'SEND_TRANSACTION_REQUEST', props: { chainId: `${options?.chainId || this.getChainId()}` } })
+
     return this.send({ method: 'eth_sendTransaction', params: [extendedTxs] }, options?.chainId)
   }
 

package/src/init.ts

@@ -40,6 +40,9 @@ export interface ProviderConfig {
 
   // transports for dapp to wallet jron-rpc communication
   transports?: MuxTransportTemplate
+
+  // analytics .... (default: true)
+  analytics?: boolean
 }
 
 export const DefaultProviderConfig = {
@@ -49,7 +52,8 @@ export const DefaultProviderConfig = {
     proxyTransport: { enabled: false }
   },
 
-  defaultNetwork: 1
+  defaultNetwork: 1,
+  analytics: true
 }
 
 let sequenceWalletProvider: SequenceProvider | undefined
@@ -134,15 +138,12 @@ export const initWallet = (projectAccessKey: string, partialConfig?: Partial<Pro
   const itemStore = config.localStorage || useBestStore()
 
   // Create client, provider and return signer
-  const client = new SequenceClient(
-    config.transports,
-    itemStore,
-    {
-      defaultChainId: defaultNetwork,
-      defaultEIP6492: config.defaultEIP6492
-    },
-    projectAccessKey
-  )
+  const client = new SequenceClient(config.transports, itemStore, {
+    defaultChainId: defaultNetwork,
+    defaultEIP6492: config.defaultEIP6492,
+    projectAccessKey: projectAccessKey,
+    analytics: config.analytics
+  })
 
   sequenceWalletProvider = new SequenceProvider(client, providerForChainId)
   return sequenceWalletProvider