@dynamic-labs-sdk/client 1.2.1 → 1.3.0

package/dist/modules/walletOptionsCatalogue/compareByRelevance/compareByRelevance.d.ts

@@ -0,0 +1,18 @@
+import type { WalletOption } from '../walletOptionsCatalogue.types';
+type CompareByRelevanceParams = {
+    a: WalletOption;
+    b: WalletOption;
+};
+/**
+ * Compares two wallet options for relevance ordering: priority-list index
+ * first, then alphabetical-by-name as the tie-break. Suitable for passing
+ * straight to `Array.prototype.sort`.
+ *
+ * @param params.a - First wallet option.
+ * @param params.b - Second wallet option.
+ * @returns Negative when `a` ranks first, positive when `b` ranks first.
+ * @not-instrumented
+ */
+export declare const compareByRelevance: ({ a, b, }: CompareByRelevanceParams) => number;
+export {};
+//# sourceMappingURL=compareByRelevance.d.ts.map

package/dist/modules/walletOptionsCatalogue/compareByRelevance/compareByRelevance.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"compareByRelevance.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/compareByRelevance/compareByRelevance.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEpE,KAAK,wBAAwB,GAAG;IAC9B,CAAC,EAAE,YAAY,CAAC;IAChB,CAAC,EAAE,YAAY,CAAC;CACjB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,kBAAkB,cAG5B,wBAAwB,KAAG,MAS7B,CAAC"}

package/dist/modules/walletOptionsCatalogue/excludedWalletOptionKeys/excludedWalletOptionKeys.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Wallet option keys `getWalletOptionsCatalogue` drops before returning.
+ * Curated, product-level suppression.
+ *
+ * Example: Base Account SDK is the recommended entry point for
+ * Coinbase-managed users, so the legacy Coinbase Wallet entries are
+ * suppressed in favor of the SDK-backed `baseaccount` tile. Both the
+ * wallet book group key (`coinbase`) and the normalized display-name
+ * key (`coinbasewallet`) are listed so suppression holds regardless of
+ * how the resolver lands on a key.
+ *
+ * Used in: `getWalletOptionsCatalogue`.
+ */
+export declare const EXCLUDED_WALLET_OPTION_KEYS: ReadonlySet<string>;
+//# sourceMappingURL=excludedWalletOptionKeys.d.ts.map

package/dist/modules/walletOptionsCatalogue/excludedWalletOptionKeys/excludedWalletOptionKeys.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"excludedWalletOptionKeys.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/excludedWalletOptionKeys/excludedWalletOptionKeys.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,2BAA2B,EAAE,WAAW,CAAC,MAAM,CAG1D,CAAC"}

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findByNameMatch/findByNameMatch.d.ts

@@ -0,0 +1,21 @@
+import type { WalletBookSchema } from '../../../legacyWalletBook/legacyWalletBook.types';
+type FindByNameMatchParams = {
+    candidate: string;
+    walletBook: WalletBookSchema;
+};
+/**
+ * Looks for a wallet book entry whose `name` or `shortName` normalizes to
+ * the same string as `candidate`. Used as a fallback by
+ * `findWalletOptionKeyForProviderKey` for providers whose
+ * `walletProviderKey` strips down to a value that does not match any
+ * `walletBook.wallets` key directly (e.g. an extension whose display name
+ * happens to match the wallet's `shortName` instead of its book key).
+ *
+ * @param params.candidate - The lowercased, chain-suffix-stripped candidate.
+ * @param params.walletBook - The fetched wallet book.
+ * @returns The matching wallet book wallet key, or `undefined`.
+ * @not-instrumented
+ */
+export declare const findByNameMatch: ({ candidate, walletBook, }: FindByNameMatchParams) => string | undefined;
+export {};
+//# sourceMappingURL=findByNameMatch.d.ts.map

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findByNameMatch/findByNameMatch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findByNameMatch.d.ts","sourceRoot":"","sources":["../../../../../src/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findByNameMatch/findByNameMatch.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AAEzF,KAAK,qBAAqB,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,gBAAgB,CAAC;CAC9B,CAAC;AAKF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,eAAe,+BAGzB,qBAAqB,KAAG,MAAM,GAAG,SAWnC,CAAC"}

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findWalletOptionKeyForProviderKey.d.ts

@@ -0,0 +1,44 @@
+import type { Chain } from '../../chain';
+import type { WalletBookSchema } from '../../legacyWalletBook/legacyWalletBook.types';
+import type { WalletProvider } from '../../wallets/walletProvider/walletProvider.types';
+type FindWalletOptionKeyForProviderKeyParams = {
+    chain: Chain;
+    walletBook: WalletBookSchema;
+    walletProvider: WalletProvider;
+};
+/**
+ * Resolves a registered wallet provider to the wallet option key it should
+ * be bucketed under. Always returns a key — providers with no wallet book
+ * match fall back to their self-announced `metadata.displayName`, so the
+ * catalogue surfaces them as self-described tiles instead of silently
+ * dropping them.
+ *
+ * Resolution order (each step short-circuits on first hit):
+ *
+ * 1. **Direct wallet book lookup with chain suffix** — try
+ *    `walletBook.wallets[normalizedWalletNameWithChain]` as-is. Wallet
+ *    book entries are inconsistent about whether they keep the chain
+ *    suffix (e.g. `metamaskevm`) or strip it (e.g. `metamask`), so try
+ *    the suffixed form first.
+ * 2. **Direct wallet book lookup without chain suffix** — strip the
+ *    suffix and retry.
+ * 3. **Name match heuristic with chain suffix** — scan
+ *    `walletBook.wallets` for an entry whose normalized `name` or
+ *    `shortName` equals the suffixed candidate.
+ * 4. **Name match heuristic without chain suffix** — same scan on the
+ *    stripped candidate.
+ * 5. **Display-name fallback** — derive a stable key from
+ *    `walletProvider.metadata.displayName` via
+ *    {@link normalizeWalletDisplayName}. Multi-chain registrations of the
+ *    same self-described wallet (e.g. Phantom on EVM and Solana) collapse
+ *    onto the same tile because each announces the same display name.
+ *
+ * @param params.chain - The provider's chain (used to strip the suffix).
+ * @param params.walletBook - The fetched wallet book.
+ * @param params.walletProvider - The registered wallet provider.
+ * @returns The wallet option key for this provider.
+ * @not-instrumented
+ */
+export declare const findWalletOptionKeyForProviderKey: ({ chain, walletBook, walletProvider, }: FindWalletOptionKeyForProviderKeyParams) => string;
+export {};
+//# sourceMappingURL=findWalletOptionKeyForProviderKey.d.ts.map

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findWalletOptionKeyForProviderKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"findWalletOptionKeyForProviderKey.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/findWalletOptionKeyForProviderKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,+CAA+C,CAAC;AAGtF,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,mDAAmD,CAAC;AAKxF,KAAK,uCAAuC,GAAG;IAC7C,KAAK,EAAE,KAAK,CAAC;IACb,UAAU,EAAE,gBAAgB,CAAC;IAC7B,cAAc,EAAE,cAAc,CAAC;CAChC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,iCAAiC,2CAI3C,uCAAuC,KAAG,MAoC5C,CAAC"}

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/resolveWalletOptionKey/resolveWalletOptionKey.d.ts

@@ -0,0 +1,20 @@
+import type { WalletBookSchema } from '../../../legacyWalletBook/legacyWalletBook.types';
+type ResolveWalletOptionKeyParams = {
+    fallback: string;
+    wallet: WalletBookSchema['wallets'][string];
+};
+/**
+ * Picks the wallet option (group) key for a wallet book wallet. The wallet
+ * book carries the group association under a few different field names
+ * (`group`, `chainGroup`, `walletGroup`) depending on the wallet's
+ * provenance — this helper centralises the lookup. When none of those
+ * fields are set, the wallet key itself acts as its own wallet option key.
+ *
+ * @param params.fallback - Wallet key to return if no group field is set.
+ * @param params.wallet - The wallet book wallet entry.
+ * @returns The resolved wallet option key.
+ * @not-instrumented
+ */
+export declare const resolveWalletOptionKey: ({ fallback, wallet, }: ResolveWalletOptionKeyParams) => string;
+export {};
+//# sourceMappingURL=resolveWalletOptionKey.d.ts.map

package/dist/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/resolveWalletOptionKey/resolveWalletOptionKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveWalletOptionKey.d.ts","sourceRoot":"","sources":["../../../../../src/modules/walletOptionsCatalogue/findWalletOptionKeyForProviderKey/resolveWalletOptionKey/resolveWalletOptionKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kDAAkD,CAAC;AAEzF,KAAK,4BAA4B,GAAG;IAClC,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,gBAAgB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,sBAAsB,0BAGhC,4BAA4B,KAAG,MACmC,CAAC"}

package/dist/modules/walletOptionsCatalogue/getConnectionOptionPriority/getConnectionOptionPriority.d.ts

@@ -0,0 +1,15 @@
+import type { WalletConnectionOption } from '../walletOptionsCatalogue.types';
+type GetConnectionOptionPriorityParams = {
+    option: WalletConnectionOption;
+};
+/**
+ * Returns the numeric priority of a `WalletConnectionOption` for sorting.
+ * Lower numbers rank first.
+ *
+ * @param params.option - The connection option to inspect.
+ * @returns The numeric priority — lower is better.
+ * @not-instrumented
+ */
+export declare const getConnectionOptionPriority: ({ option, }: GetConnectionOptionPriorityParams) => number;
+export {};
+//# sourceMappingURL=getConnectionOptionPriority.d.ts.map

package/dist/modules/walletOptionsCatalogue/getConnectionOptionPriority/getConnectionOptionPriority.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getConnectionOptionPriority.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/getConnectionOptionPriority/getConnectionOptionPriority.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAiB9E,KAAK,iCAAiC,GAAG;IACvC,MAAM,EAAE,sBAAsB,CAAC;CAChC,CAAC;AAEF;;;;;;;GAOG;AACH,eAAO,MAAM,2BAA2B,gBAErC,iCAAiC,KAAG,MACE,CAAC"}

package/dist/modules/walletOptionsCatalogue/getPriorityIndex/getPriorityIndex.d.ts

@@ -0,0 +1,16 @@
+import type { WalletOption } from '../walletOptionsCatalogue.types';
+type GetPriorityIndexParams = {
+    walletOption: WalletOption;
+};
+/**
+ * Returns the index of a wallet option in `PRIORITY_WALLET_KEYS`, or
+ * `Number.POSITIVE_INFINITY` when the wallet is not in the hand-curated
+ * priority list. Lower index = higher priority.
+ *
+ * @param params.walletOption - The wallet option to inspect.
+ * @returns Numeric priority index — lower is better.
+ * @not-instrumented
+ */
+export declare const getPriorityIndex: ({ walletOption, }: GetPriorityIndexParams) => number;
+export {};
+//# sourceMappingURL=getPriorityIndex.d.ts.map

package/dist/modules/walletOptionsCatalogue/getPriorityIndex/getPriorityIndex.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getPriorityIndex.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/getPriorityIndex/getPriorityIndex.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEpE,KAAK,sBAAsB,GAAG;IAC5B,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF;;;;;;;;GAQG;AACH,eAAO,MAAM,gBAAgB,sBAE1B,sBAAsB,KAAG,MAI3B,CAAC"}

package/dist/modules/walletOptionsCatalogue/getWalletOptionsCatalogue/getWalletOptionsCatalogue.d.ts

@@ -0,0 +1,24 @@
+import type { GetWalletOptionsCatalogueParams, WalletOptionsCatalogue } from '../walletOptionsCatalogue.types';
+/**
+ * Returns a catalogue of the external wallet options a user can sign in
+ * with through this client. Each wallet option carries an ordered
+ * `connectionOptions` array — `withWalletProvider` (direct), `walletConnect`
+ * (deeplink/QR), or `inAppBrowser` (mobile webview). Wallet options without
+ * any matching connections are omitted.
+ *
+ * `includeWithWalletProvider` defaults to `true`; all other inclusion flags
+ * are opt-in. `walletOptionOrdering` defaults to `'relevance'` (Dynamic's
+ * recommended order); pass `'alphabetical'` to sort by wallet option name
+ * within each option-priority tier.
+ *
+ * The wallet book is fetched only when an enabled flag needs it
+ * (`includeWalletConnect`, `includeInAppBrowser`). Calls that only need
+ * `includeWithWalletProvider` skip the fetch entirely.
+ *
+ * @param [params] - Inclusion flags + ordering preference.
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise that resolves to the wallet options catalogue.
+ * @not-instrumented
+ */
+export declare const getWalletOptionsCatalogue: (params?: GetWalletOptionsCatalogueParams, client?: import("../../../exports").DynamicClient) => Promise<WalletOptionsCatalogue>;
+//# sourceMappingURL=getWalletOptionsCatalogue.d.ts.map

package/dist/modules/walletOptionsCatalogue/getWalletOptionsCatalogue/getWalletOptionsCatalogue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getWalletOptionsCatalogue.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/getWalletOptionsCatalogue/getWalletOptionsCatalogue.ts"],"names":[],"mappings":"AAcA,OAAO,KAAK,EACV,+BAA+B,EAG/B,sBAAsB,EACvB,MAAM,iCAAiC,CAAC;AAIzC;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,yBAAyB,YAC5B,+BAA+B,wDAEtC,OAAO,CAAC,sBAAsB,CA8EhC,CAAC"}

package/dist/modules/walletOptionsCatalogue/groupOptionsByWalletOption/groupOptionsByWalletOption.d.ts

@@ -0,0 +1,49 @@
+import type { WithWalletProviderDisplayOverride } from '../buildWithWalletProviderOptions/buildWithWalletProviderOptions';
+import type { WalletConnectionOption } from '../walletOptionsCatalogue.types';
+/**
+ * A `connectionOption` tagged with the wallet option key it belongs under.
+ * Transformer outputs produce these; the catalogue groups them by
+ * `walletOptionKey` before building wallet option shells.
+ *
+ * `displayOverride` is set only by the `withWalletProvider` transformer,
+ * carrying the provider's self-announced `name` + `iconUrl`. The shell
+ * builder applies it on top of any wallet book entry — provider
+ * metadata wins over book branding.
+ */
+export type ConnectionOptionForWalletOption = {
+    displayOverride?: WithWalletProviderDisplayOverride;
+    option: WalletConnectionOption;
+    walletOptionKey: string;
+};
+/**
+ * Bucket of grouped options for a single wallet option key, plus the
+ * first-seen display override (if any). Returned by
+ * `groupOptionsByWalletOption` for the catalogue to feed into the shell
+ * builder.
+ */
+export type GroupedWalletOption = {
+    connectionOptions: WalletConnectionOption[];
+    displayOverride?: WithWalletProviderDisplayOverride;
+};
+type GroupOptionsByWalletOptionParams = {
+    options: ConnectionOptionForWalletOption[];
+};
+/**
+ * Buckets tagged connection options by their wallet option key. Preserves
+ * first-seen order so that the caller's choice of
+ * `walletOptionOrdering: 'relevance'` naturally inherits the upstream input
+ * order (wallet book order for walletConnect/inAppBrowser/installation,
+ * registry order for withWalletProvider).
+ *
+ * Carries through the first-seen `displayOverride` per wallet option
+ * key, so the shell builder can apply provider-announced metadata on
+ * top of any wallet book entry.
+ *
+ * @param params.options - The tagged options to group.
+ * @returns A map from wallet option key to its grouped option bucket,
+ *   iterable in first-seen order.
+ * @not-instrumented
+ */
+export declare const groupOptionsByWalletOption: ({ options, }: GroupOptionsByWalletOptionParams) => Map<string, GroupedWalletOption>;
+export {};
+//# sourceMappingURL=groupOptionsByWalletOption.d.ts.map

package/dist/modules/walletOptionsCatalogue/groupOptionsByWalletOption/groupOptionsByWalletOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"groupOptionsByWalletOption.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/groupOptionsByWalletOption/groupOptionsByWalletOption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iCAAiC,EAAE,MAAM,kEAAkE,CAAC;AAC1H,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAE9E;;;;;;;;;GASG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,eAAe,CAAC,EAAE,iCAAiC,CAAC;IACpD,MAAM,EAAE,sBAAsB,CAAC;IAC/B,eAAe,EAAE,MAAM,CAAC;CACzB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,mBAAmB,GAAG;IAChC,iBAAiB,EAAE,sBAAsB,EAAE,CAAC;IAC5C,eAAe,CAAC,EAAE,iCAAiC,CAAC;CACrD,CAAC;AAEF,KAAK,gCAAgC,GAAG;IACtC,OAAO,EAAE,+BAA+B,EAAE,CAAC;CAC5C,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,0BAA0B,iBAEpC,gCAAgC,KAAG,GAAG,CAAC,MAAM,EAAE,mBAAmB,CAoBpE,CAAC"}

package/dist/modules/walletOptionsCatalogue/hasAnyConnectionOption/hasAnyConnectionOption.d.ts

@@ -0,0 +1,18 @@
+import type { WalletOption } from '../walletOptionsCatalogue.types';
+type HasAnyConnectionOptionParams = {
+    walletOption: WalletOption;
+};
+/**
+ * True when the wallet option has at least one connection — i.e. the user
+ * can sign in right now. Install-only wallet options surface in the
+ * catalogue too (they carry `installationUrls`) but have an empty
+ * `connectionOptions` array; this predicate distinguishes them from
+ * actually connectable wallets in the relevance sort.
+ *
+ * @param params.walletOption - The wallet option to inspect.
+ * @returns True when `connectionOptions` is non-empty.
+ * @not-instrumented
+ */
+export declare const hasAnyConnectionOption: ({ walletOption, }: HasAnyConnectionOptionParams) => boolean;
+export {};
+//# sourceMappingURL=hasAnyConnectionOption.d.ts.map

package/dist/modules/walletOptionsCatalogue/hasAnyConnectionOption/hasAnyConnectionOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasAnyConnectionOption.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/hasAnyConnectionOption/hasAnyConnectionOption.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEpE,KAAK,4BAA4B,GAAG;IAClC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,sBAAsB,sBAEhC,4BAA4B,KAAG,OACS,CAAC"}

package/dist/modules/walletOptionsCatalogue/hasInstalledProvider/hasInstalledProvider.d.ts

@@ -0,0 +1,18 @@
+import type { WalletOption } from '../walletOptionsCatalogue.types';
+type HasInstalledProviderParams = {
+    walletOption: WalletOption;
+};
+/**
+ * True when the wallet option has a `withWalletProvider` connection — i.e.
+ * the user already has the wallet available in the page (browser extension,
+ * Wallet Standard announcement, window injection, or an SDK-backed provider
+ * one of our chain extensions registered). `connectionOptions` is
+ * pre-sorted, so a registered provider always sits at index 0 when present.
+ *
+ * @param params.walletOption - The wallet option to inspect.
+ * @returns True when an installed provider is available.
+ * @not-instrumented
+ */
+export declare const hasInstalledProvider: ({ walletOption, }: HasInstalledProviderParams) => boolean;
+export {};
+//# sourceMappingURL=hasInstalledProvider.d.ts.map

package/dist/modules/walletOptionsCatalogue/hasInstalledProvider/hasInstalledProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"hasInstalledProvider.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/hasInstalledProvider/hasInstalledProvider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAEpE,KAAK,0BAA0B,GAAG;IAChC,YAAY,EAAE,YAAY,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,eAAO,MAAM,oBAAoB,sBAE9B,0BAA0B,KAAG,OACkC,CAAC"}

package/dist/modules/walletOptionsCatalogue/normalizeWalletDisplayName/normalizeWalletDisplayName.d.ts

@@ -0,0 +1,23 @@
+/**
+ * Normalizes a wallet's self-announced `displayName` into a stable wallet
+ * option key. Used by `findWalletOptionKeyForProviderKey` as the off-book
+ * fallback — registered providers whose `walletProviderKey` does not
+ * resolve to any wallet book entry still surface in the catalogue under a
+ * key derived from the name they ship in their metadata.
+ *
+ * The normalization (lowercase + whitespace-strip) intentionally matches
+ * how the legacy wallet book composes its `wallets.<key>` keys, so a
+ * self-described provider's option will merge cleanly with its book entry
+ * if one ever lands later.
+ *
+ * Multi-chain registrations of the same wallet (e.g. Phantom announced via
+ * EIP-6963 on EVM and via Wallet Standard on Solana) collapse onto the
+ * same wallet option through this normalization, since each registration
+ * announces the same `displayName`.
+ *
+ * @param displayName - The provider's `metadata.displayName`.
+ * @returns The normalized wallet option key (lowercased, no whitespace).
+ * @not-instrumented
+ */
+export declare const normalizeWalletDisplayName: (displayName: string) => string;
+//# sourceMappingURL=normalizeWalletDisplayName.d.ts.map

package/dist/modules/walletOptionsCatalogue/normalizeWalletDisplayName/normalizeWalletDisplayName.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normalizeWalletDisplayName.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/normalizeWalletDisplayName/normalizeWalletDisplayName.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,0BAA0B,gBAAiB,MAAM,KAAG,MAClB,CAAC"}

package/dist/modules/walletOptionsCatalogue/resolveWalletBookWalletOptionKey/resolveWalletBookWalletOptionKey.d.ts

@@ -0,0 +1,22 @@
+import type { WalletSchema } from '../../legacyWalletBook/legacyWalletBook.types';
+type ResolveWalletBookWalletOptionKeyParams = {
+    wallet: WalletSchema;
+    walletKey: string;
+};
+/**
+ * Resolves which wallet option (group) a wallet book entry belongs to. Used
+ * by the catalogue's wallet-book-driven transformers (`walletConnect`,
+ * `inAppBrowser`, `installation`) to bucket their emitted options.
+ *
+ * Wallet book entries inconsistently use `group` / `chainGroup` /
+ * `walletGroup` for the same idea. The wallet key itself acts as the wallet
+ * option key when no group field is set.
+ *
+ * @param params.wallet - The wallet entry.
+ * @param params.walletKey - The wallet's key in `walletBook.wallets`.
+ * @returns The wallet option key.
+ * @not-instrumented
+ */
+export declare const resolveWalletBookWalletOptionKey: ({ wallet, walletKey, }: ResolveWalletBookWalletOptionKeyParams) => string;
+export {};
+//# sourceMappingURL=resolveWalletBookWalletOptionKey.d.ts.map

package/dist/modules/walletOptionsCatalogue/resolveWalletBookWalletOptionKey/resolveWalletBookWalletOptionKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"resolveWalletBookWalletOptionKey.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/resolveWalletBookWalletOptionKey/resolveWalletBookWalletOptionKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,+CAA+C,CAAC;AAElF,KAAK,sCAAsC,GAAG;IAC5C,MAAM,EAAE,YAAY,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,gCAAgC,2BAG1C,sCAAsC,KAAG,MAC0B,CAAC"}

package/dist/modules/walletOptionsCatalogue/sortConnectionOptions/sortConnectionOptions.d.ts

@@ -0,0 +1,20 @@
+import type { WalletConnectionOption } from '../walletOptionsCatalogue.types';
+type SortConnectionOptionsParams = {
+    options: WalletConnectionOption[];
+};
+/**
+ * Sorts a wallet option's `connectionOptions` so the most preferred option lands at
+ * index 0. Primary sort is by option-type priority
+ * (`withWalletProvider` > `walletConnect` > `inAppBrowser`);
+ * within a type, ties break alphabetically by `chain` for deterministic
+ * output across calls.
+ *
+ * Returns a new array — the input is not mutated.
+ *
+ * @param params.options - The options to sort.
+ * @returns A new array in priority order.
+ * @not-instrumented
+ */
+export declare const sortConnectionOptions: ({ options, }: SortConnectionOptionsParams) => WalletConnectionOption[];
+export {};
+//# sourceMappingURL=sortConnectionOptions.d.ts.map

package/dist/modules/walletOptionsCatalogue/sortConnectionOptions/sortConnectionOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortConnectionOptions.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/sortConnectionOptions/sortConnectionOptions.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,iCAAiC,CAAC;AAE9E,KAAK,2BAA2B,GAAG;IACjC,OAAO,EAAE,sBAAsB,EAAE,CAAC;CACnC,CAAC;AAEF;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,qBAAqB,iBAE/B,2BAA2B,KAAG,sBAAsB,EAWnD,CAAC"}

package/dist/modules/walletOptionsCatalogue/sortWalletOptions/sortWalletOptions.d.ts

@@ -0,0 +1,34 @@
+import type { WalletOption, WalletOptionOrdering } from '../walletOptionsCatalogue.types';
+type SortWalletOptionsParams = {
+    ordering: WalletOptionOrdering;
+    walletOptions: WalletOption[];
+};
+/**
+ * Sorts the outer wallet-option list. This is the only ordering controlled
+ * by the customer; the inner `connectionOptions` array of each wallet
+ * option is ordered separately by `sortConnectionOptions` using a fixed
+ * option-type priority.
+ *
+ * - `'relevance'` (default): bucket wallet options into three tiers, in
+ *   this order:
+ *     1. **Installed provider** — user already has the wallet available
+ *        (`withWalletProvider` at index 0).
+ *     2. **Connectable** — has at least one connection (`walletConnect`
+ *        or `inAppBrowser`) but no installed provider.
+ *     3. **Install-only** — no connection at all; only `installationUrls`.
+ *   Within each tier, rank by the hand-curated {@link PRIORITY_WALLET_KEYS}
+ *   list (MetaMask, Coinbase, Phantom, …); unknown wallets fall through to
+ *   alphabetical-by-name order at the tail of their tier.
+ * - `'alphabetical'`: case-insensitive sort by wallet option `name`,
+ *   without bucketing.
+ *
+ * Returns a new array — the input is not mutated.
+ *
+ * @param params.walletOptions - The wallet options to sort.
+ * @param params.ordering - The requested ordering.
+ * @returns A new array in the requested order.
+ * @not-instrumented
+ */
+export declare const sortWalletOptions: ({ walletOptions, ordering, }: SortWalletOptionsParams) => WalletOption[];
+export {};
+//# sourceMappingURL=sortWalletOptions.d.ts.map

package/dist/modules/walletOptionsCatalogue/sortWalletOptions/sortWalletOptions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sortWalletOptions.d.ts","sourceRoot":"","sources":["../../../../src/modules/walletOptionsCatalogue/sortWalletOptions/sortWalletOptions.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EACV,YAAY,EACZ,oBAAoB,EACrB,MAAM,iCAAiC,CAAC;AAEzC,KAAK,uBAAuB,GAAG;IAC7B,QAAQ,EAAE,oBAAoB,CAAC;IAC/B,aAAa,EAAE,YAAY,EAAE,CAAC;CAC/B,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,iBAAiB,iCAG3B,uBAAuB,KAAG,YAAY,EA0BxC,CAAC"}

package/dist/modules/walletOptionsCatalogue/walletOptionsCatalogue.types.d.ts

@@ -0,0 +1,164 @@
+import type { Chain } from '../chain';
+/**
+ * Identifies where a registered wallet provider came from. Used as the
+ * `source` discriminator on `WithWalletProviderConnectionOption` so customer
+ * UIs can label "browser extension" vs "wallet SDK" without having to inspect
+ * the registered provider's metadata.
+ *
+ * - `selfAnnounced`: announced via an in-page self-announcement standard
+ *   (EIP-6963 on EVM, Wallet Standard on Solana / Sui / …).
+ * - `windowInjected`: legacy `window.*` injection (e.g. `window.ethereum`).
+ * - `sdk`: registered by a chain extension that wraps a vendor SDK
+ *   (Base Account via `@base-org/account`, MetaMask Connect, etc.).
+ */
+export type WithWalletProviderSource = 'selfAnnounced' | 'windowInjected' | 'sdk';
+/**
+ * A wallet that the customer can connect to directly through a registered
+ * wallet provider. The customer resolves the live provider via
+ * `getWalletProviderByKey({ key: walletProviderKey })`, then calls
+ * `.connect()` / `.signMessage()` / etc. on it.
+ *
+ * `walletProviderKey` follows the standard format produced by
+ * `formatWalletProviderKey`:
+ * `<normalizedWalletNameWithChain>:<walletProviderType>[:<suffix>]`.
+ */
+export type WithWalletProviderConnectionOption = {
+    chain: Chain;
+    source: WithWalletProviderSource;
+    type: 'withWalletProvider';
+    walletProviderKey: string;
+};
+/**
+ * A WalletConnect-capable wallet. Carries deeplinks only; the customer drives
+ * the WC pairing flow themselves by calling the chain-level
+ * `connectWithWalletConnect<Chain>` function, then appending the resulting WC
+ * URI onto one of the deeplinks via `appendWalletConnectUriToDeepLink`.
+ *
+ * The `WalletConnectWalletProvider` is only created after session approval,
+ * so there is no provider key to attach to the option at catalogue-build time.
+ */
+export type WalletConnectConnectionOption = {
+    chain: Chain;
+    deeplinks: {
+        /** Native deeplink scheme (e.g. `metamask://`). */
+        native?: string;
+        /** Universal link (e.g. `https://metamask.app.link`). */
+        universal?: string;
+    };
+    type: 'walletConnect';
+};
+/**
+ * A mobile wallet that exposes an in-app browser entry URL. The URL is a
+ * template (e.g. `https://go.base.app/dapp?cb_url={{encodedDappURI}}`) — the
+ * customer substitutes `{{encodedDappURI}}` with the encoded current dapp URL
+ * before opening it.
+ */
+export type InAppBrowserConnectionOption = {
+    chain: Chain;
+    type: 'inAppBrowser';
+    url: string;
+};
+/**
+ * Install / download links for a wallet option whose product can be
+ * installed by the user on this device. Surfaced on `WalletOption` when
+ * `includeInstallation: true` is passed to `getWalletOptionsCatalogue`.
+ *
+ * Installation is intentionally not a `WalletConnectionOption` — the user
+ * cannot "connect" with an install link, and rendering it inline with
+ * real connection actions misleads them. Each platform's URL is optional
+ * and only present when the wallet book carries the corresponding store
+ * ID.
+ */
+export type InstallationUrls = {
+    android?: string;
+    chrome?: string;
+    edge?: string;
+    firefox?: string;
+    ios?: string;
+    native?: string;
+    opera?: string;
+    safari?: string;
+};
+/**
+ * One option for connecting to a wallet option. Each `WalletOption`
+ * carries an ordered array of these; the first element is always "the
+ * best available connection" by the priority documented on
+ * `getWalletOptionsCatalogue`.
+ */
+export type WalletConnectionOption = WithWalletProviderConnectionOption | WalletConnectConnectionOption | InAppBrowserConnectionOption;
+/**
+ * A wallet option surfaced by `getWalletOptionsCatalogue` — one wallet the
+ * user can sign in with (MetaMask, Coinbase, Phantom, …). A wallet option
+ * surfaces when it has at least one `connectionOption` OR a populated
+ * `installationUrls` bag — install-only wallets (no connection available
+ * but the user can install the product) are surfaced with empty
+ * `connectionOptions` so the customer UI can render the install links
+ * distinctly.
+ */
+export type WalletOption = {
+    /**
+     * Ordered connection options for this wallet. Sorted by option-type
+     * priority (`withWalletProvider` > `walletConnect` > `inAppBrowser`),
+     * then by chain for stability. May be empty when only
+     * `installationUrls` are available.
+     */
+    connectionOptions: WalletConnectionOption[];
+    /** Full URL to the wallet's icon. */
+    iconUrl: string;
+    /**
+     * Install / download links for this wallet. Present when
+     * `includeInstallation: true` is passed to `getWalletOptionsCatalogue`
+     * and the wallet book carries at least one store ID / desktop URL for
+     * the wallet. The customer UI should render these as install actions,
+     * distinct from `connectionOptions`.
+     */
+    installationUrls?: InstallationUrls;
+    /** Stable key from the wallet book (e.g. `"metamask"`). */
+    key: string;
+    /** Display name for the wallet. */
+    name: string;
+    /** Brand color in hex (e.g. `"#f6851b"`). */
+    primaryColor?: string;
+};
+/**
+ * Controls how wallet options are ordered in the returned catalogue.
+ *
+ * - `'relevance'` (default): Dynamic's recommended order.
+ * - `'alphabetical'`: case-insensitive by wallet option `name`.
+ */
+export type WalletOptionOrdering = 'relevance' | 'alphabetical';
+/**
+ * Parameters for `getWalletOptionsCatalogue`.
+ *
+ * Only `includeWithWalletProvider` defaults to `true`. The remaining flags
+ * are opt-in — call sites that want WalletConnect or in-app-browser options
+ * must request them explicitly.
+ */
+export type GetWalletOptionsCatalogueParams = {
+    /** Defaults to `false`. Mobile in-app browser launch URL. */
+    includeInAppBrowser?: boolean;
+    /** Defaults to `false`. Install / download links for wallets the user doesn't have yet. */
+    includeInstallation?: boolean;
+    /**
+     * Defaults to `false`. Meant to be used alongside our WalletConnect chain
+     * extensions (`addWalletConnectEvmExtension`,
+     * `addWalletConnectSolanaExtension`, …) so the WC pairing flow has
+     * something to connect to once the user picks a wallet from the catalogue.
+     */
+    includeWalletConnect?: boolean;
+    /**
+     * Defaults to `true`. Use this for users who already have the wallet
+     * available in the page — browser extensions discovered via EIP-6963,
+     * Wallet Standard, legacy window injection, or one of our SDK-backed
+     * providers (Base Account, MetaMask Connect, …).
+     */
+    includeWithWalletProvider?: boolean;
+    /** Defaults to `'relevance'`. See {@link WalletOptionOrdering}. */
+    walletOptionOrdering?: WalletOptionOrdering;
+};
+/**
+ * Return type of `getWalletOptionsCatalogue` — an ordered array of wallet
+ * options. See {@link WalletOptionOrdering} for ordering details.
+ */
+export type WalletOptionsCatalogue = WalletOption[];
+//# sourceMappingURL=walletOptionsCatalogue.types.d.ts.map

package/dist/modules/walletOptionsCatalogue/walletOptionsCatalogue.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"walletOptionsCatalogue.types.d.ts","sourceRoot":"","sources":["../../../src/modules/walletOptionsCatalogue/walletOptionsCatalogue.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;;;;;;GAWG;AACH,MAAM,MAAM,wBAAwB,GAChC,eAAe,GACf,gBAAgB,GAChB,KAAK,CAAC;AAEV;;;;;;;;;GASG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,KAAK,EAAE,KAAK,CAAC;IACb,MAAM,EAAE,wBAAwB,CAAC;IACjC,IAAI,EAAE,oBAAoB,CAAC;IAC3B,iBAAiB,EAAE,MAAM,CAAC;CAC3B,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,6BAA6B,GAAG;IAC1C,KAAK,EAAE,KAAK,CAAC;IACb,SAAS,EAAE;QACT,mDAAmD;QACnD,MAAM,CAAC,EAAE,MAAM,CAAC;QAChB,yDAAyD;QACzD,SAAS,CAAC,EAAE,MAAM,CAAC;KACpB,CAAC;IACF,IAAI,EAAE,eAAe,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,KAAK,EAAE,KAAK,CAAC;IACb,IAAI,EAAE,cAAc,CAAC;IACrB,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,sBAAsB,GAC9B,kCAAkC,GAClC,6BAA6B,GAC7B,4BAA4B,CAAC;AAEjC;;;;;;;;GAQG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB;;;;;OAKG;IACH,iBAAiB,EAAE,sBAAsB,EAAE,CAAC;IAC5C,qCAAqC;IACrC,OAAO,EAAE,MAAM,CAAC;IAChB;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IACpC,2DAA2D;IAC3D,GAAG,EAAE,MAAM,CAAC;IACZ,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,6CAA6C;IAC7C,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,oBAAoB,GAAG,WAAW,GAAG,cAAc,CAAC;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,+BAA+B,GAAG;IAC5C,6DAA6D;IAC7D,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,2FAA2F;IAC3F,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B;;;;;OAKG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAC/B;;;;;OAKG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IACpC,mEAAmE;IACnE,oBAAoB,CAAC,EAAE,oBAAoB,CAAC;CAC7C,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,sBAAsB,GAAG,YAAY,EAAE,CAAC"}

package/dist/modules/wallets/utils/stripChainSuffix/stripChainSuffix.d.ts

@@ -0,0 +1,20 @@
+import type { Chain } from '../../../chain';
+type StripChainSuffixParams = {
+    chain: Chain;
+    normalizedName: string;
+};
+/**
+ * Removes the lowercased chain suffix that `normalizeWalletNameWithChain`
+ * appends. Used by `findWalletOptionKeyForProviderKey` to recover the wallet
+ * book wallet key candidate from a `walletProviderKey`. If the suffix is
+ * not present (some chain extensions already bake the chain into the
+ * display name), the input is returned unchanged.
+ *
+ * @param params.chain - The chain whose suffix should be stripped.
+ * @param params.normalizedName - The normalized wallet-name-with-chain string.
+ * @returns The name with the chain suffix removed, or the input unchanged.
+ * @not-instrumented
+ */
+export declare const stripChainSuffix: ({ chain, normalizedName, }: StripChainSuffixParams) => string;
+export {};
+//# sourceMappingURL=stripChainSuffix.d.ts.map

package/dist/modules/wallets/utils/stripChainSuffix/stripChainSuffix.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"stripChainSuffix.d.ts","sourceRoot":"","sources":["../../../../../src/modules/wallets/utils/stripChainSuffix/stripChainSuffix.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAC;AAE5C,KAAK,sBAAsB,GAAG;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,cAAc,EAAE,MAAM,CAAC;CACxB,CAAC;AAEF;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,gBAAgB,+BAG1B,sBAAsB,KAAG,MAQ3B,CAAC"}