Interface ILitNodeClient

Hierarchy

ILitNodeClient

Properties

config

config: LitNodeClientConfig

connectedNodes

connectedNodes: any

networkPubKey

networkPubKey: string

networkPubKeySet

networkPubKeySet: string

ready

ready: boolean

serverKeys

serverKeys: any

subnetPubKey

subnetPubKey: string

Methods

combineSharesAndGetJWT

combineSharesAndGetJWT(networkPubKeySet: string, signatureShares: NodeShare[]): string
Combine Shares from network public key set and signature shares

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

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

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

getChainDataSigningShare

getChainDataSigningShare(url: string, params: JsonSignChainDataRequest, requestId: string): Promise<NodeCommandResponse>
Get Chain Data Signing Shares

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

getDecryptionShare

getDecryptionShare(url: string, params: JsonEncryptionRetrieveRequest, requestId: string): Promise<NodeCommandResponse>
Ger Decryption Shares from Nodes

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

getDecryptions

getDecryptions(decryptedData: any[]): Promise<any[]>
Get the decryptions from the decrypted data list

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

getEncryptionKey

getEncryptionKey(params: JsonEncryptionRetrieveRequest): Promise<Uint8Array>
Retrieve the symmetric encryption key from the LIT nodes. Note that this will only work if the current user meets the access control conditions specified when the data was encrypted. That access control condition is typically that the user is a holder of the NFT that corresponds to this encrypted data. This NFT token address and ID was specified when this LIT was created.
Parameters
- params: JsonEncryptionRetrieveRequest
Returns Promise<Uint8Array>
- Defined in packages/types/src/lib/ILitNodeClient.ts:383

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

getHashedAccessControlConditions

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

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

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

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

getSignature

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

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

getSignatures

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

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

getSignedChainDataToken

getSignedChainDataToken(params: SignedChainDataToken): Promise<string>
Request a signed JWT of any solidity function call from the LIT network. There are no prerequisites for this function. You should use this function if you need to transmit information across chains, or from a blockchain to a centralized DB or server. The signature of the returned JWT verifies that the response is genuine.

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

getSignedToken

getSignedToken(params: JsonSigningRetrieveRequest): Promise<string>
Request a signed JWT from the LIT network. Before calling this function, you must either create or know of a resource id and access control conditions for the item you wish to gain authorization for. You can create an access control condition using the saveSigningCondition function.

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

getSigningShare

getSigningShare(url: string, params: JsonSigningRetrieveRequest, requestId: string): Promise<NodeCommandResponse>
Get Signing Shares from Nodes

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

handleNodePromises

handleNodePromises(nodePromises: Promise<any>[]): Promise<SuccessNodePromises | RejectedNodePromises>
Handle node promises

Returns
Parameters
- nodePromises: Promise<any>[]
Returns Promise<SuccessNodePromises | RejectedNodePromises>
- Defined in packages/types/src/lib/ILitNodeClient.ts:141

handshakeWithSgx

handshakeWithSgx(params: HandshakeWithSgx, requestId: string): Promise<NodeCommandServerKeysResponse>
Handshake with SGX

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

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

saveEncryptionKey

saveEncryptionKey(params: JsonSaveEncryptionKeyRequest): Promise<Uint8Array>
Securely save the association between access control conditions and something that you wish to decrypt

Returns
Parameters
- params: JsonSaveEncryptionKeyRequest
Returns Promise<Uint8Array>
- Defined in packages/types/src/lib/ILitNodeClient.ts:394

saveSigningCondition

saveSigningCondition(params: JsonStoreSigningRequest): Promise<boolean>
Associated access control conditions with a resource on the web. After calling this function, users may use the getSignedToken function to request a signed JWT from the LIT network. This JWT proves that the user meets the access control conditions, and is authorized to access the resource you specified in the resourceId parameter of the saveSigningCondition function.

Returns
Parameters
- params: JsonStoreSigningRequest
Returns Promise<boolean>
- Defined in packages/types/src/lib/ILitNodeClient.ts:374

sendCommandToNode

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

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

storeEncryptionConditionWithNode

storeEncryptionConditionWithNode(url: string, params: JsonSigningStoreRequest, requestId: string): Promise<NodeCommandResponse>
Store encryption conditions to nodes

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

storeSigningConditionWithNode

storeSigningConditionWithNode(url: string, params: JsonSigningStoreRequest, requestId: string): Promise<NodeCommandResponse>
Store signing conditions to nodes

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

throwNodeError

throwNodeError(res: RejectedNodePromises): void
Throw node error

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

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

Interface ILitNodeClient

Hierarchy

Index

Properties

Methods

Properties

config

connectedNodes

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

Methods

combineSharesAndGetJWT

Returns

Parameters

networkPubKeySet: string

signatureShares: NodeShare[]

Returns string

connect

Returns

Returns Promise<any>

executeJs

Returns

Parameters

params: ExecuteJsProps

Returns Promise<ExecuteJsResponse>

getChainDataSigningShare

Returns

Parameters

url: string

params: JsonSignChainDataRequest

requestId: string

Returns Promise<NodeCommandResponse>

getDecryptionShare

Returns

Parameters

url: string

params: JsonEncryptionRetrieveRequest

requestId: string

Returns Promise<NodeCommandResponse>

getDecryptions

Returns

Parameters

decryptedData: any[]

Returns Promise<any[]>

getEncryptionKey

Parameters

params: JsonEncryptionRetrieveRequest

Returns Promise<Uint8Array>

getFormattedAccessControlConditions

Returns

Parameters

params: SupportedJsonRequests

Returns FormattedMultipleAccs

getHashedAccessControlConditions

Returns

Parameters

params: JsonStoreSigningRequest

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

Returns {
exp: number;
iat: number;
}