getAuthDetails

The getAuthDetails method is used to get the details of the currently authenticated user. This method will also use session storage to get the user's details if they are already authenticated.

WARNING

This method throws if there is no authenticated user.

Usage

ts

import { signer } from "./signer";

const user = await signer.getAuthDetails();

signer.ts

import { AlchemySigner } from "@alchemy/aa-alchemy";

export const signer = new AlchemySigner({
  client: {
    // This is created in your dashboard under `https://dashboard.alchemy.com/settings/access-keys`
    // NOTE: it is not recommended to expose your API key on the client, instead proxy requests to your backend and set the `rpcUrl`
    // here to point to your backend.
    connection: { apiKey: "alcht_<KEY>" },
    iframeConfig: {
      // you will need to render a container with this id in your DOM
      iframeContainerId: "turnkey-iframe-container",
    },
  },
});

Returns

Promise<User> -- on success returns a User object representing the authenticated user.