@dynamic-labs/wallet-book 1.1.0-alpha.9 → 1.1.0

package/src/helpers/findWalletGroupOverride.cjs

@@ -0,0 +1,13 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var findWalletGroup = require('./findWalletGroup.cjs');
+
+const findWalletGroupOverride = (walletBook, groupKey, walletKey) => {
+    var _a;
+    const group = findWalletGroup.findWalletGroup(walletBook, groupKey);
+    return (_a = group === null || group === void 0 ? void 0 : group.walletOverrides) === null || _a === void 0 ? void 0 : _a[walletKey];
+};
+
+exports.findWalletGroupOverride = findWalletGroupOverride;

package/src/helpers/findWalletGroupOverride.d.ts

@@ -0,0 +1,3 @@
+import { WalletBookSchema } from '../schemas';
+import { WalletGroupOverride } from '../schemas/walletGroup';
+export declare const findWalletGroupOverride: (walletBook: WalletBookSchema, groupKey: string, walletKey: string) => WalletGroupOverride | undefined;

package/src/helpers/findWalletGroupOverride.js

@@ -0,0 +1,9 @@
+import { findWalletGroup } from './findWalletGroup.js';
+
+const findWalletGroupOverride = (walletBook, groupKey, walletKey) => {
+    var _a;
+    const group = findWalletGroup(walletBook, groupKey);
+    return (_a = group === null || group === void 0 ? void 0 : group.walletOverrides) === null || _a === void 0 ? void 0 : _a[walletKey];
+};
+
+export { findWalletGroupOverride };

package/src/helpers/getBrandIconUrl.cjs

@@ -0,0 +1,17 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var renderTemplate = require('./renderTemplate.cjs');
+
+const getBrandIconUrl = (brand) => {
+    if (brand.spriteId) {
+        return renderTemplate.renderTemplate('iconicUrl', brand.spriteId);
+    }
+    if (brand.imageId) {
+        return renderTemplate.renderTemplate('walletConnectUrl', brand.imageId);
+    }
+    return '';
+};
+
+exports.getBrandIconUrl = getBrandIconUrl;

package/src/helpers/getBrandIconUrl.d.ts

@@ -0,0 +1,2 @@
+import { WalletBrand } from '../schemas';
+export declare const getBrandIconUrl: (brand: WalletBrand) => string | undefined;

package/src/helpers/getBrandIconUrl.js

@@ -0,0 +1,13 @@
+import { renderTemplate } from './renderTemplate.js';
+
+const getBrandIconUrl = (brand) => {
+    if (brand.spriteId) {
+        return renderTemplate('iconicUrl', brand.spriteId);
+    }
+    if (brand.imageId) {
+        return renderTemplate('walletConnectUrl', brand.imageId);
+    }
+    return '';
+};
+
+export { getBrandIconUrl };

package/src/helpers/getWalletBookWallet.cjs

@@ -2,13 +2,25 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var normalizeWalletName = require('./normalizeWalletName.cjs');
+var logger = require('./logger.cjs');
+
 const getWalletBookWallet = (walletBook, walletKey) => {
-    var _a, _b;
-    const walletKeyOrDefault = walletKey !== null && walletKey !== void 0 ? walletKey : 'undefined-wallet-key';
-    const walletData = (_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _a === void 0 ? void 0 : _a[walletKeyOrDefault];
-    if (!walletData)
-        throw new Error(`Wallet ${walletKeyOrDefault} not found in wallet book (${Object.keys((_b = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _b !== void 0 ? _b : {}).length} wallets found)`);
-    return walletData;
+    var _a, _b, _c;
+    if (!walletKey)
+        throw new Error('Wallet key is required. Please pass in a wallet key to getWalletBookWallet');
+    const walletDataFromKeyLookup = (_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _a === void 0 ? void 0 : _a[walletKey];
+    if (!walletDataFromKeyLookup) {
+        // adds fallback support. normalizeWalletName will be removed in v2
+        const normalizedWalletKey = normalizeWalletName.normalizeWalletName(walletKey);
+        const walletDataFromNormalizedKeyLookup = (_b = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _b === void 0 ? void 0 : _b[normalizedWalletKey];
+        if (walletDataFromNormalizedKeyLookup) {
+            logger.logger.warn(`deprecated: using walletName: ${walletKey} to look up wallet data is deprecated. use connector.key instead ${normalizedWalletKey}`);
+            return walletDataFromNormalizedKeyLookup;
+        }
+        throw new Error(`Wallet ${normalizedWalletKey} not found in wallet book (${Object.keys((_c = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _c !== void 0 ? _c : {}).length} wallets found)`);
+    }
+    return walletDataFromKeyLookup;
 };
 
 exports.getWalletBookWallet = getWalletBookWallet;

package/src/helpers/getWalletBookWallet.js

@@ -1,10 +1,22 @@
+import { normalizeWalletName } from './normalizeWalletName.js';
+import { logger } from './logger.js';
+
 const getWalletBookWallet = (walletBook, walletKey) => {
-    var _a, _b;
-    const walletKeyOrDefault = walletKey !== null && walletKey !== void 0 ? walletKey : 'undefined-wallet-key';
-    const walletData = (_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _a === void 0 ? void 0 : _a[walletKeyOrDefault];
-    if (!walletData)
-        throw new Error(`Wallet ${walletKeyOrDefault} not found in wallet book (${Object.keys((_b = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _b !== void 0 ? _b : {}).length} wallets found)`);
-    return walletData;
+    var _a, _b, _c;
+    if (!walletKey)
+        throw new Error('Wallet key is required. Please pass in a wallet key to getWalletBookWallet');
+    const walletDataFromKeyLookup = (_a = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _a === void 0 ? void 0 : _a[walletKey];
+    if (!walletDataFromKeyLookup) {
+        // adds fallback support. normalizeWalletName will be removed in v2
+        const normalizedWalletKey = normalizeWalletName(walletKey);
+        const walletDataFromNormalizedKeyLookup = (_b = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) === null || _b === void 0 ? void 0 : _b[normalizedWalletKey];
+        if (walletDataFromNormalizedKeyLookup) {
+            logger.warn(`deprecated: using walletName: ${walletKey} to look up wallet data is deprecated. use connector.key instead ${normalizedWalletKey}`);
+            return walletDataFromNormalizedKeyLookup;
+        }
+        throw new Error(`Wallet ${normalizedWalletKey} not found in wallet book (${Object.keys((_c = walletBook === null || walletBook === void 0 ? void 0 : walletBook.wallets) !== null && _c !== void 0 ? _c : {}).length} wallets found)`);
+    }
+    return walletDataFromKeyLookup;
 };
 
 export { getWalletBookWallet };

package/src/helpers/getWalletIconUrl.cjs

@@ -3,18 +3,15 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var getWalletBookWallet = require('./getWalletBookWallet.cjs');
+var getBrandIconUrl = require('./getBrandIconUrl.cjs');
 var logger = require('./logger.cjs');
 var renderTemplate = require('./renderTemplate.cjs');
 
 const getWalletIconUrl = (walletBook, walletKey) => {
-    var _a, _b;
     try {
         const walletData = getWalletBookWallet.getWalletBookWallet(walletBook, walletKey);
-        if ((_a = walletData === null || walletData === void 0 ? void 0 : walletData.brand) === null || _a === void 0 ? void 0 : _a.spriteId) {
-            return renderTemplate.renderTemplate('iconicUrl', walletData.brand.spriteId);
-        }
-        if ((_b = walletData === null || walletData === void 0 ? void 0 : walletData.brand) === null || _b === void 0 ? void 0 : _b.imageId) {
-            return renderTemplate.renderTemplate('walletConnectUrl', walletData.brand.imageId);
+        if (walletData === null || walletData === void 0 ? void 0 : walletData.brand) {
+            return getBrandIconUrl.getBrandIconUrl(walletData.brand);
         }
     }
     catch (err) {

package/src/helpers/getWalletIconUrl.js

@@ -1,16 +1,13 @@
 import { getWalletBookWallet } from './getWalletBookWallet.js';
+import { getBrandIconUrl } from './getBrandIconUrl.js';
 import { logger } from './logger.js';
 import { renderTemplate } from './renderTemplate.js';
 
 const getWalletIconUrl = (walletBook, walletKey) => {
-    var _a, _b;
     try {
         const walletData = getWalletBookWallet(walletBook, walletKey);
-        if ((_a = walletData === null || walletData === void 0 ? void 0 : walletData.brand) === null || _a === void 0 ? void 0 : _a.spriteId) {
-            return renderTemplate('iconicUrl', walletData.brand.spriteId);
-        }
-        if ((_b = walletData === null || walletData === void 0 ? void 0 : walletData.brand) === null || _b === void 0 ? void 0 : _b.imageId) {
-            return renderTemplate('walletConnectUrl', walletData.brand.imageId);
+        if (walletData === null || walletData === void 0 ? void 0 : walletData.brand) {
+            return getBrandIconUrl(walletData.brand);
         }
     }
     catch (err) {

package/src/helpers/index.d.ts

@@ -9,3 +9,5 @@ export * from './logger';
 export * from './getWalletGroup';
 export * from './findWalletGroup';
 export * from './getWalletBookCdnUrl';
+export * from './getBrandIconUrl';
+export * from './findWalletGroupOverride';

package/src/helpers/normalizeWalletName.cjs

@@ -0,0 +1,7 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+const normalizeWalletName = (name) => { var _a; return (_a = name === null || name === void 0 ? void 0 : name.toLowerCase().replace(/\W/g, '')) !== null && _a !== void 0 ? _a : 'undefined-wallet'; };
+
+exports.normalizeWalletName = normalizeWalletName;

package/src/helpers/normalizeWalletName.js

@@ -0,0 +1,3 @@
+const normalizeWalletName = (name) => { var _a; return (_a = name === null || name === void 0 ? void 0 : name.toLowerCase().replace(/\W/g, '')) !== null && _a !== void 0 ? _a : 'undefined-wallet'; };
+
+export { normalizeWalletName };

package/src/hooks/useWalletBookCdn.cjs

@@ -4,6 +4,7 @@ Object.defineProperty(exports, '__esModule', { value: true });
 
 var _tslib = require('../../_virtual/_tslib.cjs');
 var react = require('react');
+var utils = require('@dynamic-labs/utils');
 require('../schemas/walletConnectSourceSchema.cjs');
 var walletBookSchema = require('../schemas/walletBookSchema.cjs');
 require('../schemas/walletSchema.cjs');
@@ -16,23 +17,28 @@ const useWalletBookCdn = () => {
     react.useEffect(() => {
         const fetchWalletBook = () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
             const url = getWalletBookCdnUrl.getWalletBookCdnUrl();
-            let data;
-            try {
-                const response = yield fetch(url);
-                if (response.ok) {
-                    data = walletBookSchema.walletBookSchema.parse(yield response.json());
+            const fn = () => _tslib.__awaiter(void 0, void 0, void 0, function* () {
+                const res = yield fetch(url, { mode: 'cors' });
+                if (res.ok) {
+                    const json = yield res.json();
+                    try {
+                        const parsedData = walletBookSchema.walletBookSchema.parse(json);
+                        return parsedData;
+                    }
+                    catch (e) {
+                        logger.logger.error('Error parsing wallet book data', e, json);
+                        throw e;
+                    }
                 }
-                else {
-                    throw new Error('Fetch Failed with status: ' + response.status);
-                }
-            }
-            catch (e) {
-                logger.logger.error(`Failed to fetch wallet book data from CDN (${url})`, e);
-            }
-            if (!data) {
-                logger.logger.warn('Falling back to wallet book data from wallet-book-fallbacks.json');
-                data = walletBookSchema.walletBookSchema.parse(walletBookFallbacks["default"]);
-            }
+                throw new Error(`Failed to fetch wallet book data from ${url} with status code ${res.status}`);
+            });
+            const data = yield utils.retryableFn(fn, {
+                fallbackValue: walletBookSchema.walletBookSchema.parse(walletBookFallbacks["default"]),
+                logger: logger.logger.createLogger('useWalletBookCdn'),
+                maxRetries: 3,
+                retryStrategy: 'timeout-and-rejection',
+                timeoutMs: 30000,
+            });
             setWalletBook(data);
         });
         fetchWalletBook();

package/src/hooks/useWalletBookCdn.d.ts

@@ -8,6 +8,15 @@ export declare const useWalletBookCdn: () => {
             primaryColor?: string | undefined;
             spriteId?: string | undefined;
         } | undefined;
+        walletOverrides?: Record<string, {
+            brand?: {
+                alt?: string | undefined;
+                imageId?: string | undefined;
+                primaryColor?: string | undefined;
+                spriteId?: string | undefined;
+            } | undefined;
+            name?: string | undefined;
+        }> | undefined;
     }>;
     wallets: Record<string, {
         name: string;
@@ -17,6 +26,7 @@ export declare const useWalletBookCdn: () => {
             primaryColor?: string | undefined;
             spriteId?: string | undefined;
         } | undefined;
+        chainGroup?: string | undefined;
         chains?: string[] | undefined;
         desktop?: {
             chromeId?: string | undefined;
@@ -32,12 +42,14 @@ export declare const useWalletBookCdn: () => {
         } | undefined;
         filterFromWalletConnect?: boolean | undefined;
         group?: string | undefined;
+        hardwareWallets?: string[] | undefined;
         injectedConfig?: {
             chain: string;
             extensionLocators: {
                 value: boolean;
                 flag: string;
             }[];
+            providerInterface?: string | undefined;
             walletStandard?: {
                 name: string;
                 features: string[];
@@ -58,6 +70,6 @@ export declare const useWalletBookCdn: () => {
         walletConnect?: {
             sdks?: string[] | undefined;
         } | undefined;
-        walletStandardId?: string | undefined;
+        walletGroup?: string | undefined;
     }>;
 };

package/src/hooks/useWalletBookCdn.js

@@ -1,5 +1,6 @@
 import { __awaiter } from '../../_virtual/_tslib.js';
 import { useState, useEffect } from 'react';
+import { retryableFn } from '@dynamic-labs/utils';
 import '../schemas/walletConnectSourceSchema.js';
 import { walletBookSchema } from '../schemas/walletBookSchema.js';
 import '../schemas/walletSchema.js';
@@ -12,23 +13,28 @@ const useWalletBookCdn = () => {
     useEffect(() => {
         const fetchWalletBook = () => __awaiter(void 0, void 0, void 0, function* () {
             const url = getWalletBookCdnUrl();
-            let data;
-            try {
-                const response = yield fetch(url);
-                if (response.ok) {
-                    data = walletBookSchema.parse(yield response.json());
+            const fn = () => __awaiter(void 0, void 0, void 0, function* () {
+                const res = yield fetch(url, { mode: 'cors' });
+                if (res.ok) {
+                    const json = yield res.json();
+                    try {
+                        const parsedData = walletBookSchema.parse(json);
+                        return parsedData;
+                    }
+                    catch (e) {
+                        logger.error('Error parsing wallet book data', e, json);
+                        throw e;
+                    }
                 }
-                else {
-                    throw new Error('Fetch Failed with status: ' + response.status);
-                }
-            }
-            catch (e) {
-                logger.error(`Failed to fetch wallet book data from CDN (${url})`, e);
-            }
-            if (!data) {
-                logger.warn('Falling back to wallet book data from wallet-book-fallbacks.json');
-                data = walletBookSchema.parse(walletBookFallbacks);
-            }
+                throw new Error(`Failed to fetch wallet book data from ${url} with status code ${res.status}`);
+            });
+            const data = yield retryableFn(fn, {
+                fallbackValue: walletBookSchema.parse(walletBookFallbacks),
+                logger: logger.createLogger('useWalletBookCdn'),
+                maxRetries: 3,
+                retryStrategy: 'timeout-and-rejection',
+                timeoutMs: 30000,
+            });
             setWalletBook(data);
         });
         fetchWalletBook();

package/src/hooks/useWalletBookContext.cjs

@@ -3,7 +3,9 @@
 Object.defineProperty(exports, '__esModule', { value: true });
 
 var react = require('react');
+require('../../_virtual/_tslib.cjs');
 require('../helpers/logger.cjs');
+require('@dynamic-labs/utils');
 require('../schemas/walletConnectSourceSchema.cjs');
 require('../schemas/walletBookSchema.cjs');
 require('../schemas/walletSchema.cjs');

package/src/hooks/useWalletBookContext.js

@@ -1,5 +1,7 @@
 import { useContext } from 'react';
+import '../../_virtual/_tslib.js';
 import '../helpers/logger.js';
+import '@dynamic-labs/utils';
 import '../schemas/walletConnectSourceSchema.js';
 import '../schemas/walletBookSchema.js';
 import '../schemas/walletSchema.js';

package/src/index.cjs

@@ -11,10 +11,13 @@ require('./helpers/logger.cjs');
 var getWalletGroup = require('./helpers/getWalletGroup.cjs');
 var findWalletGroup = require('./helpers/findWalletGroup.cjs');
 var getWalletBookCdnUrl = require('./helpers/getWalletBookCdnUrl.cjs');
+var getBrandIconUrl = require('./helpers/getBrandIconUrl.cjs');
+var findWalletGroupOverride = require('./helpers/findWalletGroupOverride.cjs');
 var useWalletBookCdn = require('./hooks/useWalletBookCdn.cjs');
 var useWalletBookContext = require('./hooks/useWalletBookContext.cjs');
 var WalletIcon = require('./components/WalletIcon.cjs');
 var WalletBookContext = require('./components/WalletBookContext.cjs');
+var BrandIcon = require('./components/BrandIcon.cjs');
 
 
 
@@ -26,7 +29,10 @@ exports.findWalletBookWallet = findWalletBookWallet.findWalletBookWallet;
 exports.getWalletGroup = getWalletGroup.getWalletGroup;
 exports.findWalletGroup = findWalletGroup.findWalletGroup;
 exports.getWalletBookCdnUrl = getWalletBookCdnUrl.getWalletBookCdnUrl;
+exports.getBrandIconUrl = getBrandIconUrl.getBrandIconUrl;
+exports.findWalletGroupOverride = findWalletGroupOverride.findWalletGroupOverride;
 exports.useWalletBookCdn = useWalletBookCdn.useWalletBookCdn;
 exports.useWalletBookContext = useWalletBookContext.useWalletBookContext;
 exports.WalletIcon = WalletIcon.WalletIcon;
 exports.WalletBookContextProvider = WalletBookContext.WalletBookContextProvider;
+exports.BrandIcon = BrandIcon.BrandIcon;

package/src/index.d.ts

@@ -7,7 +7,7 @@ export type { WalletLinks } from './helpers';
 /**
  * HELPERS
  */
-export { getWalletBookWallet, getWalletIconUrl, getWalletLinks, getWalletPrimaryColor, getWalletGroup, getWalletBookCdnUrl, findWalletBookWallet, findWalletGroup, } from './helpers';
+export { getWalletBookWallet, getWalletIconUrl, getWalletLinks, getWalletPrimaryColor, getWalletGroup, getWalletBookCdnUrl, findWalletBookWallet, findWalletGroup, getBrandIconUrl, findWalletGroupOverride, } from './helpers';
 /**
  * HOOKS
  */
@@ -15,4 +15,4 @@ export { useWalletBookCdn, useWalletBookContext } from './hooks';
 /**
  * COMPONENTS
  */
-export { WalletIcon, WalletBookContextProvider } from './components';
+export { WalletIcon, WalletBookContextProvider, BrandIcon } from './components';

package/src/index.js

@@ -7,7 +7,10 @@ import './helpers/logger.js';
 export { getWalletGroup } from './helpers/getWalletGroup.js';
 export { findWalletGroup } from './helpers/findWalletGroup.js';
 export { getWalletBookCdnUrl } from './helpers/getWalletBookCdnUrl.js';
+export { getBrandIconUrl } from './helpers/getBrandIconUrl.js';
+export { findWalletGroupOverride } from './helpers/findWalletGroupOverride.js';
 export { useWalletBookCdn } from './hooks/useWalletBookCdn.js';
 export { useWalletBookContext } from './hooks/useWalletBookContext.js';
 export { WalletIcon } from './components/WalletIcon.js';
 export { WalletBookContextProvider } from './components/WalletBookContext.js';
+export { BrandIcon } from './components/BrandIcon.js';