authenticateAccount

Login/register facade for application state: returns only a safe profile, retaining keys in the config.

Import

import { authenticateAccount } from "@0xcurvy/curvy-sdk/actions";

Usage

const result = await authenticateAccount({ action, credential, config });

Signature

function authenticateAccount(parameters: AuthenticateAccountParameters): Promise<AccountProfile>

Returns

Promise<Readonly<{ id: string; createdAt: number | null; ownerAddress: string | null; curvyHandle: CurvyId | null; capabilities: AccountCapabilities; }>>

The action resolves or returns the value shown in the signature.

Parameters

action

• Type: "login" | "register"
• Required: yes

Whether to "login" to an existing account or "register" a new one.

const result = await authenticateAccount({
  action, 
  credential,
});

credential

• Type: "signature" | "privateKeys" | "passkey"
• Required: yes

The credential kind the remaining parameters describe: "signature", "privateKeys" or "passkey".

const result = await authenticateAccount({
  action,
  credential, 
});

config

• Type: CurvyConfig
• Required: no

Curvy config to use. Defaults to the ambient config.

const result = await authenticateAccount({
  action,
  credential,
  config, 
});

Errors

Errors from config resolution and the underlying SDK operation are propagated to the caller.

Related

• Authentication guide

Source

packages/@0xcurvy/sdk/src/actions/auth/authenticateAccount.ts