@imtbl/sdk 1.5.2 → 1.5.3-alpha

package/dist/orderbook.js

@@ -1,6 +1,8 @@
 import axios from 'axios';
 import FormData from 'form-data';
 import { providers, BigNumber, constants as constants$1 } from 'ethers';
+import { memorise } from 'lru-memorise';
+import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
 import { Seaport as Seaport$1 } from '@opensea/seaport-js';
 
 const isNode = () => typeof window === 'undefined';
@@ -16,12 +18,6 @@ var Detail;
     Detail["DOMAIN"] = "domain";
     Detail["SDK_VERSION"] = "sdkVersion";
 })(Detail || (Detail = {}));
-var Store;
-(function (Store) {
-    Store["EVENTS"] = "events";
-    Store["RUNTIME"] = "runtime";
-})(Store || (Store = {}));
-const POLLING_FREQUENCY = 5000;
 
 const IMTBL_API = 'https://api.x.immutable.com';
 async function post(path, data) {
@@ -81,6 +77,11 @@ const setItem = (key, payload) => {
     return false;
 };
 
+var Store;
+(function (Store) {
+    Store["EVENTS"] = "events";
+    Store["RUNTIME"] = "runtime";
+})(Store || (Store = {}));
 // In memory storage for events and other data
 let EVENT_STORE;
 let RUNTIME_DETAILS;
@@ -108,6 +109,10 @@ const getDetail = (key) => {
 const getAllDetails = () => RUNTIME_DETAILS;
 // Events
 const getEvents = () => EVENT_STORE;
+const addEvent = (event) => {
+    EVENT_STORE.push(event);
+    setItem(Store.EVENTS, EVENT_STORE);
+};
 const removeSentEvents = (numberOfEvents) => {
     EVENT_STORE = EVENT_STORE.slice(numberOfEvents);
     setItem(Store.EVENTS, EVENT_STORE);
@@ -126,9 +131,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.2';
-let initialised = false;
-const isInitialised = () => initialised;
+const SDK_VERSION = '1.5.3-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -165,21 +168,28 @@ const getRuntimeDetails = () => {
         screen: `${window.screen.width}x${window.screen.height}`,
     };
 };
+let initialised = false;
+const isInitialised = () => initialised;
 const initialise = async () => {
-    const runtimeDetails = flattenProperties(getRuntimeDetails());
-    const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
-    const body = {
-        version: 1,
-        data: {
-            runtimeDetails,
-            runtimeId: existingRuntimeId,
-        },
-    };
-    const response = await post('/v1/sdk/initialise', body);
-    // Get runtimeId and store it
-    const { runtimeId } = response;
-    storeDetail(Detail.RUNTIME_ID, runtimeId);
     initialised = true;
+    try {
+        const runtimeDetails = flattenProperties(getRuntimeDetails());
+        const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
+        const body = {
+            version: 1,
+            data: {
+                runtimeDetails,
+                runtimeId: existingRuntimeId,
+            },
+        };
+        const response = await post('/v1/sdk/initialise', body);
+        // Get runtimeId and store it
+        const { runtimeId } = response;
+        storeDetail(Detail.RUNTIME_ID, runtimeId);
+    }
+    catch (error) {
+        initialised = false;
+    }
 };
 
 function errorBoundary(fn) {
@@ -210,6 +220,32 @@ function isTestEnvironment() {
     // Just use process.env.CI for now.
     return process.env.JEST_WORKER_ID !== undefined;
 }
+
+const GLOBALISE_KEY = 'imtbl__metrics';
+const MEMORISE_TIMEFRAME = 1000;
+const MEMORISE_MAX = 1000;
+const getGlobalisedValue = (key, value) => getGlobalisedValue$1(GLOBALISE_KEY, key, value);
+const getGlobalisedCachedFunction = (key, fn) => {
+    // Some applications (esp backend, or frontends using the split bundles) can sometimes
+    // initialise the same request multiple times. This will prevent multiple of the
+    // same event,value from being reported in a 1 second period.
+    const memorisedFn = memorise(fn, {
+        lruOptions: { ttl: MEMORISE_TIMEFRAME, max: MEMORISE_MAX },
+    });
+    return getGlobalisedValue$1(GLOBALISE_KEY, key, memorisedFn);
+};
+
+const POLLING_FREQUENCY = 5000;
+// Store the event in the event store
+const trackFn = (moduleName, eventName, properties) => {
+    const event = {
+        event: `${moduleName}.${eventName}`,
+        time: new Date().toISOString(),
+        ...(properties && { properties: flattenProperties(properties) }),
+    };
+    addEvent(event);
+};
+errorBoundary(getGlobalisedCachedFunction('track', trackFn));
 // Sending events to the server
 const flushFn = async () => {
     // Don't flush if not initialised
@@ -245,11 +281,32 @@ const flushPoll = async () => {
     await flush();
     setTimeout(flushPoll, POLLING_FREQUENCY);
 };
+let flushingStarted = false;
+const startFlushing = () => {
+    if (flushingStarted) {
+        return;
+    }
+    flushingStarted = true;
+    flushPoll();
+};
 // This will get initialised when module is imported.
 if (!isTestEnvironment()) {
-    errorBoundary(flushPoll)();
+    errorBoundary(getGlobalisedValue('startFlushing', startFlushing))();
 }
 
+const setEnvironmentFn = (env) => {
+    storeDetail(Detail.ENVIRONMENT, env);
+};
+errorBoundary(getGlobalisedValue('setEnvironment', setEnvironmentFn));
+const setPassportClientIdFn = (passportClientId) => {
+    storeDetail(Detail.PASSPORT_CLIENT_ID, passportClientId);
+};
+errorBoundary(getGlobalisedValue('setPassportClientId', setPassportClientIdFn));
+const setPublishableApiKeyFn = (publishableApiKey) => {
+    storeDetail(Detail.PUBLISHABLE_API_KEY, publishableApiKey);
+};
+errorBoundary(getGlobalisedValue('setPublishableApiKey', setPublishableApiKeyFn));
+
 var Environment;
 (function (Environment) {
     Environment["PRODUCTION"] = "production";

package/dist/passport.js

@@ -1,5 +1,7 @@
 import globalAxios$1, { isAxiosError as isAxiosError$1 } from 'axios';
 import { ImmutableX, Config, generateLegacyStarkPrivateKey, createStarkSigner } from '@imtbl/core-sdk';
+import { memorise } from 'lru-memorise';
+import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
 import { UserManager, User, InMemoryWebStorage, WebStorageStateStore } from 'oidc-client-ts';
 import jwt_decode from 'jwt-decode';
 import * as crypto from 'crypto';
@@ -9136,7 +9138,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.5.2' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-1.5.3-alpha' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -9202,12 +9204,6 @@ var Detail;
     Detail["DOMAIN"] = "domain";
     Detail["SDK_VERSION"] = "sdkVersion";
 })(Detail || (Detail = {}));
-var Store;
-(function (Store) {
-    Store["EVENTS"] = "events";
-    Store["RUNTIME"] = "runtime";
-})(Store || (Store = {}));
-const POLLING_FREQUENCY = 5000;
 
 const IMTBL_API = 'https://api.x.immutable.com';
 async function post(path, data) {
@@ -9267,6 +9263,11 @@ const setItem = (key, payload) => {
     return false;
 };
 
+var Store;
+(function (Store) {
+    Store["EVENTS"] = "events";
+    Store["RUNTIME"] = "runtime";
+})(Store || (Store = {}));
 // In memory storage for events and other data
 let EVENT_STORE;
 let RUNTIME_DETAILS;
@@ -9316,9 +9317,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.2';
-let initialised = false;
-const isInitialised = () => initialised;
+const SDK_VERSION = '1.5.3-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -9355,21 +9354,28 @@ const getRuntimeDetails = () => {
         screen: `${window.screen.width}x${window.screen.height}`,
     };
 };
+let initialised = false;
+const isInitialised = () => initialised;
 const initialise = async () => {
-    const runtimeDetails = flattenProperties(getRuntimeDetails());
-    const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
-    const body = {
-        version: 1,
-        data: {
-            runtimeDetails,
-            runtimeId: existingRuntimeId,
-        },
-    };
-    const response = await post('/v1/sdk/initialise', body);
-    // Get runtimeId and store it
-    const { runtimeId } = response;
-    storeDetail(Detail.RUNTIME_ID, runtimeId);
     initialised = true;
+    try {
+        const runtimeDetails = flattenProperties(getRuntimeDetails());
+        const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
+        const body = {
+            version: 1,
+            data: {
+                runtimeDetails,
+                runtimeId: existingRuntimeId,
+            },
+        };
+        const response = await post('/v1/sdk/initialise', body);
+        // Get runtimeId and store it
+        const { runtimeId } = response;
+        storeDetail(Detail.RUNTIME_ID, runtimeId);
+    }
+    catch (error) {
+        initialised = false;
+    }
 };
 
 function errorBoundary(fn) {
@@ -9401,6 +9407,21 @@ function isTestEnvironment() {
     return process.env.JEST_WORKER_ID !== undefined;
 }
 
+const GLOBALISE_KEY = 'imtbl__metrics';
+const MEMORISE_TIMEFRAME = 1000;
+const MEMORISE_MAX = 1000;
+const getGlobalisedValue = (key, value) => getGlobalisedValue$1(GLOBALISE_KEY, key, value);
+const getGlobalisedCachedFunction = (key, fn) => {
+    // Some applications (esp backend, or frontends using the split bundles) can sometimes
+    // initialise the same request multiple times. This will prevent multiple of the
+    // same event,value from being reported in a 1 second period.
+    const memorisedFn = memorise(fn, {
+        lruOptions: { ttl: MEMORISE_TIMEFRAME, max: MEMORISE_MAX },
+    });
+    return getGlobalisedValue$1(GLOBALISE_KEY, key, memorisedFn);
+};
+
+const POLLING_FREQUENCY = 5000;
 // Store the event in the event store
 const trackFn = (moduleName, eventName, properties) => {
     const event = {
@@ -9410,7 +9431,7 @@ const trackFn = (moduleName, eventName, properties) => {
     };
     addEvent(event);
 };
-const track = errorBoundary(trackFn);
+const track = errorBoundary(getGlobalisedCachedFunction('track', trackFn));
 // Sending events to the server
 const flushFn = async () => {
     // Don't flush if not initialised
@@ -9446,9 +9467,17 @@ const flushPoll = async () => {
     await flush();
     setTimeout(flushPoll, POLLING_FREQUENCY);
 };
+let flushingStarted = false;
+const startFlushing = () => {
+    if (flushingStarted) {
+        return;
+    }
+    flushingStarted = true;
+    flushPoll();
+};
 // This will get initialised when module is imported.
 if (!isTestEnvironment()) {
-    errorBoundary(flushPoll)();
+    errorBoundary(getGlobalisedValue('startFlushing', startFlushing))();
 }
 
 const parseIdentity = (params) => {
@@ -9471,10 +9500,19 @@ const identifyFn = (params) => {
     track('metrics', 'identify', params.traits);
 };
 const identify = errorBoundary(identifyFn);
+
+const setEnvironmentFn = (env) => {
+    storeDetail(Detail.ENVIRONMENT, env);
+};
+errorBoundary(getGlobalisedValue('setEnvironment', setEnvironmentFn));
 const setPassportClientIdFn = (passportClientId) => {
     storeDetail(Detail.PASSPORT_CLIENT_ID, passportClientId);
 };
-const setPassportClientId = errorBoundary(setPassportClientIdFn);
+const setPassportClientId = errorBoundary(getGlobalisedValue('setPassportClientId', setPassportClientIdFn));
+const setPublishableApiKeyFn = (publishableApiKey) => {
+    storeDetail(Detail.PUBLISHABLE_API_KEY, publishableApiKey);
+};
+errorBoundary(getGlobalisedValue('setPublishableApiKey', setPublishableApiKeyFn));
 
 var Environment;
 (function (Environment) {
@@ -9491,7 +9529,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.2',
+    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/dist/x.js

@@ -1,6 +1,8 @@
 import { ImmutableX, Config, TransfersApi, OrdersApi, UsersApi, Contracts, TradesApi, ExchangesApi, WithdrawalsApi, MintsApi, DepositsApi, EncodingApi, TokensApi } from '@imtbl/core-sdk';
 export { IMXError, createStarkSigner as imxClientCreateStarkSigner, generateLegacyStarkPrivateKey as imxClientGenerateLegacyStarkPrivateKey } from '@imtbl/core-sdk';
 import axios, { AxiosError } from 'axios';
+import { memorise } from 'lru-memorise';
+import { getGlobalisedValue as getGlobalisedValue$1 } from 'global-const';
 import BN from 'bn.js';
 import * as encUtils from 'enc-utils';
 import { parseUnits } from '@ethersproject/units';
@@ -21,12 +23,6 @@ var Detail;
     Detail["DOMAIN"] = "domain";
     Detail["SDK_VERSION"] = "sdkVersion";
 })(Detail || (Detail = {}));
-var Store;
-(function (Store) {
-    Store["EVENTS"] = "events";
-    Store["RUNTIME"] = "runtime";
-})(Store || (Store = {}));
-const POLLING_FREQUENCY = 5000;
 
 const IMTBL_API = 'https://api.x.immutable.com';
 async function post(path, data) {
@@ -86,6 +82,11 @@ const setItem = (key, payload) => {
     return false;
 };
 
+var Store;
+(function (Store) {
+    Store["EVENTS"] = "events";
+    Store["RUNTIME"] = "runtime";
+})(Store || (Store = {}));
 // In memory storage for events and other data
 let EVENT_STORE;
 let RUNTIME_DETAILS;
@@ -113,6 +114,10 @@ const getDetail = (key) => {
 const getAllDetails = () => RUNTIME_DETAILS;
 // Events
 const getEvents = () => EVENT_STORE;
+const addEvent = (event) => {
+    EVENT_STORE.push(event);
+    setItem(Store.EVENTS, EVENT_STORE);
+};
 const removeSentEvents = (numberOfEvents) => {
     EVENT_STORE = EVENT_STORE.slice(numberOfEvents);
     setItem(Store.EVENTS, EVENT_STORE);
@@ -131,9 +136,7 @@ const flattenProperties = (properties) => {
 };
 
 // WARNING: DO NOT CHANGE THE STRING BELOW. IT GETS REPLACED AT BUILD TIME.
-const SDK_VERSION = '1.5.2';
-let initialised = false;
-const isInitialised = () => initialised;
+const SDK_VERSION = '1.5.3-alpha';
 const getReferrer = () => {
     if (isNode()) {
         return '';
@@ -170,21 +173,28 @@ const getRuntimeDetails = () => {
         screen: `${window.screen.width}x${window.screen.height}`,
     };
 };
+let initialised = false;
+const isInitialised = () => initialised;
 const initialise = async () => {
-    const runtimeDetails = flattenProperties(getRuntimeDetails());
-    const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
-    const body = {
-        version: 1,
-        data: {
-            runtimeDetails,
-            runtimeId: existingRuntimeId,
-        },
-    };
-    const response = await post('/v1/sdk/initialise', body);
-    // Get runtimeId and store it
-    const { runtimeId } = response;
-    storeDetail(Detail.RUNTIME_ID, runtimeId);
     initialised = true;
+    try {
+        const runtimeDetails = flattenProperties(getRuntimeDetails());
+        const existingRuntimeId = getDetail(Detail.RUNTIME_ID);
+        const body = {
+            version: 1,
+            data: {
+                runtimeDetails,
+                runtimeId: existingRuntimeId,
+            },
+        };
+        const response = await post('/v1/sdk/initialise', body);
+        // Get runtimeId and store it
+        const { runtimeId } = response;
+        storeDetail(Detail.RUNTIME_ID, runtimeId);
+    }
+    catch (error) {
+        initialised = false;
+    }
 };
 
 function errorBoundary(fn) {
@@ -215,6 +225,32 @@ function isTestEnvironment() {
     // Just use process.env.CI for now.
     return process.env.JEST_WORKER_ID !== undefined;
 }
+
+const GLOBALISE_KEY = 'imtbl__metrics';
+const MEMORISE_TIMEFRAME = 1000;
+const MEMORISE_MAX = 1000;
+const getGlobalisedValue = (key, value) => getGlobalisedValue$1(GLOBALISE_KEY, key, value);
+const getGlobalisedCachedFunction = (key, fn) => {
+    // Some applications (esp backend, or frontends using the split bundles) can sometimes
+    // initialise the same request multiple times. This will prevent multiple of the
+    // same event,value from being reported in a 1 second period.
+    const memorisedFn = memorise(fn, {
+        lruOptions: { ttl: MEMORISE_TIMEFRAME, max: MEMORISE_MAX },
+    });
+    return getGlobalisedValue$1(GLOBALISE_KEY, key, memorisedFn);
+};
+
+const POLLING_FREQUENCY = 5000;
+// Store the event in the event store
+const trackFn = (moduleName, eventName, properties) => {
+    const event = {
+        event: `${moduleName}.${eventName}`,
+        time: new Date().toISOString(),
+        ...(properties && { properties: flattenProperties(properties) }),
+    };
+    addEvent(event);
+};
+errorBoundary(getGlobalisedCachedFunction('track', trackFn));
 // Sending events to the server
 const flushFn = async () => {
     // Don't flush if not initialised
@@ -250,11 +286,32 @@ const flushPoll = async () => {
     await flush();
     setTimeout(flushPoll, POLLING_FREQUENCY);
 };
+let flushingStarted = false;
+const startFlushing = () => {
+    if (flushingStarted) {
+        return;
+    }
+    flushingStarted = true;
+    flushPoll();
+};
 // This will get initialised when module is imported.
 if (!isTestEnvironment()) {
-    errorBoundary(flushPoll)();
+    errorBoundary(getGlobalisedValue('startFlushing', startFlushing))();
 }
 
+const setEnvironmentFn = (env) => {
+    storeDetail(Detail.ENVIRONMENT, env);
+};
+errorBoundary(getGlobalisedValue('setEnvironment', setEnvironmentFn));
+const setPassportClientIdFn = (passportClientId) => {
+    storeDetail(Detail.PASSPORT_CLIENT_ID, passportClientId);
+};
+errorBoundary(getGlobalisedValue('setPassportClientId', setPassportClientIdFn));
+const setPublishableApiKeyFn = (publishableApiKey) => {
+    storeDetail(Detail.PUBLISHABLE_API_KEY, publishableApiKey);
+};
+errorBoundary(getGlobalisedValue('setPublishableApiKey', setPublishableApiKeyFn));
+
 var Environment;
 (function (Environment) {
     Environment["PRODUCTION"] = "production";
@@ -270,7 +327,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-1.5.2',
+    sdkVersion: 'ts-immutable-sdk-1.5.3-alpha',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "1.5.2",
+  "version": "1.5.3-alpha",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -30,10 +30,12 @@
     "crypto-browserify": "^3.12.0",
     "enc-utils": "^3.0.0",
     "ethers": "^5.7.2",
+    "global-const": "^0.1.2",
     "https-browserify": "^1.0.0",
     "i18next": "^23.7.6",
     "i18next-browser-languagedetector": "^7.2.0",
     "jwt-decode": "^3.1.2",
+    "lru-memorise": "^0.2.1",
     "magic-sdk": "^21.2.0",
     "oidc-client-ts": "2.2.1",
     "os-browserify": "^0.3.0",