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:154

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:88

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:320

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:287

encrypt

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

executeJs

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

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

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:99

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:112

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:77

getJsExecutionShares

getJsExecutionShares(url: string, params: JsonExecutionRequest, requestId: string): Promise<NodeCommandResponse>
Get JS Execution Shares from Nodes

Returns
Parameters
- url: string
- params: JsonExecutionRequest
- requestId: string
Returns Promise<NodeCommandResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:201

getLitActionRequestBody

getLitActionRequestBody(params: ExecuteJsProps): JsonExecutionRequest
Get the request body of the lit action

Returns
Parameters
- params: ExecuteJsProps
Returns JsonExecutionRequest
- Defined in packages/types/src/lib/ILitNodeClient.ts:70

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:127

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:188

getSignatures

getSignatures(signedData: any[], requestId: string): any
Get signatures from signed data

Returns
Parameters
- signedData: any[]
- requestId: string
Returns any
- Defined in packages/types/src/lib/ILitNodeClient.ts:166

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:273

getSigningShareForToken

getSigningShareForToken(url: string, params: SigningAccessControlConditionRequest, requestId: string): Promise<NodeCommandResponse>
Get Signing Shares for Token containing Access Control Condition

Returns
Parameters
- url: string
- params: SigningAccessControlConditionRequest
- requestId: string
Returns Promise<NodeCommandResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:216

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:139

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:247

`Optional` overrideConfigsFromLocalStorage

overrideConfigsFromLocalStorage(): void
(Browser Only) Get the config from browser local storage and override default config

Returns

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

parseResponses

parseResponses(responseString: string): any
Parse the response string to JSON

Returns
JSON object
Parameters
- responseString: string
Returns any
- Defined in packages/types/src/lib/ILitNodeClient.ts:177

sendCommandToNode

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

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:59

signConditionEcdsa

signConditionEcdsa(url: string, params: SignConditionECDSA, requestId: string): Promise<NodeCommandResponse>
Sign Condition ECDSA

Returns
Parameters
- url: string
- params: SignConditionECDSA
- requestId: string
Returns Promise<NodeCommandResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:232

validateAndSignEcdsa

validateAndSignEcdsa(params: ValidateAndSignECDSA): Promise<string>
Validates a condition, and then signs the condition if the validation returns true. Before calling this function, you must know the on chain conditions that you wish to validate.

Returns
Parameters
- params: ValidateAndSignECDSA
Returns Promise<string>
- Defined in packages/types/src/lib/ILitNodeClient.ts:309

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: EncryptRequest

Returns Promise<EncryptResponse>

executeJs

Returns

Parameters

params: ExecuteJsProps

Returns Promise<ExecuteJsResponse>

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

getJsExecutionShares

Returns

Parameters

url: string

params: JsonExecutionRequest

requestId: string

Returns Promise<NodeCommandResponse>

getLitActionRequestBody

Returns

Parameters

params: ExecuteJsProps

Returns JsonExecutionRequest

getNodePromises

Returns

Parameters

callback: Function

Returns Promise<any>[]

getSignature

Returns

Parameters

shareData: any[]

requestId: string

Returns Promise<any>

Returns {
exp: number;
iat: number;
}

`Optional` overrideConfigsFromLocalStorage