Class LitAuthClient

Class that handles authentication through Lit login

Hierarchy

LitAuthClient

Index

Constructors

constructor

new LitAuthClient(options?: LitAuthClientOptions): LitAuthClient
Create a LitAuthClient instance
Parameters
- Optional options: LitAuthClientOptions
Returns LitAuthClient
- Defined in packages/lit-auth-client/src/lib/lit-auth-client.ts:67

Properties

`Private` debug

debug: boolean

Configures logging

litNodeClient

litNodeClient: LitNodeClient

Client to connect to Lit nodes

`Private` providers

providers: Map<string, BaseProvider>

Map of providers

relay

relay: IRelay

Relay server to subsidize minting of PKPs

rpcUrl

rpcUrl: string

The redirect URI that Lit's auth server should send the user back to

Methods

getProvider

getProvider(type: ProviderType): BaseProvider
Returns an initialized provider by type

Returns
- Provider if found, undefined otherwise
Parameters
- type: ProviderType
  
  Type of provider to get
Returns BaseProvider
- Defined in packages/lit-auth-client/src/lib/lit-auth-client.ts:247

initProvider

initProvider<T>(type: ProviderType, options?: ProviderOptions): T
Initialize a provider

Returns
- Provider
Type Parameters
- T extends BaseProvider<T>
Parameters
- type: ProviderType
  
  Type of provider to initialize
- Optional options: ProviderOptions
  
  Options for the provider
Returns T
- Defined in packages/lit-auth-client/src/lib/lit-auth-client.ts:151

mintPKPWithAuthMethods

mintPKPWithAuthMethods(authMethods: AuthMethod[], options: {
    addPkpEthAddressAsPermittedAddress?: boolean;
    pkpPermissionScopes?: number[][];
    sendPkpToitself?: boolean;
}): Promise<{
    pkpEthAddress?: string;
    pkpPublicKey?: string;
    pkpTokenId?: string;
}>
Mints a new pkp with all AuthMethods provided. Allows for permissions and flags to be set seperately. If no permissions are provided then each auth method will be assigned 1 for sign anything If no flags are provided then sendPkpToitself will be false, and addPkpEthAddressAsPermittedAddress will be true It is then up to the implementor to transfer the pkp nft to the pkp address. note When adding permissions, each permission should be added in the same order the auth methods are ordered

Throws
- Throws an error if no AuthMethods are given
Returns
pkp information
Parameters
- authMethods: AuthMethod[]
- options: {
      addPkpEthAddressAsPermittedAddress?: boolean;
      pkpPermissionScopes?: number[][];
      sendPkpToitself?: boolean;
  }
  - Optional addPkpEthAddressAsPermittedAddress?: boolean
  - Optional pkpPermissionScopes?: number[][]
  - Optional sendPkpToitself?: boolean
Returns Promise<{
    pkpEthAddress?: string;
    pkpPublicKey?: string;
    pkpTokenId?: string;
}>
- Defined in packages/lit-auth-client/src/lib/lit-auth-client.ts:305

`Static` getAuthIdByAuthMethod

getAuthIdByAuthMethod(authMethod: AuthMethod): Promise<string>
Retrieves the authentication ID based on the provided authentication method.

Returns
- The authentication ID
Parameters
- authMethod: AuthMethod
  
  The authentication method
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/lit-auth-client.ts:257

Class LitAuthClient

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: LitAuthClientOptions

Returns LitAuthClient

Properties

Private debug

litNodeClient

Private providers

relay

rpcUrl

Methods

getProvider

Returns

Parameters

type: ProviderType

Returns BaseProvider

initProvider

Returns

Type Parameters

T extends BaseProvider<T>

Parameters

type: ProviderType

Optional options: ProviderOptions

Returns T

mintPKPWithAuthMethods

Throws

Returns

Parameters

authMethods: AuthMethod[]

options: { addPkpEthAddressAsPermittedAddress?: boolean; pkpPermissionScopes?: number[][]; sendPkpToitself?: boolean; }

Optional addPkpEthAddressAsPermittedAddress?: boolean

Optional pkpPermissionScopes?: number[][]

Optional sendPkpToitself?: boolean

Returns Promise<{ pkpEthAddress?: string; pkpPublicKey?: string; pkpTokenId?: string; }>

Static getAuthIdByAuthMethod

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

Settings

Member Visibility

Theme

`Optional` options: LitAuthClientOptions

`Private` debug

`Private` providers

`Optional` options: ProviderOptions

options: {
addPkpEthAddressAsPermittedAddress?: boolean;
pkpPermissionScopes?: number[][];
sendPkpToitself?: boolean;
}

`Optional` addPkpEthAddressAsPermittedAddress?: boolean

`Optional` pkpPermissionScopes?: number[][]

`Optional` sendPkpToitself?: boolean

Returns Promise<{
pkpEthAddress?: string;
pkpPublicKey?: string;
pkpTokenId?: string;
}>

`Static` getAuthIdByAuthMethod