Skip to Content
SdkReactHooksUseEncryptionResult

UseEncryptionResult

Defined in: src/react/useEncryption.ts:1127 

Result returned by the useEncryption hook.

Properties

clearKeyPair()

clearKeyPair: (walletAddress: string) => void

Defined in: src/react/useEncryption.ts:1137 

Clear the key pair for a wallet address from memory

Parameters

ParameterType

walletAddress

string

Returns

void


exportPublicKey()

exportPublicKey: (walletAddress: string) => Promise<string>

Defined in: src/react/useEncryption.ts:1133 

Export the public key for a wallet address as base64-encoded SPKI

Parameters

ParameterType

walletAddress

string

Returns

Promise<string>


hasKeyPair()

hasKeyPair: (walletAddress: string) => boolean

Defined in: src/react/useEncryption.ts:1135 

Check if a key pair exists in memory for a wallet address

Parameters

ParameterType

walletAddress

string

Returns

boolean


requestEncryptionKey()

requestEncryptionKey: (walletAddress: string) => Promise<void>

Defined in: src/react/useEncryption.ts:1129 

Request and generate an encryption key for a wallet address

Parameters

ParameterType

walletAddress

string

Returns

Promise<void>


requestKeyPair()

requestKeyPair: (walletAddress: string) => Promise<void>

Defined in: src/react/useEncryption.ts:1131 

Request and generate an ECDH key pair for a wallet address

Parameters

ParameterType

walletAddress

string

Returns

Promise<void>

Last updated on