Extends
Constructors
new IframeDeviceSignerKeyStorage()
new IframeDeviceSignerKeyStorage(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:50apiKey):IframeDeviceSignerKeyStorage
Parameters
Returns
IframeDeviceSignerKeyStorage
Overrides
DeviceSignerKeyStorage.constructor
Methods
deleteKey()
deleteKey(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:125 Delete the key pair associated with the given wallet address.address):Promise<void>
Parameters
Returns
Promise<void>
Overrides
DeviceSignerKeyStorage.deleteKey
destroy()
destroy(): void
Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:138
Returns
void
generateKey()
generateKey(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:80 Generate a new P-256 key pair and persist it.params):Promise<string>
Parameters
Returns
Promise<string>
The uncompressed public key encoded as a base64 string.
Overrides
DeviceSignerKeyStorage.generateKey
getDeviceName()
getDeviceName(): string
Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:356
Get a human-readable name for this device (e.g. “MacBook Pro”, “iPhone 15”).
Used to label device signers in the API for identification purposes.
Returns
string
A descriptive name for the current device.
Overrides
DeviceSignerKeyStorage.getDeviceName
getKey()
getKey(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:99 Retrieve the public key for a given wallet address.address):Promise<string|null>
Parameters
Returns
Promise<string | null>
The base64-encoded public key, or null if no key is found for the address.
Overrides
DeviceSignerKeyStorage.getKey
getSavedSignerLocator()
getSavedSignerLocator(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:347 Get the device signer locator that saveSignerLocator saved for a wallet. The default implementation always returnsaddress):Promise<string|null>
null.
Parameters
Returns
Promise<string | null>
The saved locator, or null if the storage has no locator for the wallet.
Overrides
DeviceSignerKeyStorage.getSavedSignerLocator
hasKey()
hasKey(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:108 Check if a key with the given public key exists on this device.publicKeyBase64):Promise<boolean>
Parameters
Returns
Promise<boolean>
true if the key exists on the device, false otherwise.
Overrides
DeviceSignerKeyStorage.hasKey
mapAddressToKey()
mapAddressToKey(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:91 Associate an already-generated key pair with a wallet address. Used when the wallet address is not yet known at the time of key generation.address,publicKeyBase64):Promise<void>
Parameters
Returns
Promise<void>
Overrides
DeviceSignerKeyStorage.mapAddressToKey
preload()
preload(): void
Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:130
Start loading the iframe, so the first key lookup doesn’t wait for it.
Returns
void
Overrides
DeviceSignerKeyStorage.preload
saveSignerLocator()
saveSignerLocator(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:339 Save the locator of the device signer that this device registered for a wallet. The SDK uses this locator to remove the old signer after the device loses its key. Keep the locator in storage that is separate from the key. The default implementation does not save the locator.address,signerLocator):Promise<void>
Parameters
Returns
Promise<void>
Overrides
DeviceSignerKeyStorage.saveSignerLocator
setBiometricRequestHandler()
setBiometricRequestHandler(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:72 Set a handler that is called before each WebAuthn ceremony to obtain user activation. The handler should show a UI prompt (e.g. PasskeyPrompt) and resolve when the user clicks.handler):void
Parameters
Returns
void
signMessage()
signMessage(Defined in: packages/wallets/src/utils/device-signers/IframeDeviceSignerKeyStorage.ts:117 Sign a message using the private key associated with the given wallet address.address,message):Promise<{r:string;s:string; }>
Parameters
Returns
Promise<{ r: string; s: string; }>
The ECDSA signature split into its r and s components, each as a hex string.
Overrides
DeviceSignerKeyStorage.signMessage
