Interface ILitNodeClient

interface ILitNodeClient {
    config: LitNodeClientConfig;
    connectedNodes: Set<string>;
    latestBlockhash: string;
    networkPubKey: string;
    networkPubKeySet: string;
    ready: boolean;
    serverKeys: Record<string, JsonHandshakeResponse>;
    subnetPubKey: string;
    _throwNodeError(res: RejectedNodePromises, requestId: string): never;
    combineSharesAndGetJWT(signatureShares: NodeBlsSigningShare[]): Promise<string>;
    connect(): Promise<any>;
    decrypt(params: DecryptRequest): Promise<DecryptResponse>;
    encrypt(params: EncryptSdkParams): Promise<EncryptResponse>;
    executeJs(params: JsonExecutionSdkParams): Promise<ExecuteJsResponse>;
    generateSessionCapabilityObjectWithWildcards(litResources: ILitResource[]): Promise<ISessionCapabilityObject>;
    getFormattedAccessControlConditions(params: SupportedJsonRequests): FormattedMultipleAccs;
    getHashedAccessControlConditions(params: MultipleAccessControlConditions): Promise<ArrayBuffer>;
    getJWTParams(): {
        exp: number;
        iat: number;
    };
    getNodePromises(callback: Function): Promise<any>[];
    handleNodePromises<T>(nodePromises: Promise<T>[], requestId: string, minNodeCount: number): Promise<RejectedNodePromises | SuccessNodePromises<T>>;
    handshakeWithNode(params: HandshakeWithNode, requestId: string): Promise<NodeCommandServerKeysResponse>;
    sendCommandToNode(__namedParameters: SendNodeCommand): Promise<any>;
    setCustomBootstrapUrls(): void;
}

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, requestId): never
Throw node error
Parameters
- res: RejectedNodePromises
- requestId: string
Returns never
- Defined in packages/types/src/lib/ILitNodeClient.ts:134

combineSharesAndGetJWT

combineSharesAndGetJWT(signatureShares): Promise<string>
Combine Shares from signature shares
Parameters
- signatureShares: NodeBlsSigningShare[]
Returns Promise<string>
final JWT (convert the sig to base64 and append to the jwt)
- Defined in packages/types/src/lib/ILitNodeClient.ts:65

connect

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

Returns Promise<any>
A promise that resolves when the nodes are connected.
- Defined in packages/types/src/lib/ILitNodeClient.ts:197

decrypt

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

encrypt

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

executeJs

executeJs(params): Promise<ExecuteJsResponse>
Execute JS on the nodes and combine and return any resulting signatures
Parameters
- params: JsonExecutionSdkParams
Returns Promise<ExecuteJsResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:172

generateSessionCapabilityObjectWithWildcards

generateSessionCapabilityObjectWithWildcards(litResources): Promise<ISessionCapabilityObject>
Generates a session capability object
Parameters
- litResources: ILitResource[]
  An array of ILitResource to be processed.
Returns Promise<ISessionCapabilityObject>
A Promise resolving to an ISessionCapabilityObject.
- Defined in packages/types/src/lib/ILitNodeClient.ts:205

getFormattedAccessControlConditions

getFormattedAccessControlConditions(params): FormattedMultipleAccs
Get different formats of access control conditions, eg. evm, sol, unified etc.
Parameters
- params: SupportedJsonRequests
Returns FormattedMultipleAccs
- Defined in packages/types/src/lib/ILitNodeClient.ts:78

getHashedAccessControlConditions

getHashedAccessControlConditions(params): Promise<ArrayBuffer>
Get hash of access control conditions
Parameters
- params: MultipleAccessControlConditions
Returns Promise<ArrayBuffer>
- Defined in packages/types/src/lib/ILitNodeClient.ts:91

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

getNodePromises

getNodePromises(callback): Promise<any>[]
Get and gather node promises
Parameters
- callback: Function
Returns Promise<any>[]
- Defined in packages/types/src/lib/ILitNodeClient.ts:106

handleNodePromises

handleNodePromises<T>(nodePromises, requestId, minNodeCount): Promise<RejectedNodePromises | SuccessNodePromises<T>>
Handle node promises
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:118

handshakeWithNode

handshakeWithNode(params, requestId): Promise<NodeCommandServerKeysResponse>
Handshake with SGX
Parameters
- params: HandshakeWithNode
- requestId: string
Returns Promise<NodeCommandServerKeysResponse>
- Defined in packages/types/src/lib/ILitNodeClient.ts:157

sendCommandToNode

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

setCustomBootstrapUrls

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

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

Interface ILitNodeClient

Implemented by

Index

Properties

Methods

Properties

config

connectedNodes

latestBlockhash

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

Methods

_throwNodeError

Parameters

Returns never

combineSharesAndGetJWT

Parameters

Returns Promise<string>

connect

Returns Promise<any>

decrypt

Parameters

Returns Promise<DecryptResponse>

encrypt

Parameters

Returns Promise<EncryptResponse>

executeJs

Parameters

Returns Promise<ExecuteJsResponse>

generateSessionCapabilityObjectWithWildcards

Parameters

Returns Promise<ISessionCapabilityObject>

getFormattedAccessControlConditions

Parameters

Returns FormattedMultipleAccs

getHashedAccessControlConditions

Parameters

Returns Promise<ArrayBuffer>

getJWTParams

Returns { exp: number; iat: number; }

exp: number

iat: number

getNodePromises

Parameters

Returns Promise<any>[]

handleNodePromises

Type Parameters

Parameters

Returns Promise<RejectedNodePromises | SuccessNodePromises<T>>

handshakeWithNode

Parameters

Returns Promise<NodeCommandServerKeysResponse>

sendCommandToNode

Parameters

Returns Promise<any>

setCustomBootstrapUrls

Returns void

Settings

On This Page

Returns {
exp: number;
iat: number;
}