Class LitCore

Hierarchy

LitCore
- LitNodeClientNodeJs

Index

Constructors

Properties

_blockHashUrl _connectingPromise _epochCache _networkSyncInterval _stakingContract _stakingContractListener config connectedNodes hdRootPubkeys lastBlockHashRetrieved latestBlockhash networkPubKey networkPubKeySet ready serverKeys subnetPubKey

Accessors

_epochState currentEpochNumber

Constructors

constructor

new LitCore(config: LitNodeClientConfig | CustomNetwork): LitCore
Parameters
- config: LitNodeClientConfig | CustomNetwork
Returns LitCore
- Defined in packages/core/src/lib/lit-core.ts:167

Properties

`Private` _blockHashUrl

_blockHashUrl: string = 'https://block-indexer.litgateway.com/get_most_recent_valid_block'

`Private` _connectingPromise

_connectingPromise: Promise<void> = null

`Private` _epochCache

_epochCache: EpochCache = ...

`Private` _networkSyncInterval

_networkSyncInterval: Timeout = null

`Private` _stakingContract

_stakingContract: Contract = null

`Private` _stakingContractListener

_stakingContractListener: Listener = null

config

config: LitNodeClientConfigWithDefaults = ...

connectedNodes

connectedNodes: any = ...

hdRootPubkeys

hdRootPubkeys: string[] = null

lastBlockHashRetrieved

lastBlockHashRetrieved: number = null

latestBlockhash

latestBlockhash: string = null

networkPubKey

networkPubKey: string = null

networkPubKeySet

networkPubKeySet: string = null

ready

ready: boolean = false

serverKeys

serverKeys: Record<string, JsonHandshakeResponse> = {}

subnetPubKey

subnetPubKey: string = null

Accessors

`Private` _epochState

set _epochState(__namedParameters: Pick<EpochCache, "startTime" | "currentNumber">): void
Parameters
- __namedParameters: Pick<EpochCache, "startTime" | "currentNumber">
Returns void
- Defined in packages/core/src/lib/lit-core.ts:992

currentEpochNumber

get currentEpochNumber(): number
Returns number
- Defined in packages/core/src/lib/lit-core.ts:976

Methods

`Private` _connect

_connect(): Promise<void>
Returns Promise<void>
- Defined in packages/core/src/lib/lit-core.ts:494

`Private` _fetchCurrentEpochState

_fetchCurrentEpochState(epochInfo?: EpochInfo): Promise<Pick<EpochCache, "startTime" | "currentNumber">>
Parameters
- Optional epochInfo: EpochInfo
Returns Promise<Pick<EpochCache, "startTime" | "currentNumber">>
- Defined in packages/core/src/lib/lit-core.ts:954

`Private` _getCoreNodeConfigFromHandshakeResults

_getCoreNodeConfigFromHandshakeResults(__namedParameters: {
requestId: string;
serverKeys: Record<string, JsonHandshakeResponse>;
}): CoreNodeConfig
Parameters
- __namedParameters: {
  requestId: string;
  serverKeys: Record<string, JsonHandshakeResponse>;
  }
  - requestId: string
  - serverKeys: Record<string, JsonHandshakeResponse>
Returns CoreNodeConfig
- Defined in packages/core/src/lib/lit-core.ts:727

`Private` _getProviderWithFallback

_getProviderWithFallback(): Promise<JsonRpcProvider>
Returns Promise<JsonRpcProvider>
- Defined in packages/core/src/lib/lit-core.ts:781

`Private` _getValidatorData

_getValidatorData(): Promise<{
    bootstrapUrls: string[];
    epochInfo: EpochInfo;
    minNodeCount: number;
    stakingContract: Contract;
}>
Retrieves the validator data including staking contract, epoch, minNodeCount, and bootstrapUrls.

Returns
An object containing the validator data.

Throws
Error if minNodeCount is not provided, is less than or equal to 0, or if bootstrapUrls are not available.

Returns Promise<{
    bootstrapUrls: string[];
    epochInfo: EpochInfo;
    minNodeCount: number;
    stakingContract: Contract;
}>
- Defined in packages/core/src/lib/lit-core.ts:250

`Private` _handleStakingContractStateChange

_handleStakingContractStateChange(state: StakingStates): Promise<void>
Parameters
- state: StakingStates
Returns Promise<void>
- Defined in packages/core/src/lib/lit-core.ts:310

`Private` _handshakeAndVerifyNodeAttestation

_handshakeAndVerifyNodeAttestation(__namedParameters: {
requestId: string;
url: string;
}): Promise<JsonHandshakeResponse>
Parameters
- __namedParameters: {
  requestId: string;
  url: string;
  }
  - requestId: string
  - url: string
Returns Promise<JsonHandshakeResponse>
- Defined in packages/core/src/lib/lit-core.ts:574

`Private` _listenForNewEpoch

_listenForNewEpoch(): void
Sets up a listener to detect state changes (new epochs) in the staking contract. When a new epoch is detected, it triggers the setNewConfig function to update the client's configuration based on the new state of the network. This ensures that the client's configuration is always in sync with the current state of the staking contract.

Returns
A promise that resolves when the listener is successfully set up.

Returns void
- Defined in packages/core/src/lib/lit-core.ts:378

`Private` _runHandshakeWithBootstrapUrls

_runHandshakeWithBootstrapUrls(): Promise<{
    connectedNodes: Set<string>;
    coreNodeConfig: CoreNodeConfig;
    serverKeys: Record<string, JsonHandshakeResponse>;
}>
Private
Handshakes with all nodes that are in bootstrapUrls

Returns
Returns a set of the urls of nodes that we successfully connected to, an object containing their returned keys, and our 'core' config (most common values for critical values)

Returns Promise<{
    connectedNodes: Set<string>;
    coreNodeConfig: CoreNodeConfig;
    serverKeys: Record<string, JsonHandshakeResponse>;
}>
- Defined in packages/core/src/lib/lit-core.ts:671

_stopListeningForNewEpoch

_stopListeningForNewEpoch(): void
Returns void
- Defined in packages/core/src/lib/lit-core.ts:419

`Private` _syncBlockhash

_syncBlockhash(): Promise<void>
Fetches the latest block hash and log any errors that are returned

Returns
void

Returns Promise<void>
- Defined in packages/core/src/lib/lit-core.ts:803

_throwNodeError

_throwNodeError(res: RejectedNodePromises, requestId: string): void
Throw node error

Returns
Parameters
- res: RejectedNodePromises
- requestId: string
Returns void
- Defined in packages/core/src/lib/lit-core.ts:1281

computeHDKeyId

computeHDKeyId(userId: string, appId: string, isForActionContext?: boolean): 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

Returns

public key of pkp when claimed

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

computeHDPubKey

computeHDPubKey(keyId: string, sigType?: LIT_CURVE): string
Calculates an HD public key from a given keyId The curve type or signature type is assumed to be k256 unless provided

Returns
public key
Parameters
- keyId: string
- sigType: LIT_CURVE = LIT_CURVE.EcdsaCaitSith
Returns string
- Defined in packages/core/src/lib/lit-core.ts:1393

connect

connect(): Promise<void>
Connect to the LIT nodes

Returns
A promise that resolves when the nodes are connected.

Returns Promise<void>
- Defined in packages/core/src/lib/lit-core.ts:476

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>
- Defined in packages/core/src/lib/lit-core.ts:404

getFormattedAccessControlConditions

getFormattedAccessControlConditions(params: SupportedJsonRequests): FormattedMultipleAccs
Get different formats of access control conditions, eg. evm, sol, unified etc.

Returns
Parameters
- params: SupportedJsonRequests
Returns FormattedMultipleAccs
- Defined in packages/core/src/lib/lit-core.ts:1320

getHashedAccessControlConditions

getHashedAccessControlConditions(params: MultipleAccessControlConditions): Promise<ArrayBuffer>
Get hash of access control conditions

Returns
Parameters
- params: MultipleAccessControlConditions
Returns Promise<ArrayBuffer>
- Defined in packages/core/src/lib/lit-core.ts:1155

getLatestBlockhash

getLatestBlockhash(): Promise<string>
Return the latest blockhash from the nodes

Returns
latest blockhash

Returns Promise<string>
- Defined in packages/core/src/lib/lit-core.ts:458

getLogsForRequestId

getLogsForRequestId(id: string): string[]
Parameters
- id: string
Returns string[]
- Defined in packages/core/src/lib/lit-core.ts:237

getNodePromises

getNodePromises(callback: ((url: string) => Promise<any>)): Promise<any>[]
Get and gather node promises

Returns
Parameters
- callback: ((url: string) => Promise<any>)
  - - (url: string): Promise<any>
    - Parameters
      
      url: string
      
      Returns Promise<any>
Returns Promise<any>[]
- Defined in packages/core/src/lib/lit-core.ts:1055

getRandomHexString

getRandomHexString(size: number): string
Get a random hex string for use as an attestation challenge

Returns
Parameters
- size: number
Returns string
- Defined in packages/core/src/lib/lit-core.ts:913

getRandomNodePromise

getRandomNodePromise(callback: ((url: string) => Promise<any>)): Promise<any>[]
Parameters
- callback: ((url: string) => Promise<any>)
  - - (url: string): Promise<any>
    - Parameters
      
      url: string
      
      Returns Promise<any>
Returns Promise<any>[]
- Defined in packages/core/src/lib/lit-core.ts:1071

getRequestId

getRequestId(): any
Get a random request ID

Returns

Returns any
- Defined in packages/core/src/lib/lit-core.ts:902

getRequestIds

getRequestIds(): Set<string>
Returns Set<string>
- Defined in packages/core/src/lib/lit-core.ts:241

getSessionSigByUrl

getSessionSigByUrl(__namedParameters: {
sessionSigs: SessionSigsMap;
url: string;
}): 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.

Returns
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.
Parameters
- __namedParameters: {
  sessionSigs: SessionSigsMap;
  url: string;
  }
  - sessionSigs: SessionSigsMap
  - url: string
Returns AuthSig
- Defined in packages/core/src/lib/lit-core.ts:1092

handleNodePromises

handleNodePromises<T>(nodePromises: Promise<T>[], requestId: string, minNodeCount: number): Promise<SuccessNodePromises<T> | RejectedNodePromises>
Handle node promises

Returns
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<SuccessNodePromises<T> | RejectedNodePromises>
- Defined in packages/core/src/lib/lit-core.ts:1198

handshakeWithNode

handshakeWithNode(params: HandshakeWithNode, requestId: string): Promise<NodeCommandServerKeysResponse>
Handshake with Node

Returns
Parameters
- params: HandshakeWithNode
- requestId: string
Returns Promise<NodeCommandServerKeysResponse>
- Defined in packages/core/src/lib/lit-core.ts:927

sendCommandToNode

sendCommandToNode(__namedParameters: SendNodeCommand): Promise<any>
Send a command to nodes

Returns
Parameters
- __namedParameters: SendNodeCommand
Returns Promise<any>
- Defined in packages/core/src/lib/lit-core.ts:1010

setCustomBootstrapUrls

setCustomBootstrapUrls(): void
Set bootstrapUrls to match the network litNetwork unless it's set to custom

Returns

Returns void
- Defined in packages/core/src/lib/lit-core.ts:433

validateAccessControlConditionsSchema

validateAccessControlConditionsSchema(params: MultipleAccessControlConditions): Promise<boolean>
Parameters
- params: MultipleAccessControlConditions
Returns Promise<boolean>
- Defined in packages/core/src/lib/lit-core.ts:1120

Class LitCore

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

config: LitNodeClientConfig | CustomNetwork

Returns LitCore

Properties

Private _blockHashUrl

Private _connectingPromise

Private _epochCache

Private _networkSyncInterval

Private _stakingContract

Private _stakingContractListener

config

connectedNodes

hdRootPubkeys

lastBlockHashRetrieved

latestBlockhash

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

Accessors

Private _epochState

Parameters

__namedParameters: Pick<EpochCache, "startTime" | "currentNumber">

Returns void

currentEpochNumber

Returns number

Methods

Private _connect

Returns Promise<void>

Private _fetchCurrentEpochState

Parameters

Optional epochInfo: EpochInfo

Returns Promise<Pick<EpochCache, "startTime" | "currentNumber">>

Private _getCoreNodeConfigFromHandshakeResults

Parameters

__namedParameters: { requestId: string; serverKeys: Record<string, JsonHandshakeResponse>; }

requestId: string

serverKeys: Record<string, JsonHandshakeResponse>

Returns CoreNodeConfig

Private _getProviderWithFallback

Returns Promise<JsonRpcProvider>

Private _getValidatorData

Returns

Throws

Returns Promise<{ bootstrapUrls: string[]; epochInfo: EpochInfo; minNodeCount: number; stakingContract: Contract; }>

Private _handleStakingContractStateChange

Parameters

state: StakingStates

Returns Promise<void>

Private _handshakeAndVerifyNodeAttestation

Parameters

__namedParameters: { requestId: string; url: string; }

requestId: string

url: string

Returns Promise<JsonHandshakeResponse>

Private _listenForNewEpoch

Returns

Returns void

Private _runHandshakeWithBootstrapUrls

Returns

Returns Promise<{ connectedNodes: Set<string>; coreNodeConfig: CoreNodeConfig; serverKeys: Record<string, JsonHandshakeResponse>; }>

_stopListeningForNewEpoch

Returns void

Private _syncBlockhash

Returns

Returns Promise<void>

_throwNodeError

Returns

Parameters

res: RejectedNodePromises

`Private` _blockHashUrl

`Private` _connectingPromise

`Private` _epochCache

`Private` _networkSyncInterval

`Private` _stakingContract

`Private` _stakingContractListener

`Private` _epochState

`Private` _connect

`Private` _fetchCurrentEpochState

`Optional` epochInfo: EpochInfo

`Private` _getCoreNodeConfigFromHandshakeResults

__namedParameters: {
requestId: string;
serverKeys: Record<string, JsonHandshakeResponse>;
}

`Private` _getProviderWithFallback

`Private` _getValidatorData

Returns Promise<{
bootstrapUrls: string[];
epochInfo: EpochInfo;
minNodeCount: number;
stakingContract: Contract;
}>

`Private` _handleStakingContractStateChange

`Private` _handshakeAndVerifyNodeAttestation

__namedParameters: {
requestId: string;
url: string;
}

`Private` _listenForNewEpoch

`Private` _runHandshakeWithBootstrapUrls

Returns Promise<{
connectedNodes: Set<string>;
coreNodeConfig: CoreNodeConfig;
serverKeys: Record<string, JsonHandshakeResponse>;
}>

`Private` _syncBlockhash

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