@imtbl/sdk 0.37.0 → 0.39.0

package/dist/index.js

@@ -39,7 +39,7 @@ class ImmutableConfiguration {
     }
 }
 const API_KEY_PREFIX = 'sk_imapik-';
-const PUBLISHABLE_KEY_PREFIX = 'pk_imapik-';
+const PUBLISHABLE_KEY_PREFIX$1 = 'pk_imapik-';
 const addApiKeyToAxiosHeader = (apiKey) => {
     if (!apiKey.startsWith(API_KEY_PREFIX)) {
         throw new Error('Invalid API key. Create your api key in Immutable developer hub. https://hub.immutable.com');
@@ -47,7 +47,7 @@ const addApiKeyToAxiosHeader = (apiKey) => {
     globalAxios$1.defaults.headers.common['x-immutable-api-key'] = apiKey;
 };
 const addPublishableKeyToAxiosHeader = (publishableKey) => {
-    if (!publishableKey.startsWith(PUBLISHABLE_KEY_PREFIX)) {
+    if (!publishableKey.startsWith(PUBLISHABLE_KEY_PREFIX$1)) {
         throw new Error('Invalid Publishable key. Create your Publishable key in Immutable developer hub.'
             + ' https://hub.immutable.com');
     }
@@ -4234,7 +4234,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.37.0' };
+const defaultHeaders$1 = { 'x-sdk-version': 'ts-immutable-sdk-0.39.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -4294,7 +4294,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.37.0',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.39.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -4733,7 +4733,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.37.0',
+    sdkVersion: 'ts-immutable-sdk-0.39.0',
 });
 /**
  * Sets `sdkVersion` at the time of build
@@ -34780,6 +34780,7 @@ var ConnectEventType;
     ConnectEventType["CLOSE_WIDGET"] = "close-widget";
     ConnectEventType["SUCCESS"] = "success";
     ConnectEventType["FAILURE"] = "failure";
+    ConnectEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(ConnectEventType || (ConnectEventType = {}));
 
 /**
@@ -34790,6 +34791,7 @@ var WalletEventType;
     WalletEventType["CLOSE_WIDGET"] = "close-widget";
     WalletEventType["NETWORK_SWITCH"] = "network-switch";
     WalletEventType["DISCONNECT_WALLET"] = "disconnect-wallet";
+    WalletEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(WalletEventType || (WalletEventType = {}));
 
 /**
@@ -34801,6 +34803,7 @@ var SwapEventType;
     SwapEventType["SUCCESS"] = "success";
     SwapEventType["FAILURE"] = "failure";
     SwapEventType["REJECTED"] = "rejected";
+    SwapEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(SwapEventType || (SwapEventType = {}));
 
 /**
@@ -34813,6 +34816,7 @@ var SaleEventType;
     SaleEventType["FAILURE"] = "failure";
     SaleEventType["REJECTED"] = "rejected";
     SaleEventType["TRANSACTION_SUCCESS"] = "transaction-success";
+    SaleEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(SaleEventType || (SaleEventType = {}));
 
 /**
@@ -34823,6 +34827,7 @@ var BridgeEventType;
     BridgeEventType["CLOSE_WIDGET"] = "close-widget";
     BridgeEventType["FAILURE"] = "failure";
     BridgeEventType["TRANSACTION_SENT"] = "transaction-sent";
+    BridgeEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(BridgeEventType || (BridgeEventType = {}));
 
 /**
@@ -34845,6 +34850,7 @@ var OnRampEventType;
     OnRampEventType["CLOSE_WIDGET"] = "close-widget";
     OnRampEventType["SUCCESS"] = "success";
     OnRampEventType["FAILURE"] = "failure";
+    OnRampEventType["LANGUAGE_CHANGED"] = "language-changed";
 })(OnRampEventType || (OnRampEventType = {}));
 
 /**
@@ -35233,7 +35239,11 @@ async function addNetworkToWallet(networkMap, web3Provider, chainId) {
 async function getNetworkAllowList(config, { type = NetworkFilterTypes.ALL, exclude }) {
     const { networkMap } = config;
     const allowedNetworkConfig = (await config.remote.getConfig('allowedNetworks'));
-    const list = allowedNetworkConfig.filter((network) => {
+    if (!allowedNetworkConfig) {
+        // eslint-disable-next-line no-console
+        console.warn('No allowed networks configured');
+    }
+    const list = (allowedNetworkConfig || []).filter((network) => {
         const allowAllTokens = type === NetworkFilterTypes.ALL;
         const networkNotExcluded = !(exclude || [])
             .map((exc) => exc.chainId)
@@ -35673,32 +35683,21 @@ const GAS_OVERRIDES = {
     maxPriorityFeePerGas: BigNumber$1.from(101e9),
 };
 
-const SDK_VERSION_MARKER = '0.37.0';
+const SDK_VERSION_MARKER = '0.39.0';
 // This SDK version is replaced by the `yarn build` command ran on the root level
 const globalPackageVersion = () => SDK_VERSION_MARKER;
 
 class RemoteConfigFetcher {
+    httpClient;
     isDevelopment;
     isProduction;
     configCache;
     tokensCache;
     version = 'v1';
-    constructor(params) {
+    constructor(httpClient, params) {
         this.isDevelopment = params.isDevelopment;
         this.isProduction = params.isProduction;
-    }
-    static async makeHttpRequest(url) {
-        let response;
-        try {
-            response = await globalAxios$1.get(url);
-        }
-        catch (error) {
-            throw new CheckoutError(`Error fetching from api: ${error.message}`, CheckoutErrorType.API_ERROR);
-        }
-        if (response.status !== 200) {
-            throw new CheckoutError(`Error fetching from api: ${response.status} ${response.statusText}`, CheckoutErrorType.API_ERROR);
-        }
-        return response;
+        this.httpClient = httpClient;
     }
     getEndpoint = () => {
         if (this.isDevelopment)
@@ -35707,18 +35706,33 @@ class RemoteConfigFetcher {
             return CHECKOUT_CDN_BASE_URL[Environment$1.PRODUCTION];
         return CHECKOUT_CDN_BASE_URL[Environment$1.SANDBOX];
     };
+    // eslint-disable-next-line class-methods-use-this
+    parseResponse(response) {
+        let responseData = response.data;
+        if (response.data && typeof response.data !== 'object') {
+            try {
+                responseData = JSON.parse(response.data);
+            }
+            catch (jsonError) {
+                throw new CheckoutError('Invalid configuration', CheckoutErrorType.API_ERROR);
+            }
+        }
+        return responseData;
+    }
     async loadConfig() {
         if (this.configCache)
             return this.configCache;
-        const response = await RemoteConfigFetcher.makeHttpRequest(`${this.getEndpoint()}/${this.version}/config`);
-        this.configCache = response.data;
+        const response = await this.httpClient.get(`${this.getEndpoint()}/${this.version}/config`);
+        // Ensure that the configuration is valid
+        this.configCache = this.parseResponse(response);
         return this.configCache;
     }
     async loadConfigTokens() {
         if (this.tokensCache)
             return this.tokensCache;
-        const response = await RemoteConfigFetcher.makeHttpRequest(`${this.getEndpoint()}/${this.version}/config/tokens`);
-        this.tokensCache = response.data;
+        const response = await this.httpClient.get(`${this.getEndpoint()}/${this.version}/config/tokens`);
+        // Ensure that the configuration is valid
+        this.tokensCache = this.parseResponse(response);
         return this.tokensCache;
     }
     async getConfig(key) {
@@ -35735,6 +35749,7 @@ class RemoteConfigFetcher {
             return {};
         return config[chainId] ?? [];
     }
+    getHttpClient = () => this.httpClient;
 }
 
 class CheckoutConfigurationError extends Error {
@@ -35785,7 +35800,7 @@ class CheckoutConfiguration {
     remote;
     environment;
     networkMap;
-    constructor(config) {
+    constructor(config, httpClient) {
         if (!Object.values(Environment$1).includes(config.baseConfig.environment)) {
             throw new CheckoutConfigurationError('Invalid checkout configuration of environment');
         }
@@ -35796,7 +35811,7 @@ class CheckoutConfiguration {
         this.isSwapEnabled = config.swap?.enable ?? DEFAULT_SWAP_ENABLED;
         this.isBridgeEnabled = config.bridge?.enable ?? DEFAULT_BRIDGE_ENABLED;
         this.networkMap = networkMap(this.isProduction, this.isDevelopment);
-        this.remote = new RemoteConfigFetcher({
+        this.remote = new RemoteConfigFetcher(httpClient, {
             isDevelopment: this.isDevelopment,
             isProduction: this.isProduction,
         });
@@ -35861,9 +35876,7 @@ class Blockscout {
     ttl;
     chainId;
     cacheMap;
-    static async makeHttpRequest(url) {
-        return globalAxios$1.get(url);
-    }
+    httpClient;
     setCache(key, data) {
         this.cacheMap[key] = { data, ttl: new Date().getTime() + this.ttl * 1000 };
     }
@@ -35875,11 +35888,13 @@ class Blockscout {
     }
     /**
      * Blockscout constructor
+     * @param httpClient Client used for http requests
      * @param chainId target chain
      * @param ttl cache TTL
      */
-    constructor(params) {
-        this.chainId = params.chainId;
+    constructor(httpClient, chainId, ttl) {
+        this.httpClient = httpClient;
+        this.chainId = chainId;
         this.url = BLOCKSCOUT_CHAIN_URL_MAP[this.chainId].url;
         const native = BLOCKSCOUT_CHAIN_URL_MAP[this.chainId].nativeToken;
         this.nativeToken = {
@@ -35889,7 +35904,7 @@ class Blockscout {
             symbol: native.symbol,
         };
         this.cacheMap = {};
-        this.ttl = params.ttl !== undefined ? params.ttl : CACHE_DATA_TTL;
+        this.ttl = ttl !== undefined ? ttl : CACHE_DATA_TTL;
     }
     /**
      * isChainSupported verifies if the chain is supported by Blockscout
@@ -35917,7 +35932,7 @@ class Blockscout {
             const cached = this.getCache(url);
             if (cached)
                 return Promise.resolve(cached);
-            const response = await Blockscout.makeHttpRequest(url);
+            const response = await this.httpClient.get(url);
             if (response.status >= 400) {
                 return Promise.reject({
                     code: response.status,
@@ -35958,7 +35973,7 @@ class Blockscout {
             const cached = this.getCache(url);
             if (cached)
                 return Promise.resolve(cached);
-            const response = await Blockscout.makeHttpRequest(url);
+            const response = await this.httpClient.get(url);
             if (response.status >= 400) {
                 return Promise.reject({
                     code: response.status,
@@ -36043,7 +36058,7 @@ const blockscoutClientMap = new Map();
 // This function is a utility function that can be used to reset the
 // blockscout map and therefore clear all the cache.
 const resetBlockscoutClientMap = () => blockscoutClientMap.clear();
-const getIndexerBalance = async (walletAddress, chainId, filterTokens) => {
+const getIndexerBalance = async (config, walletAddress, chainId, filterTokens) => {
     // Shuffle the mapping of the tokens configuration so it is a hashmap
     // for faster access to tokens config objects.
     const shouldFilter = filterTokens !== undefined;
@@ -36051,7 +36066,8 @@ const getIndexerBalance = async (walletAddress, chainId, filterTokens) => {
     // Get blockscout client for the given chain
     let blockscoutClient = blockscoutClientMap.get(chainId);
     if (!blockscoutClient) {
-        blockscoutClient = new Blockscout({ chainId });
+        const httpClient = config.remote.getHttpClient();
+        blockscoutClient = new Blockscout(httpClient, chainId);
         blockscoutClientMap.set(chainId, blockscoutClient);
     }
     // Hold the items in an array for post-fetching processing
@@ -36186,7 +36202,7 @@ const getAllBalances = async (config, web3Provider, walletAddress, chainId) => {
         const isL1Chain = getL1ChainId(config) === chainId;
         if (!address)
             address = await web3Provider?.getSigner().getAddress();
-        return await measureAsyncExecution(config, `Time to fetch balances using blockscout for ${chainId}`, getIndexerBalance(address, chainId, isL1Chain ? tokens : undefined));
+        return await measureAsyncExecution(config, `Time to fetch balances using blockscout for ${chainId}`, getIndexerBalance(config, address, chainId, isL1Chain ? tokens : undefined));
     }
     if (!web3Provider) {
         throw new CheckoutError('indexer is disabled for this chain, you must provide a provider.', CheckoutErrorType.MISSING_PARAMS);
@@ -37870,8 +37886,8 @@ const bridgeRoute = async (config, readOnlyProviders, availableRoutingOptions, b
     if (tokenBalanceResult === undefined || tokenBalanceResult.success === false)
         return undefined;
     // todo: revert this back to using the allowlist
-    const allowedTokenList = await allowListCheckForBridge(config, tokenBalanceResults, availableRoutingOptions);
-    if (allowedTokenList.length === 0)
+    const allowedL1TokenList = await allowListCheckForBridge(config, tokenBalanceResults, availableRoutingOptions);
+    if (allowedL1TokenList.length === 0)
         return undefined;
     const l1RepresentationResult = await fetchL1Representation(config, bridgeRequirement.l2address);
     if (!l1RepresentationResult)
@@ -37879,10 +37895,10 @@ const bridgeRoute = async (config, readOnlyProviders, availableRoutingOptions, b
     // Ensure l1address is in the allowed token list
     const { l1address } = l1RepresentationResult;
     if (isNativeToken(l1address)) {
-        if (!allowedTokenList.find((token) => !('address' in token)))
+        if (!allowedL1TokenList.find((token) => isNativeToken(token.address)))
             return undefined;
     }
-    else if (!allowedTokenList.find((token) => token.address === l1address)) {
+    else if (!allowedL1TokenList.find((token) => token.address === l1address)) {
         return undefined;
     }
     const feesFromBridge = await getBridgeFeeEstimate(config, readOnlyProviders, l1ChainId, l2ChainId);
@@ -39179,6 +39195,90 @@ function loadUnresolved(version) {
     return { loaded: false, element: tag };
 }
 
+const PUBLISHABLE_KEY_PREFIX = 'pk_imapik-';
+const publishableKeyDomainAllowlist = [
+    'https://checkout-api.dev.immutable.com',
+    'https://checkout-api.sandbox.immutable.com',
+    'https://checkout-api.immutable.com',
+];
+class HttpClient {
+    config;
+    axiosInstance;
+    constructor(config) {
+        this.config = config;
+        this.axiosInstance = globalAxios$1.create();
+        this.setupInterceptors();
+    }
+    // eslint-disable-next-line class-methods-use-this
+    shouldAddPublishableKey(url) {
+        // Check if the request is going to a whitelisted domain
+        return publishableKeyDomainAllowlist.some((domain) => url.startsWith(domain));
+    }
+    setupInterceptors() {
+        this.axiosInstance.interceptors.request.use((config) => {
+            const publishableKey = this.config?.baseConfig?.publishableKey;
+            if (publishableKey && this.shouldAddPublishableKey(config.url || '')) {
+                if (!publishableKey.startsWith(PUBLISHABLE_KEY_PREFIX)) {
+                    throw new Error('Invalid Publishable key. Create your Publishable key in Immutable developer hub.'
+                        + ' https://hub.immutable.com');
+                }
+                // Add publishable key header for whitelisted domains
+                // eslint-disable-next-line no-param-reassign
+                config.headers['x-immutable-publishable-key'] = publishableKey;
+            }
+            return config;
+        }, (error) => Promise.reject(error));
+    }
+    // eslint-disable-next-line class-methods-use-this
+    processResponse(response) {
+        if (response && response?.status !== 200) {
+            throw new CheckoutError(`Error: ${response.status} ${response.statusText}`, CheckoutErrorType.API_ERROR);
+        }
+    }
+    async request(config) {
+        let response;
+        try {
+            response = await this.axiosInstance.request(config);
+        }
+        catch (error) {
+            throw new CheckoutError(error.message, CheckoutErrorType.API_ERROR);
+        }
+        this.processResponse(response);
+        return response;
+    }
+    async get(url, config) {
+        const requestConfig = {
+            ...config,
+            url,
+        };
+        return await this.request(requestConfig);
+    }
+    async post(url, data, config) {
+        const requestConfig = {
+            ...config,
+            data,
+            url,
+        };
+        return await this.request(requestConfig);
+    }
+    async put(url, data, config) {
+        const requestConfig = {
+            ...config,
+            data,
+            url,
+        };
+        return await this.request(requestConfig);
+    }
+    async delete(url, data, config) {
+        const requestConfig = {
+            ...config,
+            data,
+            url,
+        };
+        return await this.request(requestConfig);
+    }
+}
+
 const SANDBOX_CONFIGURATION = {
     baseConfig: {
         environment: Environment$1.SANDBOX,
@@ -39189,6 +39289,7 @@ const WIDGETS_SCRIPT_TIMEOUT = 100;
 // Checkout SDK
 class Checkout {
     readOnlyProviders;
+    httpClient;
     config;
     fiatRampService;
     availability;
@@ -39198,7 +39299,8 @@ class Checkout {
      * @param {CheckoutModuleConfiguration} [config=SANDBOX_CONFIGURATION] - The configuration object for the CheckoutModule.
      */
     constructor(config = SANDBOX_CONFIGURATION) {
-        this.config = new CheckoutConfiguration(config);
+        this.httpClient = new HttpClient(config);
+        this.config = new CheckoutConfiguration(config, this.httpClient);
         this.fiatRampService = new FiatRampService(this.config);
         this.readOnlyProviders = new Map();
         this.availability = availabilityService(this.config.isDevelopment, this.config.isProduction);

package/dist/passport.js

@@ -2349,7 +2349,7 @@ class MultiRollupApiClients {
 }
 
 // eslint-disable-next-line @typescript-eslint/naming-convention
-const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.37.0' };
+const defaultHeaders = { 'x-sdk-version': 'ts-immutable-sdk-0.39.0' };
 const createConfig = ({ basePath, headers, }) => {
     if (!basePath.trim()) {
         throw Error('basePath can not be empty');
@@ -2405,7 +2405,7 @@ const createImmutableXConfiguration = ({ basePath, chainID, coreContractAddress,
     chainID,
     coreContractAddress,
     registrationContractAddress,
-    sdkVersion: 'ts-immutable-sdk-0.37.0',
+    sdkVersion: 'ts-immutable-sdk-0.39.0',
 });
 /**
  * Sets `sdkVersion` at the time of build

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@imtbl/sdk",
   "description": "Immutable Unified SDK",
-  "version": "0.37.0",
+  "version": "0.39.0",
   "author": "Immutable",
   "browser": "./dist/index.browser.js",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
@@ -31,11 +31,14 @@
     "enc-utils": "^3.0.0",
     "ethers": "^5.7.2",
     "https-browserify": "^1.0.0",
+    "i18next": "^23.7.6",
+    "i18next-browser-languagedetector": "^7.2.0",
     "jwt-decode": "^3.1.2",
     "magic-sdk": "^21.2.0",
     "oidc-client-ts": "^2.2.1",
     "os-browserify": "^0.3.0",
     "pako": "^2.1.0",
+    "react-i18next": "^13.5.0",
     "stream-browserify": "^3.0.0",
     "stream-http": "^3.2.0",
     "url": "^0.11.0"