@dynamic-labs-sdk/client 1.31.1 → 1.32.0

package/dist/modules/wallets/uriConnectionStarterRegistry/events.d.ts

@@ -0,0 +1,18 @@
+import type { Chain } from '../../chain';
+import type { UriConnectionType } from '../walletProviderUriConnection.types';
+declare global {
+    interface DynamicEvents {
+        /**
+         * Event emitted every time a chain extension registers a URI connection
+         * starter, which is what makes a URI pairing drivable for that chain and
+         * protocol. Consumers derived from the registered starters refresh on it
+         * so an extension added late is picked up.
+         */
+        uriConnectionStarterRegistered: (args: {
+            chain: Chain;
+            type: UriConnectionType;
+        }) => void;
+    }
+}
+export {};
+//# sourceMappingURL=events.d.ts.map

package/dist/modules/wallets/uriConnectionStarterRegistry/events.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../../../src/modules/wallets/uriConnectionStarterRegistry/events.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,sCAAsC,CAAC;AAE9E,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,aAAa;QACrB;;;;;WAKG;QACH,8BAA8B,EAAE,CAAC,IAAI,EAAE;YACrC,KAAK,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,iBAAiB,CAAC;SACzB,KAAK,IAAI,CAAC;KACZ;CACF;AAED,OAAO,EAAE,CAAC"}

package/dist/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/getUriConnectionStarterRegistry.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Returns the client's registry of URI connection starters, one per chain and
+ * URI protocol pair, creating it on first access.
+ *
+ * Chain extensions register their starters here so higher level connection
+ * APIs can mint a pairing URI without depending on the chain packages.
+ *
+ * @example
+ * ```ts
+ * const { uri, approval } = await getUriConnectionStarterRegistry(client)
+ *   .get({ chain: 'EVM', type: 'walletConnect' })
+ *   ?.start({});
+ * ```
+ *
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns The registry of URI connection starters for the given client.
+ * @see UriConnectionStarter
+ * @see UriConnectionType
+ * @notInstrumented
+ */
+export declare const getUriConnectionStarterRegistry: (client: import("../../../../exports").DynamicClient) => import("..").UriConnectionStarterRegistry;
+//# sourceMappingURL=getUriConnectionStarterRegistry.d.ts.map

package/dist/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/getUriConnectionStarterRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getUriConnectionStarterRegistry.d.ts","sourceRoot":"","sources":["../../../../../src/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/getUriConnectionStarterRegistry.ts"],"names":[],"mappings":"AAGA;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,+BAA+B,oGAG3C,CAAC"}

package/dist/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/index.d.ts

@@ -0,0 +1,2 @@
+export { getUriConnectionStarterRegistry } from './getUriConnectionStarterRegistry';
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/modules/wallets/uriConnectionStarterRegistry/getUriConnectionStarterRegistry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC"}

package/dist/modules/wallets/uriConnectionStarterRegistry/index.d.ts

@@ -0,0 +1,3 @@
+export { getUriConnectionStarterRegistry } from './getUriConnectionStarterRegistry';
+export type { UriConnectionStarter, StartUriConnectionParams, UriConnectionStarterRegistry, } from './uriConnectionStarterRegistry.types';
+//# sourceMappingURL=index.d.ts.map

package/dist/modules/wallets/uriConnectionStarterRegistry/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/modules/wallets/uriConnectionStarterRegistry/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,+BAA+B,EAAE,MAAM,mCAAmC,CAAC;AACpF,YAAY,EACV,oBAAoB,EACpB,wBAAwB,EACxB,4BAA4B,GAC7B,MAAM,sCAAsC,CAAC"}

package/dist/modules/wallets/uriConnectionStarterRegistry/uriConnectionStarterRegistry.types.d.ts

@@ -0,0 +1,32 @@
+import type { Chain } from '../../chain';
+import type { UriConnectionType, WalletProviderUriConnectionResult } from '../walletProviderUriConnection.types';
+export type StartUriConnectionParams = {
+    /**
+     * Whether the wallet accounts created once the pairing is approved should be
+     * added to the client's wallet accounts. Defaults to `true`.
+     */
+    addToDynamicWalletAccounts?: boolean;
+};
+/**
+ * A chain extension's entry point for starting a URI pairing on one chain with
+ * one URI protocol — `start` mints the pairing URI and hands back the
+ * approval promise.
+ *
+ * Registering these keeps the chain-specific pairing primitives
+ * (`connectWithWalletConnectEvm`, `connectWithMetaMaskUriSolana`, …) reachable
+ * from the client package, which has no dependency on the chain packages.
+ */
+export type UriConnectionStarter = {
+    chain: Chain;
+    start: (params: StartUriConnectionParams) => Promise<WalletProviderUriConnectionResult>;
+    type: UriConnectionType;
+};
+export type UriConnectionStarterRegistry = {
+    get: (args: {
+        chain: Chain;
+        type: UriConnectionType;
+    }) => UriConnectionStarter | undefined;
+    getAll: () => UriConnectionStarter[];
+    register: (args: UriConnectionStarter) => void;
+};
+//# sourceMappingURL=uriConnectionStarterRegistry.types.d.ts.map

package/dist/modules/wallets/uriConnectionStarterRegistry/uriConnectionStarterRegistry.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uriConnectionStarterRegistry.types.d.ts","sourceRoot":"","sources":["../../../../src/modules/wallets/uriConnectionStarterRegistry/uriConnectionStarterRegistry.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EACV,iBAAiB,EACjB,iCAAiC,EAClC,MAAM,sCAAsC,CAAC;AAE9C,MAAM,MAAM,wBAAwB,GAAG;IACrC;;;OAGG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC,CAAC;AAEF;;;;;;;;GAQG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,KAAK,EAAE,KAAK,CAAC;IACb,KAAK,EAAE,CACL,MAAM,EAAE,wBAAwB,KAC7B,OAAO,CAAC,iCAAiC,CAAC,CAAC;IAChD,IAAI,EAAE,iBAAiB,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG;IACzC,GAAG,EAAE,CAAC,IAAI,EAAE;QACV,KAAK,EAAE,KAAK,CAAC;QACb,IAAI,EAAE,iBAAiB,CAAC;KACzB,KAAK,oBAAoB,GAAG,SAAS,CAAC;IACvC,MAAM,EAAE,MAAM,oBAAoB,EAAE,CAAC;IACrC,QAAQ,EAAE,CAAC,IAAI,EAAE,oBAAoB,KAAK,IAAI,CAAC;CAChD,CAAC"}

package/dist/modules/wallets/walletConnectionHandlers.types.d.ts

@@ -0,0 +1,62 @@
+import type { Chain } from '../chain';
+/**
+ * Handed to `onConnectionUri` when a connection is established through a URI
+ * pairing, so the customer can surface it to the user while the connection
+ * promise is still pending.
+ *
+ * @example
+ * ```ts
+ * const onConnectionUri = ({ uri }: ConnectionUriHandlerParams) => {
+ *   if (isMobile()) {
+ *     window.location.href = uri;
+ *     return;
+ *   }
+ *
+ *   renderQrCode(uri);
+ * };
+ * ```
+ * @see connectWalletOption
+ * @see ConnectWalletOptionParams
+ */
+export type ConnectionUriHandlerParams = {
+    /**
+     * The pairing URI to hand to the wallet, either opened as a link on mobile
+     * or rendered as a QR code for the user to scan with the wallet on another
+     * device.
+     *
+     * It is the wallet's own deeplink carrying the pairing, with the variant
+     * the current platform can open picked for you: the native scheme on
+     * mobile, the universal link on desktop, the other one as fallback. For a
+     * MetaMask SDK pairing it is the launch link MetaMask minted, which already
+     * targets the wallet. Wallets the wallet book publishes no deeplink for
+     * fall back to the bare pairing URI.
+     */
+    uri: string;
+};
+/**
+ * Handed to `handleWalletBrowserRedirect` when the wallet can only be
+ * connected through its own in-app browser, so the customer can leave for it
+ * with `redirectToInAppBrowser`.
+ *
+ * @example
+ * ```ts
+ * const handleWalletBrowserRedirect = ({
+ *   chain,
+ *   walletKey,
+ * }: WalletBrowserRedirectHandlerParams) =>
+ *   redirectToInAppBrowser({ appUrl: window.location.href, chain, walletKey });
+ * ```
+ * @see connectWalletOption
+ * @see redirectToInAppBrowser
+ */
+export type WalletBrowserRedirectHandlerParams = {
+    /** The chain the wallet's in-app browser was resolved for. */
+    chain: Chain;
+    /**
+     * The wallet to open, keyed as in the wallet options catalogue. Hand it to
+     * `redirectToInAppBrowser` along with the URL of your app for the wallet's
+     * browser to open.
+     */
+    walletKey: string;
+};
+//# sourceMappingURL=walletConnectionHandlers.types.d.ts.map

package/dist/modules/wallets/walletConnectionHandlers.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"walletConnectionHandlers.types.d.ts","sourceRoot":"","sources":["../../../src/modules/wallets/walletConnectionHandlers.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,UAAU,CAAC;AAEtC;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC;;;;;;;;;;;OAWG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC;AAEF;;;;;;;;;;;;;;;GAeG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,8DAA8D;IAC9D,KAAK,EAAE,KAAK,CAAC;IACb;;;;OAIG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/modules/wallets/walletProviderUriConnection.types.d.ts

@@ -1,4 +1,23 @@
 import type { WalletAccount } from './walletAccount';
+/**
+ * The URI protocol used to establish a pairing with a wallet application.
+ *
+ * - `'walletConnect'`: WalletConnect, minted by `connectWithWalletConnect<Chain>`.
+ * - `'metamaskSdkUri'`: MetaMask's own URI connection, minted by
+ *   `connectWithMetaMaskUri<Chain>`.
+ *
+ * @example
+ * ```ts
+ * const starter = getUriConnectionStarterRegistry(client).get({
+ *   chain: 'EVM',
+ *   type: 'walletConnect',
+ * });
+ * ```
+ *
+ * @see getUriConnectionStarterRegistry
+ * @see WalletProviderUriConnectionResult
+ */
+export type UriConnectionType = 'walletConnect' | 'metamaskSdkUri';
 /**
  * Return shape for wallet-provider connection flows that establish a
  * pairing through an external URI (rendered as a QR code or used as a

package/dist/modules/wallets/walletProviderUriConnection.types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"walletProviderUriConnection.types.d.ts","sourceRoot":"","sources":["../../../src/modules/wallets/walletProviderUriConnection.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;;OAGG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;QAAE,cAAc,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC,CAAC;IAE7D;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}
+{"version":3,"file":"walletProviderUriConnection.types.d.ts","sourceRoot":"","sources":["../../../src/modules/wallets/walletProviderUriConnection.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,iBAAiB,CAAC;AAErD;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,MAAM,iBAAiB,GAAG,eAAe,GAAG,gBAAgB,CAAC;AAEnE;;;;;;GAMG;AACH,MAAM,MAAM,iCAAiC,GAAG;IAC9C;;;OAGG;IACH,QAAQ,EAAE,MAAM,OAAO,CAAC;QAAE,cAAc,EAAE,aAAa,EAAE,CAAA;KAAE,CAAC,CAAC;IAE7D;;;OAGG;IACH,GAAG,EAAE,MAAM,CAAC;CACb,CAAC"}