Class BaseProvider`Abstract`

Hierarchy

BaseProvider

Index

Constructors

Properties

Methods

authenticate claimKeyId computePublicKeyFromAuthMethod fetchPKPsThroughRelayer getAuthMethodId getSessionSigs mintPKPThroughRelayer prepareFetchBody prepareMintBody prepareRelayRequestData

Constructors

constructor

new BaseProvider(options: BaseProviderOptions): BaseProvider
Parameters
- options: BaseProviderOptions
Returns BaseProvider
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:35

Properties

litNodeClient

litNodeClient: LitNodeClient

Client to connect to Lit nodes

relay

relay: IRelay

Relay server to subsidize minting of PKPs

Methods

`Abstract` authenticate

authenticate<T>(options?: T, urlCheckCallback?: ((currentUrl: string, redirectUri: string) => boolean)): Promise<AuthMethod>
Authenticate the user based on the provider-specific implementation and return the relevant authentication data

Returns
- Auth method object that contains authentication data
Type Parameters
- T extends BaseAuthenticateOptions
  
  Type representing the specific options for the authenticate method
Parameters
- Optional options: T
  
  Optional parameters that vary based on the provider
- Optional urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)
  
  Optional callback to handle authentication data or errors
  - - (currentUrl: string, redirectUri: string): boolean
    - Parameters
      
      currentUrl: string
      
      redirectUri: string
      
      Returns boolean
Returns Promise<AuthMethod>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:48

claimKeyId

claimKeyId(claimRequest: ClaimRequest<ClaimProcessor>): Promise<ClaimKeyResponse>
Authenticates an auth Method for claiming a Programmable Key Pair (PKP). Uses the underyling litNodeClient instance to authenticate a given auth method

Returns
- Response from the network for the claim
Parameters
- claimRequest: ClaimRequest<ClaimProcessor>
Returns Promise<ClaimKeyResponse>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:211

computePublicKeyFromAuthMethod

computePublicKeyFromAuthMethod(authMethod: AuthMethod): Promise<string>
Calculates a public key for a given key identifier which is an Auth Method Identifier the Auth Method Identifier is a hash of a user identifier and app idendtifer. These identifiers are specific to each auth method and will derive the public key protion of a pkp which will be persited when a key is claimed.

Auth Method User ID App ID

Google OAuth token sub token aud

Discord OAuth user id client app identifier

Stytch OTP token sub token aud

Returns
Parameters
- authMethod: AuthMethod
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:237

Auth Method	User ID	App ID
Google OAuth	token `sub`	token `aud`
Discord OAuth	user id	client app identifier
Stytch OTP	token `sub`	token `aud`

fetchPKPsThroughRelayer

fetchPKPsThroughRelayer(authMethod: AuthMethod): Promise<IRelayPKP[]>
Fetch PKPs associated with given auth method from relay server

Returns
- Array of PKPs
Parameters
- authMethod: AuthMethod
  
  Auth method object
Returns Promise<IRelayPKP[]>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:103

`Abstract` getAuthMethodId

getAuthMethodId(authMethod: AuthMethod, options?: any): Promise<string>
Get auth method id that can be used to look up and interact with PKPs associated with the given auth method

Returns
- Auth method id
Parameters
- authMethod: AuthMethod
  
  Auth method object
- Optional options: any
  
  Optional parameters that vary based on the provider
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:62

getSessionSigs

getSessionSigs(params: BaseProviderSessionSigsParams): Promise<SessionSigs>
Generate session sigs for given auth method and PKP

Returns
- Session sigs
Parameters
- params: BaseProviderSessionSigsParams
Returns Promise<SessionSigs>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:126

mintPKPThroughRelayer

mintPKPThroughRelayer(authMethod: AuthMethod, customArgs?: MintRequestBody): Promise<string>
Mint a new PKP for the given auth method through the relay server

Returns
- Mint transaction hash
Parameters
- authMethod: AuthMethod
  
  Auth method object
- Optional customArgs: MintRequestBody
  
  Extra data to overwrite default params
Returns Promise<string>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:75

`Protected` prepareFetchBody

prepareFetchBody(data: IRelayRequestData): string
Generate request body to fetch PKPs using auth method info via relay server

Returns
- Relay request body to fetch PKPs
Parameters
- data: IRelayRequestData
  
  Data for fetching PKP
Returns string
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:314

`Protected` prepareMintBody

prepareMintBody(data: IRelayRequestData, customArgs?: MintRequestBody): string
Generate request body for minting PKP using auth methods via relay server

Returns
- Relay request body for minting PKP
Parameters
- data: IRelayRequestData
  
  Data for minting PKP
- Optional customArgs: MintRequestBody
  
  Extra data to overwrite default params
Returns string
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:278

prepareRelayRequestData

prepareRelayRequestData(authMethod: AuthMethod): Promise<IRelayRequestData>
Generate request data for minting and fetching PKPs via relay server

Returns
- Relay request data
Parameters
- authMethod: AuthMethod
  
  Auth method obejct
Returns Promise<IRelayRequestData>
- Defined in packages/lit-auth-client/src/lib/providers/BaseProvider.ts:255

Class BaseProviderAbstract

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: BaseProviderOptions

Returns BaseProvider

Properties

litNodeClient

relay

Methods

Abstract authenticate

Returns

Type Parameters

T extends BaseAuthenticateOptions

Parameters

Optional options: T

Optional urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)

Parameters

currentUrl: string

redirectUri: string

Returns boolean

Returns Promise<AuthMethod>

claimKeyId

Returns

Parameters

claimRequest: ClaimRequest<ClaimProcessor>

Returns Promise<ClaimKeyResponse>

computePublicKeyFromAuthMethod

Returns

Parameters

authMethod: AuthMethod

Returns Promise<string>

fetchPKPsThroughRelayer

Returns

Parameters

authMethod: AuthMethod

Returns Promise<IRelayPKP[]>

Abstract getAuthMethodId

Returns

Parameters

authMethod: AuthMethod

Optional options: any

Returns Promise<string>

getSessionSigs

Returns

Parameters

params: BaseProviderSessionSigsParams

Returns Promise<SessionSigs>

mintPKPThroughRelayer

Returns

Parameters

authMethod: AuthMethod

Optional customArgs: MintRequestBody

Returns Promise<string>

Protected prepareFetchBody

Returns

Parameters

data: IRelayRequestData

Returns string

Protected prepareMintBody

Returns

Parameters

data: IRelayRequestData

Optional customArgs: MintRequestBody

Returns string

prepareRelayRequestData

Returns

Parameters

authMethod: AuthMethod

Returns Promise<IRelayRequestData>

Settings

Member Visibility

Theme

Class BaseProvider`Abstract`

`Abstract` authenticate

`Optional` options: T

`Optional` urlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)

`Abstract` getAuthMethodId

`Optional` options: any

`Optional` customArgs: MintRequestBody

`Protected` prepareFetchBody

`Protected` prepareMintBody

`Optional` customArgs: MintRequestBody