Interface ILitNodeClient

Hierarchy

ILitNodeClient

Implemented by

LitNodeClientNodeJs

Properties

config

config: LitNodeClientConfig

connectedNodes

connectedNodes: Set<string>

latestBlockhash

latestBlockhash: string

networkPubKey

networkPubKey: string

networkPubKeySet

networkPubKeySet: string

ready

ready: boolean

serverKeys

serverKeys: Record<string, JsonHandshakeResponse>

subnetPubKey

subnetPubKey: string

Methods

_throwNodeError

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

Returns
Parameters
- res: RejectedNodePromises
- requestId: string
Returns void
- Defined in packages/types/src/lib/ILitNodeClient.ts:132

combineSharesAndGetJWT

combineSharesAndGetJWT(signatureShares: NodeBlsSigningShare[]): string
Combine Shares from signature shares

Returns
final JWT (convert the sig to base64 and append to the jwt)
Parameters
- signatureShares: NodeBlsSigningShare[]
Returns string
- Defined in packages/types/src/lib/ILitNodeClient.ts:66

connect

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

Returns
A promise that resolves when the nodes are connected.

Returns Promise<any>
- Defined in packages/types/src/lib/ILitNodeClient.ts:219

decrypt

decrypt(params: DecryptRequest): Promise<DecryptResponse>
Decrypt data with Lit identity-based Timelock Encryption.
Parameters
- params: DecryptRequest
Returns Promise<DecryptResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:210

encrypt

encrypt(params: EncryptSdkParams): Promise<EncryptResponse>
Encrypt data with Lit identity-based Timelock Encryption.
Parameters
- params: EncryptSdkParams
Returns Promise<EncryptResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:203

executeJs

executeJs(params: JsonExecutionSdkParams): Promise<ExecuteJsResponse>
Execute JS on the nodes and combine and return any resulting signatures

Returns
Parameters
- params: JsonExecutionSdkParams
Returns Promise<ExecuteJsResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:183

generateSessionCapabilityObjectWithWildcards

generateSessionCapabilityObjectWithWildcards(litResources: ILitResource[]): Promise<ISessionCapabilityObject>
Generates a session capability object

Returns
A Promise resolving to an ISessionCapabilityObject.
Parameters
- litResources: ILitResource[]
  
  An array of ILitResource to be processed.
Returns Promise<ISessionCapabilityObject>
- Defined in packages/types/src/lib/ILitNodeClient.ts:227

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/types/src/lib/ILitNodeClient.ts:77

getHashedAccessControlConditions

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

Returns
Parameters
- params: MultipleAccessControlConditions
Returns Promise<ArrayBuffer>
- Defined in packages/types/src/lib/ILitNodeClient.ts:90

getJWTParams

getJWTParams(): {
exp: number;
iat: number;
}
we need to send jwt params iat (issued at) and exp (expiration) because the nodes may have different wall clock times, the nodes will verify that these params are withing a grace period

Returns {
exp: number;
iat: number;
}
- exp: number
- iat: number
- Defined in packages/types/src/lib/ILitNodeClient.ts:55

getNodePromises

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

Returns
Parameters
- callback: Function
Returns Promise<any>[]
- Defined in packages/types/src/lib/ILitNodeClient.ts:105

getSignature

getSignature(shareData: any[], requestId: string): Promise<any>
Get Signature

Returns
signature
Parameters
- shareData: any[]
  
  from all node promises
- requestId: string
Returns Promise<any>
- Defined in packages/types/src/lib/ILitNodeClient.ts:145

getSignedToken

getSignedToken(params: GetSignedTokenRequest): Promise<string>
Request a signed JWT from the LIT network. Before calling this function, you must know the access control conditions for the item you wish to gain authorization for.

Returns
final JWT
Parameters
- params: GetSignedTokenRequest
Returns Promise<string>
- Defined in packages/types/src/lib/ILitNodeClient.ts:196

handleNodePromises

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

Returns
Type Parameters
- T
Parameters
- nodePromises: Promise<T>[]
- requestId: string
  
  request Id used for logging
- minNodeCount: number
  
  The minimum number of nodes we need a successful response from to continue
Returns Promise<RejectedNodePromises | SuccessNodePromises<T>>
- Defined in packages/types/src/lib/ILitNodeClient.ts:117

handshakeWithNode

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

Returns
Parameters
- params: HandshakeWithNode
- requestId: string
Returns Promise<NodeCommandServerKeysResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:168

sendCommandToNode

sendCommandToNode(__namedParameters: SendNodeCommand): Promise<any>
Parameters
- __namedParameters: SendNodeCommand
Returns Promise<any>
- Defined in packages/types/src/lib/ILitNodeClient.ts:148

setCustomBootstrapUrls

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

Returns

Returns void
- Defined in packages/types/src/lib/ILitNodeClient.ts:48

Interface ILitNodeClient

Hierarchy

Implemented by

Index

Properties

Methods

Properties

config

connectedNodes

latestBlockhash

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

Methods

_throwNodeError

Returns

Parameters

res: RejectedNodePromises

requestId: string

Returns void

combineSharesAndGetJWT

Returns

Parameters

signatureShares: NodeBlsSigningShare[]

Returns string

connect

Returns

Returns Promise<any>

decrypt

Parameters

params: DecryptRequest

Returns Promise<DecryptResponse>

encrypt

Parameters

params: EncryptSdkParams

Returns Promise<EncryptResponse>

executeJs

Returns

Parameters

params: JsonExecutionSdkParams

Returns Promise<ExecuteJsResponse>

generateSessionCapabilityObjectWithWildcards

Returns

Parameters

litResources: ILitResource[]

Returns Promise<ISessionCapabilityObject>

getFormattedAccessControlConditions

Returns

Parameters

params: SupportedJsonRequests

Returns FormattedMultipleAccs

getHashedAccessControlConditions

Returns

Parameters

params: MultipleAccessControlConditions

Returns Promise<ArrayBuffer>

getJWTParams

Returns { exp: number; iat: number; }

exp: number

iat: number

getNodePromises

Returns

Parameters

callback: Function

Returns Promise<any>[]

getSignature

Returns

Parameters

shareData: any[]

requestId: string

Returns Promise<any>

getSignedToken

Returns

Parameters

params: GetSignedTokenRequest

Returns Promise<string>

handleNodePromises

Returns

Returns {
exp: number;
iat: number;
}