@dynamic-labs-sdk/client 0.10.0 → 0.12.1

package/dist/index.cjs.js

@@ -1,8 +1,8 @@
-const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-uv3gDI3_.cjs.js');
-const require_InvalidParamError = require('./InvalidParamError-C-bDIPAn.cjs.js');
-const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-CKl95diA.cjs.js');
-const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-Dz3vNayT.cjs.js');
-const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-Yd5uZ0f5.cjs.js');
+const require_getNetworkProviderFromNetworkId = require('./getNetworkProviderFromNetworkId-BRin5Ty5.cjs.js');
+const require_InvalidParamError = require('./InvalidParamError-B83QXOQl.cjs.js');
+const require_getVerifiedCredentialForWalletAccount = require('./getVerifiedCredentialForWalletAccount-CsHHUt3-.cjs.js');
+const require_isMfaRequiredForAction = require('./isMfaRequiredForAction-BzWbWDdR.cjs.js');
+const require_NotWaasWalletAccountError = require('./NotWaasWalletAccountError-C_XzpX9u.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");
@@ -261,6 +261,7 @@ const logout = async (client = require_InvalidParamError.getDefaultClient()) =>
 	}
 	core.state.set({
 		captchaToken: null,
+		elevatedAccessTokens: [],
 		legacyToken: null,
 		mfaToken: null,
 		sessionExpiresAt: null,
@@ -375,6 +376,7 @@ const unverifiedWalletAccountSchema = zod_mini.object({
 		type: zod_mini.custom((val) => typeof val === "string")
 	}))),
 	chain: zod_mini.custom((val) => typeof val === "string"),
+	hardwareWalletVendor: zod_mini.optional(zod_mini.custom((val) => typeof val === "string")),
 	id: zod_mini.string(),
 	lastSelectedAt: zod_mini.nullable(zod_mini.date()),
 	walletProviderKey: zod_mini.string()
@@ -400,6 +402,12 @@ const sessionStorageKeySchema = require_getNetworkProviderFromNetworkId.createSt
 	key: "session",
 	schema: zod_mini.object({
 		captchaToken: zod_mini.nullable(zod_mini.string()),
+		elevatedAccessTokens: zod_mini.array(zod_mini.object({
+			expiresAt: zod_mini.number(),
+			scopes: zod_mini.array(zod_mini.string()),
+			singleUse: zod_mini.nullable(zod_mini.boolean()),
+			token: zod_mini.string()
+		})),
 		legacyToken: zod_mini.nullable(zod_mini.string()),
 		mfaToken: zod_mini.nullable(zod_mini.string()),
 		sessionExpiration: zod_mini.number(),
@@ -421,6 +429,12 @@ const hydrateStateWithStorage = async (client) => {
 		stateChanges.legacyToken = session.legacyToken;
 		stateChanges.sessionExpiresAt = new Date(session.sessionExpiration);
 		stateChanges.mfaToken = session.mfaToken;
+		stateChanges.elevatedAccessTokens = session.elevatedAccessTokens.map((token) => ({
+			expiresAt: new Date(token.expiresAt),
+			scopes: token.scopes,
+			singleUse: token.singleUse ?? false,
+			token: token.token
+		}));
 		stateChanges.captchaToken = session.captchaToken;
 		stateChanges.sessionKeys = session.sessionKeys;
 	}
@@ -443,6 +457,12 @@ const syncStateWithStorage = (client) => {
 		if (state.sessionExpiresAt === null) core.storage.removeItem(sessionStorageKeySchema);
 		else core.storage.setItem(sessionStorageKeySchema, {
 			captchaToken: state.captchaToken,
+			elevatedAccessTokens: (state.elevatedAccessTokens || []).map((token) => ({
+				expiresAt: token.expiresAt.getTime(),
+				scopes: token.scopes,
+				singleUse: token.singleUse ?? null,
+				token: token.token
+			})),
 			legacyToken: state.legacyToken,
 			mfaToken: state.mfaToken,
 			sessionExpiration: state.sessionExpiresAt.getTime(),
@@ -932,6 +952,20 @@ const createDynamicClient = (config) => {
 	return client;
 };
 
+//#endregion
+//#region src/errors/FeeEstimationFailedError.ts
+var FeeEstimationFailedError = class extends require_InvalidParamError.BaseError {
+	constructor(params) {
+		super({
+			cause: params.cause || null,
+			code: "fee_estimation_failed_error",
+			docsUrl: null,
+			name: "FeeEstimationFailedError",
+			shortMessage: params.message
+		});
+	}
+};
+
 //#endregion
 //#region src/errors/InvalidDeviceRegistrationRedirectError.ts
 var InvalidDeviceRegistrationRedirectError = class extends require_InvalidParamError.BaseError {
@@ -1116,6 +1150,20 @@ var NoWebAuthNSupportError = class extends require_InvalidParamError.BaseError {
 	}
 };
 
+//#endregion
+//#region src/errors/SimulationFailedError.ts
+var SimulationFailedError = class extends require_InvalidParamError.BaseError {
+	constructor(params) {
+		super({
+			cause: params.cause || null,
+			code: "simulation_failed_error",
+			docsUrl: null,
+			name: "SimulationFailedError",
+			shortMessage: params.message
+		});
+	}
+};
+
 //#endregion
 //#region src/errors/UnrecognizedNetworkError.ts
 var UnrecognizedNetworkError = class extends require_InvalidParamError.BaseError {
@@ -3798,13 +3846,14 @@ const verifyOTPForUserSignIn = async ({ otpVerification, verificationToken }, cl
 
 //#endregion
 //#region src/modules/otp/verifyOTP/verifyOTPForUserUpdate/verifyOTPForUserUpdate.ts
-const verifyOTPForUserUpdate = async ({ otpVerification, verificationToken }, client) => {
+const verifyOTPForUserUpdate = async ({ otpVerification, verificationToken, requestedScopes }, client) => {
 	const core = require_InvalidParamError.getCore(client);
 	const apiClient = require_InvalidParamError.createApiClient({}, client);
 	const verifyRequest = {
 		verificationToken,
 		verificationUUID: otpVerification.verificationUUID
 	};
+	if (requestedScopes) verifyRequest.requestedScopes = requestedScopes;
 	if (otpVerification.email) return apiClient.verifyEmailVerification({
 		emailVerificationVerifyRequest: verifyRequest,
 		environmentId: core.environmentId
@@ -3828,8 +3877,14 @@ const verifyOTPForUserUpdate = async ({ otpVerification, verificationToken }, cl
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the verify response object upon successful verification.
 */
-const verifyOTP = async ({ otpVerification, verificationToken }, client = require_InvalidParamError.getDefaultClient()) => {
-	const response = await (client.user ? verifyOTPForUserUpdate : verifyOTPForUserSignIn)({
+const verifyOTP = async ({ otpVerification, verificationToken, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
+	let response;
+	if (client.user) response = await verifyOTPForUserUpdate({
+		otpVerification,
+		requestedScopes,
+		verificationToken
+	}, client);
+	else response = await verifyOTPForUserSignIn({
 		otpVerification,
 		verificationToken
 	}, client);
@@ -3837,34 +3892,6 @@ const verifyOTP = async ({ otpVerification, verificationToken }, client = requir
 	return response;
 };
 
-//#endregion
-//#region src/errors/FeeEstimationFailedError.ts
-var FeeEstimationFailedError = class extends require_InvalidParamError.BaseError {
-	constructor(params) {
-		super({
-			cause: params.cause || null,
-			code: "fee_estimation_failed_error",
-			docsUrl: null,
-			name: "FeeEstimationFailedError",
-			shortMessage: params.message
-		});
-	}
-};
-
-//#endregion
-//#region src/errors/SimulationFailedError.ts
-var SimulationFailedError = class extends require_InvalidParamError.BaseError {
-	constructor(params) {
-		super({
-			cause: params.cause || null,
-			code: "simulation_failed_error",
-			docsUrl: null,
-			name: "SimulationFailedError",
-			shortMessage: params.message
-		});
-	}
-};
-
 //#endregion
 //#region src/modules/user/deleteUser/deleteUser.ts
 /**
@@ -3991,11 +4018,12 @@ const getAddressesWithTypesFromConnectionResult = (connectionResult) => {
 *
 * @param params.walletProviderKey - The unique key identifying the wallet provider to connect to (e.g. 'metamaskevm', 'phantomsol').
 * @param [params.addToDynamicWalletAccounts] - Whether to add the connected wallet account to the user's wallet accounts. Defaults to true.
+* @param [params.hardwareWalletVendor] - The hardware wallet vendor, if connecting via a hardware wallet (e.g. 'ledger').
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the connected wallet account.
 * @throws NoAddressFoundError If the request to connect was successful but no address is connected to your app.
 */
-const connectWithWalletProvider = async ({ walletProviderKey, addToDynamicWalletAccounts = true }, client = require_InvalidParamError.getDefaultClient()) => {
+const connectWithWalletProvider = async ({ walletProviderKey, addToDynamicWalletAccounts = true, hardwareWalletVendor }, client = require_InvalidParamError.getDefaultClient()) => {
 	const walletProvider = require_getVerifiedCredentialForWalletAccount.getWalletProviderByKey({ walletProviderKey }, client);
 	assertWalletProviderMethodDefined(walletProvider, "connect");
 	const { addresses } = await walletProvider.connect();
@@ -4011,6 +4039,7 @@ const connectWithWalletProvider = async ({ walletProviderKey, addToDynamicWallet
 		address: mainAddress,
 		addressesWithTypes: getAddressesWithTypesFromConnectionResult({ addresses }),
 		chain: walletProvider.chain,
+		hardwareWalletVendor,
 		id: require_getVerifiedCredentialForWalletAccount.formatWalletAccountId({
 			address: mainAddress,
 			chain: walletProvider.chain,
@@ -4029,6 +4058,17 @@ const connectWithWalletProvider = async ({ walletProviderKey, addToDynamicWallet
 	return walletAccount;
 };
 
+//#endregion
+//#region src/modules/wallets/hardwareWallet/formatSignatureForHardwareWallet/formatSignatureForHardwareWallet.ts
+/**
+* Wraps a raw signature in the JSON format expected by the backend for hardware wallet verification.
+*
+* @param params.hardwareWalletVendor - The hardware wallet vendor that produced the signature.
+* @param params.signature - The raw signature string to wrap.
+* @returns The signature wrapped in `{ signedTransaction: { data } }` JSON format.
+*/
+const formatSignatureForHardwareWallet = ({ signature, hardwareWalletVendor: _ }) => JSON.stringify({ signedTransaction: { data: signature } });
+
 //#endregion
 //#region src/modules/wallets/utils/getChainIdForAccountVerification/getChainIdForAccountVerification.ts
 const getChainIdForAccountVerification = async ({ walletProvider }) => {
@@ -4110,10 +4150,14 @@ const isSameAddress = (left, right, chain) => require_getVerifiedCredentialForWa
 
 //#endregion
 //#region src/modules/wallets/verifyWalletAccountForSignInOrTransfer/verifyWalletAccountForSignInOrTransfer.ts
-const verifyWalletAccountForSignInOrTransfer = async ({ walletAccount, isTransfer }, client) => {
+const verifyWalletAccountForSignInOrTransfer = async ({ walletAccount, isTransfer, requestedScopes }, client) => {
 	if (walletAccount.verifiedCredentialId) throw new WalletAccountAlreadyVerifiedError(walletAccount.address);
 	const walletProvider = require_getVerifiedCredentialForWalletAccount.getWalletProviderFromWalletAccount({ walletAccount }, client);
 	const { messageToSign, signature } = await proveWalletAccountOwnership({ walletAccount }, client);
+	const formattedSignature = walletAccount.hardwareWalletVendor ? formatSignatureForHardwareWallet({
+		hardwareWalletVendor: walletAccount.hardwareWalletVendor,
+		signature
+	}) : signature;
 	const { networkId } = await walletProvider.getActiveNetworkId();
 	const response = await require_getNetworkProviderFromNetworkId.verifyMessageSignatureOwnership({
 		addressesWithTypes: walletAccount.addressesWithTypes,
@@ -4121,7 +4165,8 @@ const verifyWalletAccountForSignInOrTransfer = async ({ walletAccount, isTransfe
 		isTransfer,
 		messageToSign,
 		networkId,
-		signature,
+		requestedScopes,
+		signature: formattedSignature,
 		walletAddress: walletAccount.address,
 		walletDisplayName: walletProvider.metadata.displayName,
 		walletProviderType: walletProvider.walletProviderType
@@ -4157,9 +4202,10 @@ const verifyWalletAccountForSignInOrTransfer = async ({ walletAccount, isTransfe
 * @throws WalletAccountAlreadyVerifiedError If the wallet is already verified.
 * @throws WalletAlreadyLinkedToAnotherUserError If the wallet is linked to another user.
 */
-const verifyWalletAccount = async ({ walletAccount }, client = require_InvalidParamError.getDefaultClient()) => {
+const verifyWalletAccount = async ({ walletAccount, requestedScopes }, client = require_InvalidParamError.getDefaultClient()) => {
 	return verifyWalletAccountForSignInOrTransfer({
 		isTransfer: false,
+		requestedScopes,
 		walletAccount
 	}, client);
 };
@@ -4174,12 +4220,14 @@ const verifyWalletAccount = async ({ walletAccount }, client = require_InvalidPa
 * the wallet account is added to their profile.
 *
 * @param params.walletProviderKey - The unique key identifying the wallet provider to connect to.
+* @param [params.hardwareWalletVendor] - The hardware wallet vendor, if connecting via a hardware wallet (e.g. 'ledger').
 * @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
 * @returns A promise that resolves to the connected and verified wallet account.
 */
-const connectAndVerifyWithWalletProvider = async ({ walletProviderKey }, client = require_InvalidParamError.getDefaultClient()) => {
+const connectAndVerifyWithWalletProvider = async ({ walletProviderKey, hardwareWalletVendor }, client = require_InvalidParamError.getDefaultClient()) => {
 	const walletAccount = await connectWithWalletProvider({
 		addToDynamicWalletAccounts: false,
+		hardwareWalletVendor,
 		walletProviderKey
 	}, client);
 	await verifyWalletAccount({ walletAccount }, client);
@@ -4261,6 +4309,30 @@ const getWalletProviderDataByKey = ({ walletProviderKey }, client = require_Inva
 	};
 };
 
+//#endregion
+//#region src/modules/wallets/hardwareWallet/canConnectWithHardwareWallet/canConnectWithHardwareWallet.ts
+/**
+* Checks whether a wallet provider supports connecting with a specific hardware wallet vendor.
+*
+* @param params.walletProviderKey - The key of the wallet provider to check.
+* @param params.hardwareWalletVendor - The hardware wallet vendor to check for.
+* @param [client] - The Dynamic client instance. Only required when using multiple Dynamic clients.
+* @returns Whether the wallet provider supports the specified hardware wallet vendor.
+*/
+const canConnectWithHardwareWallet = ({ walletProviderKey, hardwareWalletVendor }, client = require_InvalidParamError.getDefaultClient()) => {
+	return require_getVerifiedCredentialForWalletAccount.getWalletProviderByKey({ walletProviderKey }, client).metadata.supportedHardwareWalletVendors?.includes(hardwareWalletVendor) ?? false;
+};
+
+//#endregion
+//#region src/modules/wallets/hardwareWallet/isHardwareWalletAccount/isHardwareWalletAccount.ts
+/**
+* Checks whether a wallet account was connected via a hardware wallet.
+*
+* @param params.walletAccount - The wallet account to check.
+* @returns Whether the wallet account has a hardware wallet vendor set.
+*/
+const isHardwareWalletAccount = ({ walletAccount }) => walletAccount.hardwareWalletVendor !== void 0;
+
 //#endregion
 //#region src/modules/wallets/isWalletAccountVerified/isWalletAccountVerified.ts
 /**
@@ -4676,6 +4748,7 @@ exports.authenticateMfaRecoveryCode = authenticateMfaRecoveryCode;
 exports.authenticatePasskeyMFA = authenticatePasskeyMFA;
 exports.authenticateTotpMfaDevice = authenticateTotpMfaDevice;
 exports.authenticateWithSocial = authenticateWithSocial;
+exports.canConnectWithHardwareWallet = canConnectWithHardwareWallet;
 exports.completeDeviceRegistration = completeDeviceRegistration;
 exports.completeSocialAuthentication = completeSocialAuthentication;
 exports.connectAndVerifyWithWalletProvider = connectAndVerifyWithWalletProvider;
@@ -4725,6 +4798,7 @@ exports.hasExtension = require_getNetworkProviderFromNetworkId.hasExtension;
 exports.initializeClient = initializeClient;
 exports.isCaptchaRequired = require_getNetworkProviderFromNetworkId.isCaptchaRequired;
 exports.isDeviceRegistrationRequired = isDeviceRegistrationRequired;
+exports.isHardwareWalletAccount = isHardwareWalletAccount;
 exports.isMfaRequiredForAction = require_isMfaRequiredForAction.isMfaRequiredForAction;
 exports.isMobile = isMobile;
 exports.isPendingRecoveryCodesAcknowledgment = isPendingRecoveryCodesAcknowledgment;
@@ -4753,6 +4827,7 @@ exports.setDefaultMfaDevice = setDefaultMfaDevice;
 exports.signInWithExternalJwt = signInWithExternalJwt;
 exports.signInWithPasskey = signInWithPasskey;
 exports.signMessage = signMessage;
+exports.supportedCountries = supportedCountries;
 exports.switchActiveNetwork = switchActiveNetwork;
 exports.transferWalletAccount = transferWalletAccount;
 exports.unlinkSocialAccount = unlinkSocialAccount;