@dynamic-labs-sdk/client 1.31.1 → 1.32.0

package/dist/highLevelFunctions/connectWalletOption/connectWalletOption.d.ts

@@ -0,0 +1,55 @@
+import type { ConnectWalletOptionParams } from './connectWalletOption.types';
+import type { WalletAccount } from '../../modules/wallets/walletAccount';
+/**
+ * Connects to an external wallet by its wallet options catalogue key and
+ * returns the connected wallet account.
+ *
+ * Picks the connection path for the wallet so the customer does not have to:
+ * a registered wallet provider when the user has the wallet installed,
+ * otherwise a URI pairing (WalletConnect or the MetaMask SDK), with the
+ * pairing URI handed to `onConnectionUri` while the returned promise waits for
+ * the user to approve on the wallet side.
+ *
+ * Wallets that can only be reached through their own in-app browser — no
+ * extension, no URI pairing — resolve to a redirect instead: the wallet and
+ * chain are handed to `handleWalletBrowserRedirect`, which leaves for that
+ * browser with `redirectToInAppBrowser`. Without that handler, the current
+ * page is redirected into the wallet's browser directly, so the handler is
+ * only needed to pick a different page to come back to, or where there is no
+ * page URL to reuse (React Native, server-side rendering). The returned
+ * promise never settles either way, since the connection completes on the
+ * next page load inside the wallet's browser.
+ *
+ * Note: This function does not verify the wallet account — use
+ * `verifyWalletAccount` afterwards to link it to the user.
+ *
+ * @example
+ * ```ts
+ * const walletAccount = await connectWalletOption({
+ *   handleWalletBrowserRedirect: ({ chain, walletKey }) =>
+ *     redirectToInAppBrowser({ appUrl: 'https://mydapp.xyz', chain, walletKey }),
+ *   onConnectionUri: ({ uri }) => renderQrCode(uri),
+ *   walletKey: 'metamask',
+ * });
+ * console.log(walletAccount.address);
+ * ```
+ *
+ * @param params.walletKey - The wallet to connect, keyed as in the wallet options catalogue (e.g. 'metamask', 'phantom').
+ * @param [params.chain] - The chain to connect on. Required only when the wallet resolves on more than one enabled chain.
+ * @param [params.onConnectionUri] - Called with the pairing URI when the connection runs through a URI pairing.
+ * @param [params.handleWalletBrowserRedirect] - Called with the wallet and chain when the wallet can only be connected through its own in-app browser. Defaults to redirecting the current page into that browser.
+ * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+ * @returns A promise that resolves to the connected wallet account, or that never settles on the in-app-browser path.
+ * @throws WalletOptionNotFoundError If no wallet option matches the key.
+ * @throws AmbiguousWalletChainError If the wallet resolves on more than one chain and no chain was passed.
+ * @throws NoConnectionOptionAvailableError If the wallet has no connection option this client can drive on the requested chain.
+ * @throws ConnectionUriHandlerMissingError If the wallet resolves to a URI pairing and no onConnectionUri handler was passed.
+ * @throws WalletBrowserRedirectHandlerMissingError If the wallet resolves to its in-app browser, no handleWalletBrowserRedirect handler was passed, and there is no current page URL to redirect.
+ * @throws UnsafeDeeplinkUrlError If the wallet's in-app-browser URL has a scheme that can execute script.
+ * @see verifyWalletAccount
+ * @see redirectToInAppBrowser
+ * @see getWalletOptionsCatalogue
+ * @instrumented
+ */
+export declare const connectWalletOption: ({ walletKey, chain, handleWalletBrowserRedirect, onConnectionUri, }: ConnectWalletOptionParams, client?: import("../../exports").DynamicClient) => Promise<WalletAccount>;
+//# sourceMappingURL=connectWalletOption.d.ts.map

package/dist/highLevelFunctions/connectWalletOption/connectWalletOption.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectWalletOption.d.ts","sourceRoot":"","sources":["../../../src/highLevelFunctions/connectWalletOption/connectWalletOption.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AAK7E,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,qCAAqC,CAAC;AAGzE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkDG;AACH,eAAO,MAAM,mBAAmB,wEAM3B,yBAAyB,qDAE3B,OAAO,CAAC,aAAa,CAgDvB,CAAC"}

package/dist/highLevelFunctions/connectWalletOption/connectWalletOption.types.d.ts

@@ -0,0 +1,46 @@
+import type { Chain } from '../../modules/chain';
+import type { ConnectionUriHandlerParams, WalletBrowserRedirectHandlerParams } from '../../modules/wallets/walletConnectionHandlers.types';
+/**
+ * Parameters for `connectWalletOption`.
+ *
+ * @example
+ * ```ts
+ * const params: ConnectWalletOptionParams = {
+ *   chain: 'EVM',
+ *   onConnectionUri: ({ uri }) => renderQrCode(uri),
+ *   walletKey: 'metamask',
+ * };
+ * ```
+ * @see connectWalletOption
+ * @see getWalletOptionsCatalogue
+ */
+export type ConnectWalletOptionParams = {
+    /**
+     * The chain to connect the wallet on. Required only when the wallet can be
+     * connected on more than one of this client's enabled chains.
+     */
+    chain?: Chain;
+    /**
+     * Called with the wallet and chain when the wallet can only be
+     * connected through its own in-app browser — typically a mobile browser where the
+     * wallet is neither installed as an extension nor reachable over a URI
+     * pairing. Redirect from it with `redirectToInAppBrowser`, which leaves your
+     * app, so the connection promise never settles: the wallet is injected on
+     * the next page load, inside the wallet's browser, where `connectWalletOption`
+     * connects to it directly.
+     */
+    handleWalletBrowserRedirect?: (params: WalletBrowserRedirectHandlerParams) => void;
+    /**
+     * Called with the pairing URI when the connection runs through a URI
+     * pairing (WalletConnect or the MetaMask SDK). Required for wallets that
+     * have no other connection option — typically any wallet the user has not
+     * installed on this device.
+     */
+    onConnectionUri?: (params: ConnectionUriHandlerParams) => void;
+    /**
+     * The wallet to connect, keyed as in the wallet options catalogue (e.g.
+     * `'metamask'`, `'phantom'`).
+     */
+    walletKey: string;
+};
+//# sourceMappingURL=connectWalletOption.types.d.ts.map

package/dist/highLevelFunctions/connectWalletOption/connectWalletOption.types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"connectWalletOption.types.d.ts","sourceRoot":"","sources":["../../../src/highLevelFunctions/connectWalletOption/connectWalletOption.types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,qBAAqB,CAAC;AACjD,OAAO,KAAK,EACV,0BAA0B,EAC1B,kCAAkC,EACnC,MAAM,sDAAsD,CAAC;AAE9D;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IACd;;;;;;;;OAQG;IACH,2BAA2B,CAAC,EAAE,CAC5B,MAAM,EAAE,kCAAkC,KACvC,IAAI,CAAC;IACV;;;;;OAKG;IACH,eAAe,CAAC,EAAE,CAAC,MAAM,EAAE,0BAA0B,KAAK,IAAI,CAAC;IAC/D;;;OAGG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC"}

package/dist/highLevelFunctions/connectWalletOption/index.d.ts

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

package/dist/highLevelFunctions/connectWalletOption/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/highLevelFunctions/connectWalletOption/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC"}