createAuthManager

Functions

createAuthManager(authManagerParams)

Parameters

param.storage · LitAuthStorageProvider · required

The storage provider used by the Auth Manager.

import { createAuthManager, storagePlugins } from "@lit-protocol/auth";
const authManager = createAuthManager({
  storage: storagePlugins.localStorageNode({
    appName: "my-app",
    networkName: "naga-local",
    storagePath: "./lit-auth-local",
  }),
});

Returns

AuthManager · object

Complete AuthManager object with all returned methods.

---

createEoaAuthContext

Create an EOA (Externally Owned Account) auth context adapter for signing and session issuance.

Parameters

params · object

Hide properties

config · object · required

EOA configuration for the adapter.

Show properties

account · Account | WalletClient | Signer · required

The EOA used for auth/signing.

authConfig · AuthConfigV2 · required

Configuration for statements, resources, expiration, etc.

Show properties

statement · string

SIWE statement suffix appended to Auth message.

domain · string

Domain used in auth message.

resources · LitResourceAbilityRequest[]

Capability resources to include (e.g., [‘lit-action-execution’,’*’]).

capabilityAuthSigs · AuthSig[]

Optional capability signatures.

expiration · ISO 8601 string

Session expiration timestamp (e.g., new Date(Date.now() + 10006015).toISOString()).

litClient · LitClient · required

The Lit client instance used for network interactions.

Returns

EoaAuthContext · object

Hide properties

account · Account | WalletClient | Signer · required

The EOA used for signing.

authenticator · Authenticator · required

The authenticator used (e.g., ViemAccountAuthenticator, WalletClientAuthenticator).

authData · AuthData · required

Auth data produced by the authenticator.

authNeededCallback · () => Promise<AuthSig> · required

Callback that returns an AuthSig for session issuance when needed.

sessionKeyPair · SessionKeyPair · required

Ephemeral session key pair associated with the context.

authConfig · object · required

Show properties

expiration · ISO 8601 string · required

statement · string

domain · string

resources · LitResourceAbilityRequest[]

capabilityAuthSigs · AuthSig[]

Example

import { createAuthManager, storagePlugins } from '@lit-protocol/auth';

const authManager = createAuthManager({
  storage: storagePlugins.localStorageNode({
    appName: 'my-app',
    networkName: 'naga-local',
    storagePath: './lit-auth-local'
  })
});

const eoaAuthContext = await authManager.createEoaAuthContext({
  config: { account: myViemAccount },
  authConfig: {
    statement: 'I authorize this action.',
    domain: 'example.com',
    resources: [ ['lit-action-execution','*'], ['pkp-signing','*'] ],
    expiration: new Date(Date.now()+1000*60*15).toISOString()
  },
  litClient
});

// Use with litClient
await litClient.executeJs({ code: '...', authContext: eoaAuthContext });

---

createPkpAuthContext

Create a PKP auth context adapter using a user’s AuthData and a PKP public key.

Parameters

params · object

Hide properties

authData · AuthData · required

Authentication data (e.g., from ViemAccountAuthenticator.authenticate(account)).

pkpPublicKey · 0x-hex string · required

The PKP public key to bind the context to.

authConfig · AuthConfigV2 · required

Config controlling resources and expiration for the PKP session.

Show properties

resources · LitResourceAbilityRequest[] · required

expiration · ISO 8601 string · required

litClient · LitClient · required

cache · object

Optional cache hints.

Show properties

delegationAuthSig · boolean

Whether to cache/store a delegationAuthSig if created.

Returns

PkpAuthContext · object

Hide properties

chain · string · required

Currently ‘ethereum’.

pkpPublicKey · 0x-hex string · required

authData · AuthData · required

authNeededCallback · () => Promise<AuthSig> · required

authConfig · object · required

Show properties

expiration · ISO 8601 string · required

statement · string

domain · string

resources · LitResourceAbilityRequest[]

capabilityAuthSigs · AuthSig[]

sessionKeyPair · SessionKeyPair · required

Example

import { ViemAccountAuthenticator } from '@lit-protocol/auth';

const authData = await ViemAccountAuthenticator.authenticate(myViemAccount);
const pkpAuthContext = await authManager.createPkpAuthContext({
  authData,
  pkpPublicKey: myPkp.publicKey,
  authConfig: {
    resources: [ ['pkp-signing','*'], ['lit-action-execution','*'] ],
    expiration: new Date(Date.now()+1000*60*30).toISOString()
  },
  litClient
});

// Example: sign via PKP Viem account integration
const pkpAccount = await litClient.getPkpViemAccount({
  pkpPublicKey: myPkp.publicKey,
  authContext: pkpAuthContext,
  chainConfig: myChain
});

---

createCustomAuthContext

Create a Custom auth context that validates using a Lit Action (by inline code or IPFS CID).

Parameters

params · object

Hide properties

pkpPublicKey · 0x-hex string · required

PKP public key used in the custom auth flow.

authConfig · AuthConfigV2 · required

Config controlling resources and expiration for the session.

litClient · LitClient · required

customAuthParams · object · required

Custom Lit Action parameters.

Show properties

litActionCode · string

Inline Lit Action code (base64-encoding handled externally if needed).

litActionIpfsId · string

IPFS CID of the Lit Action to run.

jsParams · record

Arbitrary parameters exposed inside the Lit Action. Note: The implementation nests your provided object under a top-level key jsParams before sending to nodes.

Returns

CustomAuthContext · object

Hide properties

chain · string · required

Currently ‘ethereum’.

pkpPublicKey · 0x-hex string · required

customParams · object

Show properties

litActionCode · string

litActionIpfsId · string

jsParams · record

Note: Adapter nests your provided object under a top-level key ‘jsParams’ before sending to nodes.

authNeededCallback · () => Promise<AuthSig> · required

authConfig · object · required

Show properties

expiration · ISO 8601 string · required

statement · string

domain · string

resources · LitResourceAbilityRequest[]

capabilityAuthSigs · AuthSig[]

sessionKeyPair · SessionKeyPair · required

Example

const customAuthContext = await authManager.createCustomAuthContext({
  pkpPublicKey: evePkp.publicKey,
  authConfig: {
    resources: [ ['pkp-signing','*'], ['lit-action-execution','*'] ],
    expiration: new Date(Date.now()+1000*60*30).toISOString()
  },
  litClient,
  customAuthParams: {
    litActionIpfsId: 'QmYourLitActionCID',
    jsParams: { 
      userId: 'eve',
      password: 'password'
  }
});

await litClient.executeJs({ ipfsId: 'QmYourLitActionCID', authContext: customAuthContext });