@dynamic-labs-sdk/client 0.18.0 → 0.19.0

package/dist/index.cjs.js

@@ -1,8 +1,8 @@
-const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-BXH2tfrn.cjs.js');
-const require_InvalidParamError = require('./InvalidParamError-Bxg4p9zQ.cjs.js');
-const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-CJAgL4AJ.cjs.js');
-const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-2CU35ult.cjs.js');
-const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-DnZ2ZWUB.cjs.js');
+const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-CoAKJyXQ.cjs.js');
+const require_InvalidParamError = require('./InvalidParamError-6MugNXi3.cjs.js');
+const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-Zu778J_y.cjs.js');
+const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-C204z_SH.cjs.js');
+const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-D7amEpqp.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
 /**
@@ -1559,6 +1588,65 @@ var WalletProviderMethodUnavailableError = class extends require_InvalidParamErr
 	}
 };
 
+//#endregion
+//#region src/modules/auth/checkStepUpAuth/checkStepUpAuth.ts
+const STEP_UP_REQUIRED_DEFAULT = {
+	credentials: [],
+	isRequired: true
+};
+/**
+* Checks whether step-up authentication is required for a given scope
+* and returns the available credentials to satisfy it.
+*
+* First performs a fast local check — if a valid elevated access token already
+* exists for the scope, returns `{ isRequired: false }` immediately without
+* an API call.
+*
+* Otherwise, calls the backend `stepUp/check` endpoint which evaluates
+* feature flags, SDK version, MFA settings, and action-based requirements
+* to determine if step-up is needed. The response includes the available
+* credentials and a recommended default credential.
+*
+* If the request fails for any reason, defaults to `{ isRequired: true }`
+* as a safety measure.
+*
+* @param params.scope - The scope to check (e.g., 'wallet:export').
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The step-up check result with `isRequired`, `credentials`, and `defaultCredentialId`.
+*
+* @example
+* ```typescript
+* const result = await checkStepUpAuth({ scope: TokenScope.Walletexport });
+* if (result.isRequired) {
+*   // Show step-up auth UI using result.credentials
+* }
+* ```
+* @instrumented
+*/
+const checkStepUpAuth = async ({ scope }, client = require_InvalidParamError.getDefaultClient()) => {
+	if (require_InvalidParamError.getElevatedAccessToken({
+		consume: false,
+		scope
+	}, client)) return {
+		credentials: [],
+		isRequired: false
+	};
+	try {
+		const core = require_InvalidParamError.getCore(client);
+		const response = await require_InvalidParamError.createApiClient({}, client).stepUpCheck({
+			environmentId: core.environmentId,
+			stepUpCheckRequest: { scope }
+		});
+		return {
+			credentials: response.credentials ?? [],
+			defaultCredentialId: response.defaultCredentialId,
+			isRequired: response.isRequired
+		};
+	} catch {
+		return STEP_UP_REQUIRED_DEFAULT;
+	}
+};
+
 //#endregion
 //#region src/modules/auth/externalAuth/requestExternalAuthElevatedToken/requestExternalAuthElevatedToken.ts
 /**
@@ -1959,13 +2047,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();
@@ -1984,6 +2073,7 @@ const completeSocialAuthentication = async ({ url }, client = require_InvalidPar
 		oauthRequest: {
 			code: dynamicOauthCode,
 			codeVerifier,
+			requestedScopes,
 			state: dynamicOauthState
 		},
 		providerType: provider
@@ -2337,6 +2427,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
 /**
@@ -2345,7 +2472,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.
@@ -2356,14 +2483,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
@@ -2727,30 +2847,30 @@ const getKrakenWhitelistedAddresses = async (client = require_InvalidParamError.
 };
 
 //#endregion
-//#region src/modules/instrumentation/setInstrumentationEnabled/setInstrumentationEnabled.ts
+//#region src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts
 /**
-* Enables or disables event collection for the client's instrumentation service.
+* Allows waiting until all modules of the client have been properly initialized
+* and are ready for use.
 *
-* When enabled, events are forwarded to the configured transport on every
-* instrumented function call. When disabled, instrumented functions run
-* normally but emit no telemetry.
+* @returns a promise that resolves once the client is fully initialized.
 * @instrumented
 */
-const setInstrumentationEnabled = (enabled, client = require_InvalidParamError.getDefaultClient()) => {
-	require_InvalidParamError.getCore(client).instrumentation.setEnabled(enabled);
+const waitForClientInitialized = async (client = require_InvalidParamError.getDefaultClient()) => {
+	await require_InvalidParamError.getCore(client).initTrack.waitForAll();
 };
 
 //#endregion
-//#region src/modules/initializeClient/waitForClientInitialized/waitForClientInitialized.ts
+//#region src/modules/instrumentation/setInstrumentationEnabled/setInstrumentationEnabled.ts
 /**
-* Allows waiting until all modules of the client have been properly initialized
-* and are ready for use.
+* Enables or disables event collection for the client's instrumentation service.
 *
-* @returns a promise that resolves once the client is fully initialized.
+* When enabled, events are forwarded to the configured transport on every
+* instrumented function call. When disabled, instrumented functions run
+* normally but emit no telemetry.
 * @instrumented
 */
-const waitForClientInitialized = async (client = require_InvalidParamError.getDefaultClient()) => {
-	await require_InvalidParamError.getCore(client).initTrack.waitForAll();
+const setInstrumentationEnabled = (enabled, client = require_InvalidParamError.getDefaultClient()) => {
+	require_InvalidParamError.getCore(client).instrumentation.setEnabled(enabled);
 };
 
 //#endregion
@@ -4621,6 +4741,78 @@ 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
+	};
+	const response = await apiClient.swapStatus({
+		environmentId: core.environmentId,
+		swapStatusRequest: {
+			from,
+			to,
+			txHash: params.txHash
+		}
+	});
+	return {
+		status: response.status,
+		substatus: response.substatus
+	};
+};
+
 //#endregion
 //#region src/modules/user/deleteUser/deleteUser.ts
 /**
@@ -5624,6 +5816,7 @@ exports.authenticateWithSocial = authenticateWithSocial;
 exports.broadcastCheckoutTransaction = broadcastCheckoutTransaction;
 exports.canConnectWithHardwareWallet = canConnectWithHardwareWallet;
 exports.cancelCheckoutTransaction = cancelCheckoutTransaction;
+exports.checkStepUpAuth = checkStepUpAuth;
 exports.completeDeviceRegistration = completeDeviceRegistration;
 exports.completeSocialAuthentication = completeSocialAuthentication;
 exports.connectAndVerifyWithWalletProvider = connectAndVerifyWithWalletProvider;
@@ -5640,6 +5833,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;
@@ -5666,6 +5860,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;