Skip to main content

Function Signature

Description

Verifies that the supplied password correctly decrypts the wallet’s backup. Throws if the password is wrong or the cached metadata is stale (couldn’t recover a share to verify against). If the wallet does not require a password for the current operation, the call returns silently without verifying.

Parameters

Required Parameters

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

Optional Parameters

  • password (string) - The password to verify. If the wallet is password-encrypted and no password is provided, throws "Password is required for operation but not provided".

Returns

  • Promise<void> - Resolves if the password is correct (or no password was needed). Throws otherwise.

Example

Error Handling

The error message distinguishes wrong-password from stale-metadata to help diagnose:
Last modified on May 21, 2026