Class BaseProviderAbstract

constructor

• new BaseProvider(options): BaseProvider

• Parameters

  • options: BaseProviderOptions

  Returns BaseProvider

litNodeClient

relay

Abstractauthenticate

• authenticate<T>(options?, urlCheckCallback?): Promise<AuthMethod>

• Authenticate the user based on the provider-specific implementation and return the relevant authentication data

  Type Parameters

  • T extends BaseAuthenticateOptions

    Type representing the specific options for the authenticate method

  Parameters

  • Optionaloptions: T

    Optional parameters that vary based on the provider
  • OptionalurlCheckCallback: ((currentUrl: string, redirectUri: string) => boolean)

    Optional callback to handle authentication data or errors

    • • (currentUrl, redirectUri): boolean

      • Parameters

        • currentUrl: string
        • redirectUri: string

        Returns boolean

  Returns Promise<AuthMethod>

  • Auth method object that contains authentication data

claimKeyId

• claimKeyId(claimRequest): Promise<ClaimKeyResponse>

• Authenticates an auth Method for claiming a Programmable Key Pair (PKP). Uses the underyling litNodeClient instance to authenticate a given auth method

  Parameters

  • claimRequest: ClaimRequest<ClaimProcessor>

  Returns Promise<ClaimKeyResponse>

  • Response from the network for the claim

computePublicKeyFromAuthMethod

• computePublicKeyFromAuthMethod(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

  Parameters

  • authMethod: AuthMethod

  Returns Promise<string>

fetchPKPs

• fetchPKPs(authMethod): Promise<IRelayPKP[]>

• Fetch PKPs associated with given auth method from pkp contract

  Parameters

  • authMethod: AuthMethod

    Auth method object

  Returns Promise<IRelayPKP[]>

  • Array of PKPs

fetchPKPsThroughRelayer

• fetchPKPsThroughRelayer(authMethod): Promise<IRelayPKP[]>

• Parameters

  • authMethod: AuthMethod

    Auth method object

  Returns Promise<IRelayPKP[]>

  • Array of PKPs

  Deprecated

  • Use fetchPKPs instead Fetch PKPs associated with given auth method from relay server

AbstractgetAuthMethodId

• getAuthMethodId(authMethod, options?): Promise<string>

• Get auth method id that can be used to look up and interact with PKPs associated with the given auth method

  Parameters

  • authMethod: AuthMethod

    Auth method object
  • Optionaloptions: any

    Optional parameters that vary based on the provider

  Returns Promise<string>

  • Auth method id

getPKPsForAuthMethod

• getPKPsForAuthMethod(__namedParameters): Promise<IRelayPKP[]>

• Fetch PKPs associated with given auth method type and id from pkp contract

  Parameters

  • __namedParameters: {
        authMethodId: string;
        authMethodType: AUTH_METHOD_TYPE_VALUES;
    }

    • authMethodId: string

    • authMethodType: AUTH_METHOD_TYPE_VALUES

  Returns Promise<IRelayPKP[]>

  • Array of PKPs

getSessionSigs

• getSessionSigs(params): Promise<SessionSigs>

• Generate session sigs for given auth method and PKP

  Parameters

  • params: BaseProviderSessionSigsParams

  Returns Promise<SessionSigs>

  • Session sigs

mintPKPThroughRelayer

• mintPKPThroughRelayer(authMethod, customArgs?): Promise<string>

• Mint a new PKP for the given auth method through the relay server

  Parameters

  • authMethod: AuthMethod

    Auth method object
  • OptionalcustomArgs: MintRequestBody

    Extra data to overwrite default params

  Returns Promise<string>

  • Mint transaction hash

prepareRelayRequestData

• prepareRelayRequestData(authMethod): Promise<IRelayRequestData>

• Generate request data for minting and fetching PKPs via relay server

  Parameters

  • authMethod: AuthMethod

    Auth method obejct

  Returns Promise<IRelayRequestData>

  • Relay request data