@dynamic-labs-sdk/client 0.18.1 → 0.20.0

package/dist/index.cjs.js

@@ -1,8 +1,8 @@
-const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-KrwFxKlq.cjs.js');
-const require_InvalidParamError = require('./InvalidParamError-0w8-q2f3.cjs.js');
-const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-Bffr91SM.cjs.js');
-const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-CyvI1KtC.cjs.js');
-const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-cPUOtGku.cjs.js');
+const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-Bd5KJOTp.cjs.js');
+const require_InvalidParamError = require('./InvalidParamError-C9egR24p.cjs.js');
+const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-CsJEjM3D.cjs.js');
+const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-DoCmrSvg.cjs.js');
+const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-D5Mgfi6K.cjs.js');
 let _dynamic_labs_sdk_assert_package_version = require("@dynamic-labs-sdk/assert-package-version");
 let _dynamic_labs_sdk_api_core = require("@dynamic-labs/sdk-api-core");
 let zod_mini = require("zod/mini");
@@ -175,11 +175,11 @@ const getAvailableWalletProvidersFromWalletAccounts = (client) => {
 * Disconnect and terminate each wallet provider, if available.
 * @not-instrumented
 */
-const disconnectAndTerminateWalletProviders = async (client) => {
+const disconnectAndTerminateWalletProviders = async ({ reason }, client) => {
 	const core = require_InvalidParamError.getCore(client);
 	const walletProviders = getAvailableWalletProvidersFromWalletAccounts(client);
 	await Promise.all(walletProviders.map(async (walletProvider) => {
-		if (walletProvider.terminate) await walletProvider.terminate();
+		if (walletProvider.terminate) await walletProvider.terminate({ reason });
 		if (walletProvider.disconnect) try {
 			await walletProvider.disconnect();
 		} catch (err) {
@@ -189,18 +189,17 @@ const disconnectAndTerminateWalletProviders = async (client) => {
 };
 
 //#endregion
-//#region src/modules/auth/logout/logout.ts
+//#region src/modules/auth/performLogout/performLogout.ts
 /**
-* Logs out the current user and clears all authentication data.
+* Shared logout implementation that revokes the session, clears auth state,
+* terminates wallet providers, and emits the logout event with the given reason.
 *
-* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
-* @returns A promise that resolves when the logout process is complete.
-* @instrumented
+* @not-instrumented
 */
-const logout = async (client = require_InvalidParamError.getDefaultClient()) => {
+const performLogout = async ({ reason }, client) => {
 	const core = require_InvalidParamError.getCore(client);
 	core.logger.debug("[logout] Logging out...");
-	await disconnectAndTerminateWalletProviders(client);
+	await disconnectAndTerminateWalletProviders({ reason }, client);
 	if (client.user !== null) {
 		const apiClient = require_InvalidParamError.createApiClient({}, client);
 		try {
@@ -226,11 +225,28 @@ const logout = async (client = require_InvalidParamError.getDefaultClient()) =>
 		unverifiedWalletAccounts: [],
 		user: null
 	});
-	require_getVerifiedCredentialForWalletAccount.emitEvent({ event: "logout" }, client);
+	require_getVerifiedCredentialForWalletAccount.emitEvent({
+		args: { reason },
+		event: "logout"
+	}, client);
 	fetchProjectSettings(client);
 	require_getNetworkProviderFromNetworkId.generateSessionKeys(client);
 };
 
+//#endregion
+//#region src/modules/auth/handleSessionExpiration/handleSessionExpiration.ts
+/**
+* Logs out due to session expiry with a token-expired reason,
+* allowing downstream providers to decide their own cleanup behavior.
+*
+* @param client - The Dynamic client instance.
+* @returns A promise that resolves when the logout process is complete.
+* @instrumented
+*/
+const handleSessionExpiration = async (client) => {
+	return performLogout({ reason: "token-expired" }, client);
+};
+
 //#endregion
 //#region src/modules/auth/initializeAuth/setLongTimeout/setLongTimeout.ts
 /**
@@ -271,7 +287,7 @@ const initializeAuth = (client) => {
 		const now = /* @__PURE__ */ new Date();
 		const timeUntilExpiration = expiration.getTime() - now.getTime();
 		if (timeUntilExpiration <= 0) {
-			logout(client);
+			handleSessionExpiration(client);
 			return;
 		}
 		clearExpirationTimeout = setLongTimeout(checkExpiration, timeUntilExpiration);
@@ -280,6 +296,19 @@ const initializeAuth = (client) => {
 	checkExpiration();
 };
 
+//#endregion
+//#region src/modules/auth/logout/logout.ts
+/**
+* Logs out the current user and clears all authentication data.
+*
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns A promise that resolves when the logout process is complete.
+* @instrumented
+*/
+const logout = async (client = require_InvalidParamError.getDefaultClient()) => {
+	return performLogout({ reason: "user-intent" }, client);
+};
+
 //#endregion
 //#region src/modules/crossTabEventSync/setupCrossTabEventSync/setupCrossTabEventSync.ts
 /**
@@ -1468,6 +1497,21 @@ var SimulationFailedError = class extends require_InvalidParamError.BaseError {
 	}
 };
 
+//#endregion
+//#region src/errors/TokenSwapError.ts
+var TokenSwapError = class extends require_InvalidParamError.BaseError {
+	constructor({ message, originalError }) {
+		const cause = originalError && originalError instanceof Error ? originalError : null;
+		super({
+			cause,
+			code: "token_swap_error",
+			docsUrl: null,
+			name: "TokenSwapError",
+			shortMessage: message
+		});
+	}
+};
+
 //#endregion
 //#region src/errors/UnrecognizedNetworkError.ts
 var UnrecognizedNetworkError = class extends require_InvalidParamError.BaseError {
@@ -2018,13 +2062,14 @@ const authenticateWithSocial = async ({ provider, redirectUrl }, client = requir
 * and completes the user authentication with the social provider.
 *
 * @param params.url - The callback URL containing OAuth response parameters.
+* @param [params.requestedScopes] - Optional scopes to request an elevated access token when verifying (linking) a social account.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the authenticated user or null.
 * @throws MissingSocialUrlParamError If required OAuth parameters are missing.
 * @throws InvalidRedirectStorageStateError If the stored state doesn't match.
 * @instrumented
 */
-const completeSocialAuthentication = async ({ url }, client = require_InvalidParamError.getDefaultClient()) => {
+const completeSocialAuthentication = async ({ url, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
 	const apiClient = require_InvalidParamError.createApiClient({}, client);
 	await core.initTrack.waitForAll();
@@ -2043,6 +2088,7 @@ const completeSocialAuthentication = async ({ url }, client = require_InvalidPar
 		oauthRequest: {
 			code: dynamicOauthCode,
 			codeVerifier,
+			requestedScopes,
 			state: dynamicOauthState
 		},
 		providerType: provider
@@ -2300,6 +2346,10 @@ const createCheckoutTransaction = async (params, client = require_InvalidParamEr
 		checkoutTransactionCreateRequest: {
 			amount: params.amount,
 			currency: params.currency,
+			destinationAddresses: params.destinationAddresses?.map((address) => ({
+				address: address.address,
+				chainName: address.chain
+			})),
 			expiresIn: params.expiresIn,
 			memo: params.memo
 		},
@@ -2396,6 +2446,43 @@ function assertWalletProviderMethodDefined(walletProvider, methodName) {
 	});
 }
 
+//#endregion
+//#region src/modules/swap/constants.ts
+const SWAP_SUPPORTED_CHAINS = [
+	"BTC",
+	"EVM",
+	"SOL",
+	"SUI",
+	"TRON"
+];
+
+//#endregion
+//#region src/modules/swap/executeSwapTransaction/executeSwapTransaction.ts
+/**
+* Executes a swap transaction
+*
+* @param params ExecuteSwapTransactionParams - The parameters for the swap transaction.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The transaction hash.
+* @instrumented
+*/
+const executeSwapTransaction = async ({ walletAccount, signingPayload, onStepChange }, client = require_InvalidParamError.getDefaultClient()) => {
+	if (!SWAP_SUPPORTED_CHAINS.includes(walletAccount.chain)) throw new require_InvalidParamError.InvalidParamError(`Chain ${walletAccount.chain} is not supported for swap transactions`);
+	const walletProvider = require_getVerifiedCredentialForWalletAccount.getWalletProviderFromWalletAccount({ walletAccount }, client);
+	assertWalletProviderMethodDefined(walletProvider, "executeSwapTransaction");
+	const requiredNetworkId = signingPayload.chainId;
+	if (requiredNetworkId && walletProvider.switchActiveNetwork) {
+		const { networkId: activeNetworkId } = await walletProvider.getActiveNetworkId();
+		if (activeNetworkId !== requiredNetworkId) await walletProvider.switchActiveNetwork({ networkId: requiredNetworkId });
+	}
+	const { transactionHash } = await walletProvider.executeSwapTransaction({
+		onStepChange,
+		signingPayload,
+		walletAccount
+	});
+	return { transactionHash };
+};
+
 //#endregion
 //#region src/modules/checkout/submitCheckoutTransaction/submitCheckoutTransaction.ts
 /**
@@ -2404,7 +2491,7 @@ function assertWalletProviderMethodDefined(walletProvider, methodName) {
 * Orchestrates the full submission flow:
 * 1. Calls prepareCheckoutTransaction to advance to signing state and lock the quote
 * 2. Ensures the wallet is on the correct network for the transaction
-* 3. Delegates on-chain signing to the wallet provider's executeCheckoutTransaction method
+* 3. Delegates on-chain signing to the wallet provider's executeSwapTransaction method
 * 4. Calls broadcastCheckoutTransaction with the resulting txHash
 *
 * @param params SubmitCheckoutTransactionParams - The transaction ID, wallet account, and optional step callback.
@@ -2415,14 +2502,7 @@ function assertWalletProviderMethodDefined(walletProvider, methodName) {
 const submitCheckoutTransaction = async ({ onStepChange, transactionId, walletAccount }, client = require_InvalidParamError.getDefaultClient()) => {
 	const prepared = await prepareCheckoutTransaction({ transactionId }, client);
 	require_InvalidParamError.assertDefined(prepared.signingPayload, "No signing payload returned from prepare — quote may be missing transaction data");
-	const walletProvider = require_getVerifiedCredentialForWalletAccount.getWalletProviderFromWalletAccount({ walletAccount }, client);
-	assertWalletProviderMethodDefined(walletProvider, "executeCheckoutTransaction");
-	const requiredNetworkId = prepared.signingPayload.chainId;
-	if (requiredNetworkId && walletProvider.switchActiveNetwork) {
-		const { networkId: activeNetworkId } = await walletProvider.getActiveNetworkId();
-		if (activeNetworkId !== requiredNetworkId) await walletProvider.switchActiveNetwork({ networkId: requiredNetworkId });
-	}
-	const { transactionHash } = await walletProvider.executeCheckoutTransaction({
+	const { transactionHash } = await executeSwapTransaction({
 		onStepChange,
 		signingPayload: prepared.signingPayload,
 		walletAccount
@@ -2433,6 +2513,29 @@ const submitCheckoutTransaction = async ({ onStepChange, transactionId, walletAc
 	}, client);
 };
 
+//#endregion
+//#region src/modules/checkout/utils/requiresConversion/requiresConversion.ts
+/**
+* Determines whether a token conversion (swap/bridge) is required for a checkout transaction.
+*
+* Returns `true` when the from token does not match any settlement token defined in
+* the checkout's settlement config for the given chain — meaning the asset must be
+* converted before it can settle.
+* Returns `false` when the from token already matches a settlement token, so no
+* conversion is needed.
+*
+* @param params - The from token details and the checkout's settlement config.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns Whether a token conversion is required
+* @instrumented
+*/
+const requiresConversion = async ({ transaction }, client = require_InvalidParamError.getDefaultClient()) => {
+	if (!transaction.fromChainId || !transaction.fromChainName || !transaction.fromToken) throw new require_InvalidParamError.InvalidParamError("Transaction is missing source information. Make sure that attachCheckoutTransactionSource has been called before calling this function.");
+	const checkout = (await getCheckouts(client)).find((checkout$1) => checkout$1.id === transaction.checkoutId);
+	require_InvalidParamError.assertDefined(checkout, "Could not find checkout associated with transaction.");
+	return !checkout.settlementConfig.settlements.some((settlement) => settlement.chainName === transaction.fromChainName && settlement.chainId === transaction.fromChainId && settlement.tokenAddress === transaction.fromToken);
+};
+
 //#endregion
 //#region src/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.ts
 const DEVICE_REGISTRATION_TOKEN_HEADER = "x-dynamic-device-registration-token";
@@ -4680,6 +4783,85 @@ const verifyOTP = async ({ otpVerification, verificationToken, requestedScopes }
 	return response;
 };
 
+//#endregion
+//#region src/modules/swap/getSwapQuote/getSwapQuote.ts
+/**
+* Gets a swap quote
+*
+* @param params GetSwapQuoteParams - The parameters for the swap quote.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The swap quote details. Use the `signingPayload` field to get the transaction data for the wallet to sign.
+* @instrumented
+*/
+const getSwapQuote = async (params, client = require_InvalidParamError.getDefaultClient()) => {
+	const core = require_InvalidParamError.getCore(client);
+	const apiClient = require_InvalidParamError.createApiClient({}, client);
+	if (!params.from.amount && !params.to.amount) throw new require_InvalidParamError.InvalidParamError("Either from.amount or to.amount is required");
+	if (params.from.amount && params.to.amount) throw new require_InvalidParamError.InvalidParamError("Only one of from.amount or to.amount is allowed");
+	return await apiClient.swapQuote({
+		environmentId: core.environmentId,
+		swapQuoteRequest: {
+			from: {
+				...params.from,
+				chainId: params.from.networkId,
+				chainName: params.from.chain
+			},
+			maxPriceImpact: params.maxPriceImpact,
+			order: params.order,
+			slippage: params.slippage,
+			to: {
+				...params.to,
+				chainId: params.to.networkId,
+				chainName: params.to.chain
+			}
+		}
+	});
+};
+
+//#endregion
+//#region src/modules/swap/getSwapStatus/getSwapStatus.ts
+/**
+* Gets the status of a swap
+*
+* @param params GetSwapStatusParams - The parameters for the swap status.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The swap status.
+* @instrumented
+*/
+const getSwapStatus = async (params, client = require_InvalidParamError.getDefaultClient()) => {
+	const core = require_InvalidParamError.getCore(client);
+	const apiClient = require_InvalidParamError.createApiClient({}, client);
+	let from;
+	if (params.from) from = {
+		chainId: params.from.networkId,
+		chainName: params.from.chain
+	};
+	let to;
+	if (params.to) to = {
+		chainId: params.to.networkId,
+		chainName: params.to.chain
+	};
+	try {
+		const response = await apiClient.swapStatus({
+			environmentId: core.environmentId,
+			swapStatusRequest: {
+				from,
+				to,
+				txHash: params.txHash
+			}
+		});
+		return {
+			status: response.status,
+			substatus: response.substatus
+		};
+	} catch (error) {
+		throw new TokenSwapError({
+			message: "Failed to get swap status",
+			originalError: error
+		});
+	}
+};
+
 //#endregion
 //#region src/modules/user/deleteUser/deleteUser.ts
 /**
@@ -4767,6 +4949,31 @@ const assertWalletAccountSigningAvailability = async ({ walletAccount }, client
 	});
 };
 
+//#endregion
+//#region src/modules/wallets/confirmTransaction/confirmTransaction.ts
+/**
+* Waits for a transaction to be confirmed on-chain.
+*
+* Delegates to the wallet provider's `confirmTransaction` implementation,
+* which polls the appropriate chain API until the transaction is included
+* in a block or the maximum wait time is exceeded.
+*
+* @param params.walletAccount - The wallet account that submitted the transaction.
+* @param params.transactionHash - The transaction hash to wait for.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns A promise that resolves when the transaction is confirmed.
+* @throws If the wallet provider does not support the confirmTransaction method.
+* @instrumented
+*/
+const confirmTransaction = async ({ walletAccount, transactionHash }, client = require_InvalidParamError.getDefaultClient()) => {
+	const walletProvider = require_getVerifiedCredentialForWalletAccount.getWalletProviderFromWalletAccount({ walletAccount }, client);
+	assertWalletProviderMethodDefined(walletProvider, "confirmTransaction");
+	await walletProvider.confirmTransaction({
+		transactionHash,
+		walletAccount
+	});
+};
+
 //#endregion
 //#region src/utils/isMobile/isMobile.ts
 /**
@@ -5661,6 +5868,7 @@ exports.NoWebAuthNSupportError = NoWebAuthNSupportError;
 exports.NotWaasWalletAccountError = require_NotWaasWalletAccountError.NotWaasWalletAccountError;
 exports.SandboxMaximumThresholdReachedError = require_InvalidParamError.SandboxMaximumThresholdReachedError;
 exports.SimulationFailedError = SimulationFailedError;
+exports.TokenSwapError = TokenSwapError;
 exports.UnauthorizedError = require_InvalidParamError.UnauthorizedError;
 exports.UnavailableInServerSideError = UnavailableInServerSideError;
 exports.UnrecognizedNetworkError = UnrecognizedNetworkError;
@@ -5686,6 +5894,7 @@ exports.cancelCheckoutTransaction = cancelCheckoutTransaction;
 exports.checkStepUpAuth = checkStepUpAuth;
 exports.completeDeviceRegistration = completeDeviceRegistration;
 exports.completeSocialAuthentication = completeSocialAuthentication;
+exports.confirmTransaction = confirmTransaction;
 exports.connectAndVerifyWithWalletProvider = connectAndVerifyWithWalletProvider;
 exports.connectWithWalletProvider = connectWithWalletProvider;
 exports.consumeMfaToken = require_isMfaRequiredForAction.consumeMfaToken;
@@ -5700,6 +5909,7 @@ exports.deletePasskey = deletePasskey;
 exports.deleteUser = deleteUser;
 exports.detectDeviceRegistrationRedirect = detectDeviceRegistrationRedirect;
 exports.detectOAuthRedirect = detectOAuthRedirect;
+exports.executeSwapTransaction = executeSwapTransaction;
 exports.fetchProjectSettings = fetchProjectSettings;
 exports.getActiveNetworkData = getActiveNetworkData;
 exports.getActiveNetworkId = getActiveNetworkId;
@@ -5726,6 +5936,8 @@ exports.getOwnerWalletAccountForSmartWalletAccount = getOwnerWalletAccountForSma
 exports.getPasskeys = getPasskeys;
 exports.getPrimaryWalletAccount = getPrimaryWalletAccount;
 exports.getRegisteredDevices = getRegisteredDevices;
+exports.getSwapQuote = getSwapQuote;
+exports.getSwapStatus = getSwapStatus;
 exports.getTransactionHistory = getTransactionHistory;
 exports.getUserSocialAccounts = getUserSocialAccounts;
 exports.getWalletAccountAddressByType = getWalletAccountAddressByType;
@@ -5763,6 +5975,7 @@ exports.registerPasskey = registerPasskey;
 exports.registerTotpMfaDevice = registerTotpMfaDevice;
 exports.removeWalletAccount = removeWalletAccount;
 exports.requestExternalAuthElevatedToken = requestExternalAuthElevatedToken;
+exports.requiresConversion = requiresConversion;
 exports.revokeAllRegisteredDevices = revokeAllRegisteredDevices;
 exports.revokeRegisteredDevice = revokeRegisteredDevice;
 exports.selectPrimaryWalletAccount = selectPrimaryWalletAccount;