Class LitCore

constructor

• new LitCore(config): LitCore

• Parameters

  • config: LitNodeClientConfig | CustomNetwork

  Returns LitCore

config

connectedNodes

hdRootPubkeys

lastBlockHashRetrieved

latestBlockhash

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

currentEpochNumber

• get currentEpochNumber(): number

• Returns number

_stopListeningForNewEpoch

• _stopListeningForNewEpoch(): void

• Returns void

_throwNodeError

• _throwNodeError(res, requestId): never

• Throw node error

  Parameters

  • res: RejectedNodePromises
  • requestId: string

  Returns never

computeHDKeyId

• computeHDKeyId(userId, appId, isForActionContext?): string

• Calculates a Key Id for claiming a pkp based on a user identifier and an app identifier. The key Identifier is an Auth Method Id which scopes the key uniquely to a specific application context. These identifiers are specific to each auth method and will derive the public key portion of a pkp which will be persisted 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
  Lit Actions	user defined	ipfs cid
  Note Lit Action claiming uses a different schema than other auth methods

  Parameters

  • userId: string

    user identifier for the Key Identifier
  • appId: string

    app identifier for the Key Identifier
  • isForActionContext: boolean = false

    should be set for true if using claiming through actions

  Returns string

  public key of pkp when claimed

computeHDPubKey

• computeHDPubKey(keyId, sigType?): Promise<string>

• Calculates an HD public key from a given keyId The curve type or signature type is assumed to be k256 unless provided

  Parameters

  • keyId: string
  • sigType: LIT_CURVE_VALUES = LIT_CURVE.EcdsaCaitSith

  Returns Promise<string>

  public key

connect

• connect(): Promise<void>

• Connect to the LIT nodes

  Returns Promise<void>

  A promise that resolves when the nodes are connected.

disconnect

• disconnect(): Promise<void>

• Stops internal listeners/polling that refresh network state and watch for epoch changes. Removes global objects created internally

  Returns Promise<void>

getFormattedAccessControlConditions

• getFormattedAccessControlConditions(params): FormattedMultipleAccs

• Get different formats of access control conditions, eg. evm, sol, unified etc.

  Parameters

  • params: SupportedJsonRequests

  Returns FormattedMultipleAccs

getHashedAccessControlConditions

• getHashedAccessControlConditions(params): Promise<ArrayBuffer>

• Get hash of access control conditions

  Parameters

  • params: MultipleAccessControlConditions

  Returns Promise<ArrayBuffer>

getLatestBlockhash

• getLatestBlockhash(): Promise<string>

• Return the latest blockhash from the nodes

  Returns Promise<string>

  latest blockhash

getLogsForRequestId

• getLogsForRequestId(id): string[]

• Parameters

  • id: string

  Returns string[]

getNodePromises

• getNodePromises(callback): Promise<any>[]

• Get and gather node promises

  Parameters

  • callback: ((url: string) => Promise<any>)
    • • (url): Promise<any>

      • Parameters

        • url: string

        Returns Promise<any>

  Returns Promise<any>[]

getRandomHexString

• getRandomHexString(size): string

• Get a random hex string for use as an attestation challenge

  Parameters

  • size: number

  Returns string

getRandomNodePromise

• getRandomNodePromise(callback): Promise<any>[]

• Parameters

  • callback: ((url: string) => Promise<any>)
    • • (url): Promise<any>

      • Parameters

        • url: string

        Returns Promise<any>

  Returns Promise<any>[]

getRequestIds

• getRequestIds(): Set<string>

• Returns Set<string>

getSessionSigByUrl

• getSessionSigByUrl(__namedParameters): AuthSig

• Retrieves the session signature for a given URL from the sessionSigs map. Throws an error if sessionSigs is not provided or if the session signature for the URL is not found.

  Parameters

  • __namedParameters: {
        sessionSigs: SessionSigsMap;
        url: string;
    }

    • sessionSigs: SessionSigsMap

    • url: string

  Returns AuthSig

  The session signature for the given URL.

  Throws

  An error if sessionSigs is not provided or if the session signature for the URL is not found.

handleNodePromises

• handleNodePromises<T>(nodePromises, requestId, minNodeCount): Promise<RejectedNodePromises | SuccessNodePromises<T>>

• Handle node promises

  Type Parameters

  • T

  Parameters

  • nodePromises: Promise<T>[]
  • requestId: string

    requestId to be logged in case of error
  • minNodeCount: number

    number of nodes we need valid results from in order to resolve

  Returns Promise<RejectedNodePromises | SuccessNodePromises<T>>

handshakeWithNode

• handshakeWithNode(params, requestId): Promise<NodeCommandServerKeysResponse>

• Handshake with Node

  Parameters

  • params: HandshakeWithNode
  • requestId: string

  Returns Promise<NodeCommandServerKeysResponse>

sendCommandToNode

• sendCommandToNode(__namedParameters): Promise<any>

• Send a command to nodes

  Parameters

  • __namedParameters: SendNodeCommand

  Returns Promise<any>

setCustomBootstrapUrls

• setCustomBootstrapUrls(): void

• Set bootstrapUrls to match the network litNetwork unless it's set to custom

  Returns void

validateAccessControlConditionsSchema

• validateAccessControlConditionsSchema(params): Promise<boolean>

• Parameters

  • params: MultipleAccessControlConditions

  Returns Promise<boolean>