getAuthDetails
getAuthDetails
returns the details about the authenticated user, specifically all EOA addresses tied to the user's Portal vault.
This method must be called after authenticate
. Otherwise, this method will throw an error with the message Not Authenticated
.
Usage
example.ts
import { createPortalSigner } from "./portal";
const portalSigner = await createPortalSigner();
const details = await portalSigner.getAuthDetails();
Returns
Promise<PortalUserInfo>
A Promise
containing the PortalUserInfo
, an object with the following fields:
id: string
-- ID of the Portal Signer.address: string
-- EOA address of the Portal Signer.backupStatus: string | null
-- [optional] status of wallet backup.custodian: Object
-- [optional] EOA address of the Portal Signer.id: string
-- ID of the Signer's custodian.name: string
-- Name of the Signer's custodian.
signingStatus: string | null
-- [optional] status of signing.
This derives from the return type of a Portal provider's getClient()
method.