This page has been updated for Wallets SDK V1. If you are using the previous version,
see the previous version docs or the V1 migration guide.
Extended by
Constructors
new DeviceSignerKeyStorage()
new DeviceSignerKeyStorage(Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:8apiKey):DeviceSignerKeyStorage
Parameters
Returns
DeviceSignerKeyStorage
Methods
deleteKey()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:66 Delete the key pair associated with the given wallet address.abstractdeleteKey(address):Promise<void>
Parameters
Returns
Promise<void>
generateKey()
Call Signature
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:17 Generate a new P-256 key pair and persist it.abstractgenerateKey(params):Promise<string>
Parameters
Returns
Promise<string>
The uncompressed public key encoded as a base64 string.
Call Signature
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:21 Generate a new P-256 key pair and persist it.abstractgenerateKey(params):Promise<string>
Parameters
Returns
Promise<string>
The uncompressed public key encoded as a base64 string.
Call Signature
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:26 Generate a new P-256 key pair and persist it.abstractgenerateKey(params):Promise<string>
Parameters
Returns
Promise<string>
The uncompressed public key encoded as a base64 string.
getDeviceName()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:73 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.abstractgetDeviceName():string
Returns
string
A descriptive name for the current device.
getKey()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:45 Retrieve the public key for a given wallet address.abstractgetKey(address):Promise<string|null>
Parameters
Returns
Promise<string | null>
The base64-encoded public key, or null if no key is found for the address.
hasKey()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:52 Check if a key with the given public key exists on this device.abstracthasKey(publicKeyBase64):Promise<boolean>
Parameters
Returns
Promise<boolean>
true if the key exists on the device, false otherwise.
mapAddressToKey()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:38 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.abstractmapAddressToKey(address,publicKeyBase64):Promise<void>
Parameters
Returns
Promise<void>
signMessage()
Defined in: packages/wallets/src/utils/device-signers/DeviceSignerKeyStorage.ts:60 Sign a message using the private key associated with the given wallet address.abstractsignMessage(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.
