@metamask/eth-ledger-bridge-keyring
Version:
A MetaMask compatible keyring, for ledger hardware wallets
76 lines • 3.03 kB
JavaScript
import { ErrorCode, Severity, Category, HardwareWalletError, LEDGER_ERROR_MAPPINGS, KEYRING_ERROR_MAPPINGS } from "@metamask/hw-wallet-sdk";
/**
* Factory function to create a HardwareWalletError from a Ledger error code.
*
* @param ledgerErrorCode - The Ledger error code (e.g., '0x6985', '0x5515')
* @param context - Optional additional context to append to the error message
* @returns A HardwareWalletError instance with mapped error details
*/
export function createLedgerError(ledgerErrorCode, context) {
const errorMapping = getLedgerErrorMapping(ledgerErrorCode);
if (errorMapping) {
const message = context
? `${errorMapping.message} (${context})`
: errorMapping.message;
return new HardwareWalletError(message, {
code: errorMapping.code,
severity: errorMapping.severity,
category: errorMapping.category,
userMessage: errorMapping.userMessage ?? message,
});
}
// Fallback for unknown error codes
const fallbackMessage = context
? `Unknown Ledger error: ${ledgerErrorCode} (${context})`
: `Unknown Ledger error: ${ledgerErrorCode}`;
return new HardwareWalletError(fallbackMessage, {
code: ErrorCode.Unknown,
severity: Severity.Err,
category: Category.Unknown,
userMessage: fallbackMessage,
});
}
/**
* Checks if a Ledger error code exists in the error mappings.
*
* @param ledgerErrorCode - The Ledger error code to check
* @returns True if the error code is mapped, false otherwise
*/
export function isKnownLedgerError(ledgerErrorCode) {
return ledgerErrorCode in LEDGER_ERROR_MAPPINGS;
}
/**
* Gets the error mapping details for a Ledger error code without creating an error instance.
*
* @param ledgerErrorCode - The Ledger error code to look up
* @returns The error mapping details or undefined if not found
*/
export function getLedgerErrorMapping(ledgerErrorCode) {
return LEDGER_ERROR_MAPPINGS[ledgerErrorCode];
}
/**
* Factory function to create a HardwareWalletError from a keyring-level error code.
*
* @param code - The keyring error code (e.g., ErrorCode.DeviceStateOnlyV4Supported)
* @returns A HardwareWalletError instance with mapped error details
*/
export function createKeyringStateError(code) {
const errorMapping = KEYRING_ERROR_MAPPINGS[code];
if (errorMapping) {
const message = `Ledger: ${errorMapping.message}`;
return new HardwareWalletError(message, {
code: errorMapping.code,
severity: errorMapping.severity,
category: errorMapping.category,
userMessage: errorMapping.userMessage ?? message,
});
}
const fallbackMessage = `Unknown Ledger keyring error: ${code}`;
return new HardwareWalletError(fallbackMessage, {
code: ErrorCode.Unknown,
severity: Severity.Err,
category: Category.Unknown,
userMessage: fallbackMessage,
});
}
//# sourceMappingURL=errors.mjs.map