useExportAccount

A hook used to export the private key for an account. It returns the mutation functions to kick off the export process, as well as a component to render the account recovery details in an iframe. What is returned is dependent on what you used most recently used to authenticate. If your session was initiated with a passkey, then a private key is returned. Otherwise, a seed phrase.

Import

1
import { useExportAccount } from "@account-kit/react";

Usage

import { 
function useExportAccount(args?: UseExportAccountMutationArgs): UseExportAccountResult
A hook used to export the private key for an account. It returns the mutation functions to kick off the export process, as well as a component to render the account recovery details in an iframe. What is returned is dependent on what you used most recently used to authenticate. If your session was initiated with a passkey, then a private key is returned. Otherwise, a seed phrase.
useExportAccount } from "@account-kit/react";

const {
  
const exportAccount: UseMutateFunction<boolean, Error, void, unknown>
exportAccount,
  
const isExported: boolean
isExported,
  
const isExporting: boolean
isExporting,
  
const error: Error | null
error,
  
const ExportAccountComponent: (props: ExportAccountComponentProps) => JSX.Element
ExportAccountComponent,
} = 
function useExportAccount(args?: UseExportAccountMutationArgs): UseExportAccountResult
A hook used to export the private key for an account. It returns the mutation functions to kick off the export process, as well as a component to render the account recovery details in an iframe. What is returned is dependent on what you used most recently used to authenticate. If your session was initiated with a passkey, then a private key is returned. Otherwise, a seed phrase.
useExportAccount({
  
params?: ExportWalletParams | undefined
params: {
    
iframeContainerId: string
iframeContainerId: "my-iframe-container",
  },
});

Parameters

args

UseExportAccountMutationArgs Optional arguments for the mutation and export parameters. ref

Returns

UseExportAccountResult An object containing the export state, possible error, and the export account function and component. ref*