requiresPasswordForOperation

Checks if a wallet operation requires a password

Function Signature

requiresPasswordForOperation(params: {
  accountAddress: string;
  walletMetadata: WalletMetadata;
  walletOperation?: WalletOperation;
  backupInfo?: KeyShareBackupInfo;
}): Promise<boolean>

Description

Checks whether a specific wallet operation requires a password. Useful for branching UI before prompting the user for a password.

Parameters

Required Parameters

• accountAddress (string) - The wallet address (must include 0x prefix). Must match walletMetadata.accountAddress.
• walletMetadata (WalletMetadata) - The cached metadata for this wallet

Optional Parameters

• walletOperation (WalletOperation) - The wallet operation to check (defaults to REACH_THRESHOLD)
• backupInfo (KeyShareBackupInfo) - Pre-resolved backup info; if omitted the SDK reads it from walletMetadata.

Returns

• Promise<boolean> - true if password is required, false otherwise

Example

import { authenticatedEvmClient } from './client';
import { WalletOperation } from '@dynamic-labs-wallet/node';

const evmClient = await authenticatedEvmClient();
const walletMetadata = JSON.parse(await redis.get(`wallet:${accountAddress}`));

const requiresPassword = await evmClient.requiresPasswordForOperation({
  accountAddress,
  walletMetadata,
  walletOperation: WalletOperation.SIGN_MESSAGE,
});

console.log('Requires password for signing:', requiresPassword);

Available Wallet Operations

• SIGN_MESSAGE - Message signing operations
• SIGN_TRANSACTION - Transaction signing operations
• EXPORT_PRIVATE_KEY - Private key export operations

Error Handling

try {
  const requiresPassword = await evmClient.requiresPasswordForOperation({
    accountAddress,
    walletMetadata,
    walletOperation: WalletOperation.SIGN_MESSAGE,
  });
  console.log('Password requirement checked');
} catch (error) {
  console.error('Failed to check password requirement:', error);
}

Related Functions

• verifyPassword() - Verify wallet password
• signMessage() - Sign a message
• signTransaction() - Sign a transaction