@dynamic-labs-sdk/client 0.13.0 → 0.14.0

package/dist/index.cjs.js

@@ -1,8 +1,8 @@
-const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-gEnLk01L.cjs.js');
-const require_InvalidParamError = require('./InvalidParamError-CH8qePiW.cjs.js');
-const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-DZMPlNXZ.cjs.js');
-const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-KnGLJETO.cjs.js');
-const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-Bb8-O3Q9.cjs.js');
+const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-z8WEapnj.cjs.js');
+const require_InvalidParamError = require('./InvalidParamError-DVzrk97b.cjs.js');
+const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-Ck7DNGPJ.cjs.js');
+const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-BINs954q.cjs.js');
+const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-IxbdRVGy.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");
@@ -911,6 +911,20 @@ const createDynamicClient = (config) => {
 	return client;
 };
 
+//#endregion
+//#region src/errors/CheckoutSessionTokenMissingError.ts
+var CheckoutSessionTokenMissingError = class extends require_InvalidParamError.BaseError {
+	constructor({ transactionId }) {
+		super({
+			cause: null,
+			code: "checkout_session_token_missing",
+			docsUrl: null,
+			name: "CheckoutSessionTokenMissingError",
+			shortMessage: `No session token found for transaction ${transactionId}. Session tokens are issued once at transaction creation and cannot be recovered.`
+		});
+	}
+};
+
 //#endregion
 //#region src/errors/FeeEstimationFailedError.ts
 var FeeEstimationFailedError = class extends require_InvalidParamError.BaseError {
@@ -1723,6 +1737,176 @@ const getMultichainBalances = async ({ balanceRequest }, client = require_Invali
 	})).chainBalances;
 };
 
+//#endregion
+//#region src/modules/checkout/utils/createCheckoutSessionTokenStorageKey/createCheckoutSessionTokenStorageKey.ts
+const createCheckoutSessionTokenStorageKey = (transactionId) => {
+	return require_getNetworkProviderFromNetworkId.createStorageKeySchema({
+		key: `checkoutSessionToken:${transactionId}`,
+		schema: zod_mini.string()
+	});
+};
+
+//#endregion
+//#region src/modules/checkout/utils/createCheckoutApiClient/createCheckoutApiClient.ts
+const createCheckoutApiClient = async ({ transactionId }, client) => {
+	const core = require_InvalidParamError.getCore(client);
+	const apiClient = require_InvalidParamError.createApiClient({}, client);
+	const sessionToken = await core.storage.getItem(createCheckoutSessionTokenStorageKey(transactionId));
+	if (!sessionToken) throw new CheckoutSessionTokenMissingError({ transactionId });
+	return {
+		apiClient,
+		environmentId: core.environmentId,
+		sessionToken
+	};
+};
+
+//#endregion
+//#region src/modules/checkout/attachCheckoutTransactionSource/attachCheckoutTransactionSource.ts
+/**
+* Attaches a wallet source to a checkout transaction
+*
+* @param params AttachCheckoutTransactionSourceParams - The source details to attach.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The updated checkout transaction
+*/
+const attachCheckoutTransactionSource = async ({ fromAddress, fromChainId, transactionId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createCheckoutApiClient({ transactionId }, client);
+	return apiClient.attachSource({
+		attachSourceRequest: {
+			fromAddress,
+			fromChainId,
+			sourceType: "wallet"
+		},
+		environmentId,
+		transactionId,
+		xDynamicCheckoutSessionToken: sessionToken
+	});
+};
+
+//#endregion
+//#region src/modules/checkout/broadcastCheckoutTransaction/broadcastCheckoutTransaction.ts
+/**
+* Records the on-chain broadcast of a checkout transaction
+*
+* @param params BroadcastCheckoutTransactionParams - The transaction ID and tx hash.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The updated checkout transaction
+*/
+const broadcastCheckoutTransaction = async ({ transactionId, txHash }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createCheckoutApiClient({ transactionId }, client);
+	return apiClient.recordCheckoutBroadcast({
+		environmentId,
+		recordBroadcastRequest: { txHash },
+		transactionId,
+		xDynamicCheckoutSessionToken: sessionToken
+	});
+};
+
+//#endregion
+//#region src/modules/checkout/cancelCheckoutTransaction/cancelCheckoutTransaction.ts
+/**
+* Cancels a checkout transaction before it has been broadcasted
+*
+* @param params CancelCheckoutTransactionParams - The transaction to cancel.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The cancelled checkout transaction
+*/
+const cancelCheckoutTransaction = async ({ transactionId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createCheckoutApiClient({ transactionId }, client);
+	const result = await apiClient.cancelCheckoutTransaction({
+		environmentId,
+		transactionId,
+		xDynamicCheckoutSessionToken: sessionToken
+	});
+	await require_InvalidParamError.getCore(client).storage.removeItem(createCheckoutSessionTokenStorageKey(transactionId));
+	return result;
+};
+
+//#endregion
+//#region src/modules/checkout/createCheckoutTransaction/createCheckoutTransaction.ts
+/**
+* Creates a new checkout transaction and stores the session token for subsequent calls
+*
+* @param params CreateCheckoutTransactionParams - The parameters for the checkout transaction.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The created transaction with session token
+*/
+const createCheckoutTransaction = async (params, client = require_InvalidParamError.getDefaultClient()) => {
+	const core = require_InvalidParamError.getCore(client);
+	const result = await require_InvalidParamError.createApiClient({}, client).createCheckoutTransaction({
+		checkoutId: params.checkoutId,
+		checkoutTransactionCreateRequest: {
+			amount: params.amount,
+			currency: params.currency,
+			expiresIn: params.expiresIn,
+			externalId: params.externalId
+		},
+		environmentId: core.environmentId
+	});
+	await core.storage.setItem(createCheckoutSessionTokenStorageKey(result.transaction.id), result.sessionToken);
+	return result;
+};
+
+//#endregion
+//#region src/modules/checkout/getCheckoutTransaction/getCheckoutTransaction.ts
+/**
+* Fetches the current state of a checkout transaction
+*
+* @param params GetCheckoutTransactionParams - The parameters for fetching the transaction.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The checkout transaction
+*/
+const getCheckoutTransaction = async ({ transactionId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const core = require_InvalidParamError.getCore(client);
+	return require_InvalidParamError.createApiClient({}, client).getCheckoutTransaction({
+		environmentId: core.environmentId,
+		transactionId
+	});
+};
+
+//#endregion
+//#region src/modules/checkout/getCheckoutTransactionQuote/getCheckoutTransactionQuote.ts
+/**
+* Fetches a quote for a checkout transaction
+*
+* @param params GetCheckoutTransactionQuoteParams - The quote parameters.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The updated checkout transaction with quote data
+*/
+const getCheckoutTransactionQuote = async ({ fromTokenAddress, slippage, toTokenAddress, transactionId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createCheckoutApiClient({ transactionId }, client);
+	return apiClient.quoteCheckoutTransaction({
+		environmentId,
+		quoteRequest: {
+			fromTokenAddress,
+			slippage,
+			toTokenAddress
+		},
+		transactionId,
+		xDynamicCheckoutSessionToken: sessionToken
+	});
+};
+
+//#endregion
+//#region src/modules/checkout/prepareCheckoutTransaction/prepareCheckoutTransaction.ts
+/**
+* Prepares a checkout transaction for signing
+* This should be called immediately before triggering the transaction signing.
+* It will confirm the quote is still valid, the risk state is cleared, and the transaction is ready to be signed.
+*
+* @param params PrepareCheckoutTransactionParams - The transaction to prepare.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns The updated checkout transaction
+*/
+const prepareCheckoutTransaction = async ({ transactionId }, client = require_InvalidParamError.getDefaultClient()) => {
+	const { apiClient, environmentId, sessionToken } = await createCheckoutApiClient({ transactionId }, client);
+	return apiClient.prepareCheckoutTransaction({
+		environmentId,
+		transactionId,
+		xDynamicCheckoutSessionToken: sessionToken
+	});
+};
+
 //#endregion
 //#region src/modules/deviceRegistration/completeDeviceRegistration/completeDeviceRegistration.ts
 const DEVICE_REGISTRATION_TOKEN_HEADER = "x-dynamic-device-registration-token";
@@ -2507,10 +2691,12 @@ const acknowledgeRecoveryCodes = async (client = require_InvalidParamError.getDe
 * one of their backup recovery codes when none of the registered MFA methods are available.
 *
 * @param params.code - The recovery code to authenticate with.
+* @param [params.createMfaTokenOptions] - @deprecated Use `requestedScopes` instead. Optional configuration for MFA token creation.
+* @param [params.requestedScopes] - Optional scopes to request an elevated access token instead of an MFA token.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
-* @returns A promise that resolves to the MFA authentication response with token.
+* @returns A promise that resolves to the MFA authentication response.
 */
-const authenticateMfaRecoveryCode = async ({ code, createMfaTokenOptions }, client = require_InvalidParamError.getDefaultClient()) => {
+const authenticateMfaRecoveryCode = async ({ code, createMfaTokenOptions, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
 	const apiClient = require_InvalidParamError.createApiClient({}, client);
 	try {
@@ -2518,7 +2704,8 @@ const authenticateMfaRecoveryCode = async ({ code, createMfaTokenOptions }, clie
 			environmentId: core.environmentId,
 			mFAAuthRecoveryDevicePostRequest: {
 				code,
-				createMfaToken: createMfaTokenOptions
+				createMfaToken: createMfaTokenOptions,
+				requestedScopes
 			}
 		});
 		require_getVerifiedCredentialForWalletAccount.updateAuthFromVerifyResponse({ response }, client);
@@ -2548,13 +2735,14 @@ const getPasskeyAuthenticationOptions = async ({ relatedOriginRpId } = {}, clien
 
 //#endregion
 //#region src/modules/auth/passkeys/serverAuthenticatePasskey/serverAuthenticatePasskey.ts
-const serverAuthenticatePasskey = async ({ authentication, createMfaToken }, client) => {
+const serverAuthenticatePasskey = async ({ authentication, createMfaToken, requestedScopes }, client) => {
 	const core = require_InvalidParamError.getCore(client);
 	return await require_InvalidParamError.createApiClient({}, client).authenticateMfaPasskeyDevice({
 		environmentId: core.environmentId,
 		passkeyAuthRequest: {
 			...authentication,
 			createMfaToken,
+			requestedScopes,
 			response: {
 				...authentication.response,
 				clientDataJson: authentication.response.clientDataJSON
@@ -2571,13 +2759,14 @@ const serverAuthenticatePasskey = async ({ authentication, createMfaToken }, cli
 * This function prompts the user to authenticate with their registered
 * passkey to complete an MFA challenge and obtain an MFA token.
 *
-* @param [params.createMfaToken] - Optional configuration for MFA token creation.
+* @param [params.createMfaToken] - @deprecated Use `requestedScopes` instead. Optional configuration for MFA token creation.
+* @param [params.requestedScopes] - Optional scopes to request an elevated access token instead of an MFA token.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the MFA authentication response.
 * @throws NoWebAuthNSupportError If WebAuthn is not supported by the browser.
 * @throws NoPasskeyCredentialsFoundError If no passkey credentials are found.
 */
-const authenticatePasskeyMFA = async ({ createMfaToken, relatedOriginRpId } = {}, client = require_InvalidParamError.getDefaultClient()) => {
+const authenticatePasskeyMFA = async ({ createMfaToken, relatedOriginRpId, requestedScopes } = {}, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
 	try {
 		if (!core.passkey.isSupported()) throw new NoWebAuthNSupportError();
@@ -2593,7 +2782,8 @@ const authenticatePasskeyMFA = async ({ createMfaToken, relatedOriginRpId } = {}
 		};
 		const response = await serverAuthenticatePasskey({
 			authentication: await core.passkey.authenticate({ optionsJSON: formattedOptions }),
-			createMfaToken
+			createMfaToken,
+			requestedScopes
 		}, client);
 		require_getVerifiedCredentialForWalletAccount.updateAuthFromVerifyResponse({ response }, client);
 		require_getVerifiedCredentialForWalletAccount.emitEvent({
@@ -2620,11 +2810,12 @@ const authenticatePasskeyMFA = async ({ createMfaToken, relatedOriginRpId } = {}
 *
 * @param params.code - The 6-digit TOTP code from the authenticator app.
 * @param [params.deviceId] - The ID of the specific TOTP device to authenticate with.
-* @param [params.createMfaTokenOptions] - Optional configuration for MFA token creation.
+* @param [params.createMfaTokenOptions] - @deprecated Use `requestedScopes` instead. Optional configuration for MFA token creation.
+* @param [params.requestedScopes] - Optional scopes to request an elevated access token instead of an MFA token.
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the MFA authentication response.
 */
-const authenticateTotpMfaDevice = async ({ deviceId, code, createMfaTokenOptions }, client = require_InvalidParamError.getDefaultClient()) => {
+const authenticateTotpMfaDevice = async ({ deviceId, code, createMfaTokenOptions, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
 	const core = require_InvalidParamError.getCore(client);
 	const apiClient = require_InvalidParamError.createApiClient({}, client);
 	try {
@@ -2633,7 +2824,8 @@ const authenticateTotpMfaDevice = async ({ deviceId, code, createMfaTokenOptions
 			mFAAuthTotpDevicePostRequest: {
 				code,
 				createMfaToken: createMfaTokenOptions,
-				id: deviceId
+				id: deviceId,
+				requestedScopes
 			}
 		});
 		require_getVerifiedCredentialForWalletAccount.updateAuthFromVerifyResponse({ response }, client);
@@ -4659,6 +4851,7 @@ const isIPad = (maxTouchPointsOverride) => {
 
 //#endregion
 exports.BaseError = require_InvalidParamError.BaseError;
+exports.CheckoutSessionTokenMissingError = CheckoutSessionTokenMissingError;
 exports.ClientAlreadyInitializedError = ClientAlreadyInitializedError;
 exports.FeeEstimationFailedError = FeeEstimationFailedError;
 exports.InvalidDeviceRegistrationRedirectError = InvalidDeviceRegistrationRedirectError;
@@ -4701,16 +4894,20 @@ exports.addCoinbaseOnrampOrderEventListener = addCoinbaseOnrampOrderEventListene
 exports.addNetwork = addNetwork;
 exports.assertWalletAccountSigningAvailability = assertWalletAccountSigningAvailability;
 exports.assertWalletProviderMethodDefined = assertWalletProviderMethodDefined;
+exports.attachCheckoutTransactionSource = attachCheckoutTransactionSource;
 exports.authenticateMfaRecoveryCode = authenticateMfaRecoveryCode;
 exports.authenticatePasskeyMFA = authenticatePasskeyMFA;
 exports.authenticateTotpMfaDevice = authenticateTotpMfaDevice;
 exports.authenticateWithSocial = authenticateWithSocial;
+exports.broadcastCheckoutTransaction = broadcastCheckoutTransaction;
 exports.canConnectWithHardwareWallet = canConnectWithHardwareWallet;
+exports.cancelCheckoutTransaction = cancelCheckoutTransaction;
 exports.completeDeviceRegistration = completeDeviceRegistration;
 exports.completeSocialAuthentication = completeSocialAuthentication;
 exports.connectAndVerifyWithWalletProvider = connectAndVerifyWithWalletProvider;
 exports.connectWithWalletProvider = connectWithWalletProvider;
 exports.consumeMfaToken = require_isMfaRequiredForAction.consumeMfaToken;
+exports.createCheckoutTransaction = createCheckoutTransaction;
 exports.createCoinbaseOnrampOrder = createCoinbaseOnrampOrder;
 exports.createCryptoDotComPayment = createCryptoDotComPayment;
 exports.createDynamicClient = createDynamicClient;
@@ -4727,6 +4924,8 @@ exports.getActiveNetworkId = getActiveNetworkId;
 exports.getAvailableWalletProvidersData = getAvailableWalletProvidersData;
 exports.getBalance = getBalance;
 exports.getBalanceForAddress = getBalanceForAddress;
+exports.getCheckoutTransaction = getCheckoutTransaction;
+exports.getCheckoutTransactionQuote = getCheckoutTransactionQuote;
 exports.getCoinbaseBuyUrl = getCoinbaseBuyUrl;
 exports.getConnectedAddresses = getConnectedAddresses;
 exports.getDefaultClient = require_InvalidParamError.getDefaultClient;
@@ -4770,6 +4969,7 @@ exports.offWalletProviderEvent = offWalletProviderEvent;
 exports.onEvent = require_getVerifiedCredentialForWalletAccount.onEvent;
 exports.onWalletProviderEvent = onWalletProviderEvent;
 exports.onceEvent = require_getVerifiedCredentialForWalletAccount.onceEvent;
+exports.prepareCheckoutTransaction = prepareCheckoutTransaction;
 exports.proveWalletAccountOwnership = proveWalletAccountOwnership;
 exports.refreshAuth = require_NotWaasWalletAccountError.refreshAuth;
 exports.refreshUser = refreshUser;