Class LitCore

Hierarchy

LitCore
- LitNodeClientNodeJs

Constructors

constructor

new LitCore(args: any): LitCore
Parameters
- args: any
Returns LitCore
- Defined in packages/core/src/lib/lit-core.ts:70

Properties

config

config: LitNodeClientConfig

connectedNodes

connectedNodes: any

networkPubKey

networkPubKey: string

networkPubKeySet

networkPubKeySet: string

ready

ready: boolean

serverKeys

serverKeys: any

subnetPubKey

subnetPubKey: string

Methods

_throwNodeError

_throwNodeError(res: RejectedNodePromises): void
Throw node error

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

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/core/src/lib/lit-core.ts:137

getAuthSigOrSessionAuthSig

getAuthSigOrSessionAuthSig(__namedParameters: {
    authSig?: AuthSig;
    sessionSigs?: SessionSigsMap;
    url: string;
}): AuthSig | SessionSig
Get either auth sig or session auth sig
Parameters
- __namedParameters: {
      authSig?: AuthSig;
      sessionSigs?: SessionSigsMap;
      url: string;
  }
  - Optional authSig?: AuthSig
  - Optional sessionSigs?: SessionSigsMap
  - url: string
Returns AuthSig | SessionSig
- Defined in packages/core/src/lib/lit-core.ts:577

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/core/src/lib/lit-core.ts:855

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/core/src/lib/lit-core.ts:440

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

getHashedAccessControlConditions

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

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

getNodePromises

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

Returns
Parameters
- callback: Function
Returns Promise<any>[]
- Defined in packages/core/src/lib/lit-core.ts:562

getRequestId

getRequestId(): any
Get a random request ID *

Returns

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

handleNodePromises

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

Returns
Parameters
- nodePromises: Promise<any>[]
- Optional minNodeCount: number
Returns Promise<SuccessNodePromises | RejectedNodePromises>
- Defined in packages/core/src/lib/lit-core.ts:692

handshakeWithSgx

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

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

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/core/src/lib/lit-core.ts:320

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

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

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/core/src/lib/lit-core.ts:666

Class LitCore

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

args: any

Returns LitCore

Properties

config

connectedNodes

networkPubKey

networkPubKeySet

ready

serverKeys

subnetPubKey

Methods

_throwNodeError

Returns

Parameters

res: RejectedNodePromises

Returns void

connect

Returns

Returns Promise<any>

getAuthSigOrSessionAuthSig

Parameters

__namedParameters: { authSig?: AuthSig; sessionSigs?: SessionSigsMap; url: string; }

Optional authSig?: AuthSig

Optional sessionSigs?: SessionSigsMap

url: string

Returns AuthSig | SessionSig

getDecryptionShare

Returns

Parameters

url: string

params: JsonEncryptionRetrieveRequest

requestId: string

Returns Promise<NodeCommandResponse>

getEncryptionKey

Parameters

params: JsonEncryptionRetrieveRequest

Returns Promise<Uint8Array>

getFormattedAccessControlConditions

Returns

Parameters

params: SupportedJsonRequests

Returns FormattedMultipleAccs

getHashedAccessControlConditions

Returns

Parameters

params: JsonStoreSigningRequest

Returns Promise<ArrayBuffer>

getNodePromises

Returns

Parameters

callback: Function

Returns Promise<any>[]

getRequestId

Returns

Returns any

handleNodePromises

Returns

Parameters

nodePromises: Promise<any>[]

Optional minNodeCount: number

Returns Promise<SuccessNodePromises | RejectedNodePromises>

handshakeWithSgx

Returns

Parameters

params: HandshakeWithSgx

requestId: string

Returns Promise<NodeCommandServerKeysResponse>

saveEncryptionKey

Returns

Parameters

params: JsonSaveEncryptionKeyRequest

__namedParameters: {
authSig?: AuthSig;
sessionSigs?: SessionSigsMap;
url: string;
}

`Optional` authSig?: AuthSig

`Optional` sessionSigs?: SessionSigsMap

`Optional` minNodeCount: number