Class LitNodeClientNodeJs

========== PKP ==========

Hierarchy

LitCore
- LitNodeClientNodeJs
  - LitNodeClient

Implements

Index

Constructors

constructor

new LitNodeClientNodeJs(args: LitNodeClientConfig | CustomNetwork): LitNodeClientNodeJs
Parameters
- args: LitNodeClientConfig | CustomNetwork
Returns LitNodeClientNodeJs
Overrides LitCore.constructor
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:135

Properties

`Optional` defaultAuthCallback

defaultAuthCallback?: ((authSigParams: AuthCallbackParams) => Promise<AuthSig>)

Type declaration

- (authSigParams: AuthCallbackParams): Promise<AuthSig>
- Parameters
  - authSigParams: AuthCallbackParams
  Returns Promise<AuthSig>

Methods

`Private` #authCallbackAndUpdateStorageItem

#authCallbackAndUpdateStorageItem(__namedParameters: {
authCallback?: AuthCallback;
authCallbackParams: AuthCallbackParams;
}): Promise<AuthSig>
Parameters
- __namedParameters: {
  authCallback?: AuthCallback;
  authCallbackParams: AuthCallbackParams;
  }
  - Optional authCallback?: AuthCallback
  - authCallbackParams: AuthCallbackParams
Returns Promise<AuthSig>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:588

`Private` #decryptWithSignatureShares

#decryptWithSignatureShares(networkPubKey: string, identityParam: Uint8Array, ciphertext: string, signatureShares: NodeBlsSigningShare[]): Uint8Array
Parameters
- networkPubKey: string
- identityParam: Uint8Array
- ciphertext: string
- signatureShares: NodeBlsSigningShare[]
Returns Uint8Array
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:932

`Private` #getIdentityParamForEncryption

#getIdentityParamForEncryption(hashOfConditionsStr: string, hashOfPrivateDataStr: string): string
Parameters
- hashOfConditionsStr: string
- hashOfPrivateDataStr: string
Returns string
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2305

`Private` #isSuccessNodePromises

#isSuccessNodePromises<T>(res: any): res is SuccessNodePromises<T>
Type Parameters
- T
Parameters
- res: any
Returns res is SuccessNodePromises<T>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2671

_getFlattenShare

_getFlattenShare(share: any): SigShare
Parameters
- share: any
Returns SigShare
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1111

checkNeedToResignSessionKey

checkNeedToResignSessionKey(__namedParameters: {
    authSig: AuthSig;
    resourceAbilityRequests: LitResourceAbilityRequest[];
    sessionKeyUri: any;
}): Promise<boolean>
Check if a session key needs to be resigned. These are the scenarios where a session key needs to be resigned:
1. The authSig.sig does not verify successfully against the authSig.signedMessage
2. The authSig.signedMessage.uri does not match the sessionKeyUri
3. The authSig.signedMessage does not contain at least one session capability object
Parameters
- __namedParameters: {
      authSig: AuthSig;
      resourceAbilityRequests: LitResourceAbilityRequest[];
      sessionKeyUri: any;
  }
  - authSig: AuthSig
  - resourceAbilityRequests: LitResourceAbilityRequest[]
  - sessionKeyUri: any
Returns Promise<boolean>
Implementation of LitClientSessionManager.checkNeedToResignSessionKey
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:643

claimKeyId

claimKeyId(params: ClaimRequest<ClaimProcessor>): Promise<ClaimKeyResponse>
Authenticates an Auth Method for claiming a Programmable Key Pair (PKP). A MintCallback can be defined for custom on chain interactions by default the callback will forward to a relay server for minting on chain.

Returns
Parameters
- params: ClaimRequest<ClaimProcessor>
  
  an Auth Method and MintCallback
Returns Promise<ClaimKeyResponse>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2879

combineSharesAndGetJWT

combineSharesAndGetJWT(signatureShares: NodeBlsSigningShare[], requestId?: string): 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
- signatureShares: NodeBlsSigningShare[]
- requestId: string = ''
Returns string
Implementation of ILitNodeClient.combineSharesAndGetJWT
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:891

createCapacityDelegationAuthSig

createCapacityDelegationAuthSig(params: CapacityCreditsReq): Promise<CapacityCreditsRes>
Parameters
- params: CapacityCreditsReq
Returns Promise<CapacityCreditsRes>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:178

decrypt

decrypt(params: DecryptRequest): Promise<DecryptResponse>
Decrypt ciphertext with the LIT network.
Parameters
- params: DecryptRequest
Returns Promise<DecryptResponse>
Implementation of ILitNodeClient.decrypt
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2119

encrypt

encrypt(params: EncryptRequest): Promise<EncryptResponse>
Encrypt data using the LIT network public key.
Parameters
- params: EncryptRequest
Returns Promise<EncryptResponse>
Implementation of ILitNodeClient.encrypt
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2030

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>
Implementation of ILitNodeClient.executeJs
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1523

generateAuthMethodForDiscord

generateAuthMethodForDiscord(access_token: string): AuthMethod
Parameters
- access_token: string
Returns AuthMethod
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2696

generateAuthMethodForGoogle

generateAuthMethodForGoogle(access_token: string): AuthMethod
Parameters
- access_token: string
Returns AuthMethod
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2701

generateAuthMethodForGoogleJWT

generateAuthMethodForGoogleJWT(access_token: string): AuthMethod
Parameters
- access_token: string
Returns AuthMethod
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2706

generateAuthMethodForWebAuthn

generateAuthMethodForWebAuthn(params: WebAuthnAuthenticationVerificationParams): AuthMethod
Parameters
- params: WebAuthnAuthenticationVerificationParams
Returns AuthMethod
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2689

generateSessionCapabilityObjectWithWildcards

generateSessionCapabilityObjectWithWildcards(litResources: ILitResource[]): Promise<ISessionCapabilityObject>
Parameters
- litResources: ILitResource[]
Returns Promise<ISessionCapabilityObject>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:450

getClaimKeyExecutionShares

getClaimKeyExecutionShares(url: string, params: any, requestId: string): Promise<any>
Parameters
- url: string
- params: any
- requestId: string
Returns Promise<any>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:765

getExpiration

getExpiration(): any
Returns any
Implementation of LitClientSessionManager.getExpiration
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:476

getIpfsId

getIpfsId(__namedParameters: {
    authSig: AuthSig;
    dataToHash: string;
    debug?: boolean;
}): Promise<any>
Parameters
- __namedParameters: {
      authSig: AuthSig;
      dataToHash: string;
      debug?: boolean;
  }
  - authSig: AuthSig
  - dataToHash: string
  - Optional debug?: boolean
Returns Promise<any>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:949

getJWTParams

getJWTParams(): {
exp: any;
iat: any;
}
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: any;
iat: any;
}
- exp: any
- iat: any
Implementation of ILitNodeClient.getJWTParams
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:336

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>
Implementation of ILitNodeClient.getJsExecutionShares
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:711

getLitActionRequestBody

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

Returns
Parameters
- params: ExecuteJsProps
Returns JsonExecutionRequest
Implementation of ILitNodeClient.getLitActionRequestBody
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:303

getLitResourceForEncryption

getLitResourceForEncryption(params: EncryptRequest): Promise<LitAccessControlConditionResource>
Parameters
- params: EncryptRequest
Returns Promise<LitAccessControlConditionResource>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2268

getPkpSignExecutionShares

getPkpSignExecutionShares(url: string, params: any, requestId: string): Promise<any>
Parameters
- url: string
- params: any
- requestId: string
Returns Promise<any>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:747

getSessionKey

getSessionKey(): SessionKeyPair
Try to get the session key in the local storage, if not, generates one.

Returns
session key pair

Returns SessionKeyPair
Implementation of LitClientSessionManager.getSessionKey
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:374

getSessionKeyUri

getSessionKeyUri(publicKey: string): string
Get Session Key URI eg. lit:session:0x1234

Returns
the session key uri
Parameters
- publicKey: string
  
  is the public key of the session key
Returns string
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2868

getSessionSignatures

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

Returns
Parameters
- signedData: any[]
Returns any
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1184

getSessionSigs

getSessionSigs(params: GetSessionSigsProps): Promise<SessionSigsMap>
Get session signatures for a set of resources

High level, how this works:
1. Generate or retrieve session key
2. Generate or retrieve the wallet signature of the session key
3. Sign the specific resources with the session key
Note: When generating session signatures for different PKPs or auth methods, be sure to call disconnectWeb3 to clear auth signatures stored in local storage
Parameters
- params: GetSessionSigsProps
Returns Promise<SessionSigsMap>
Implementation of LitClientSessionManager.getSessionSigs
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2724

getSignSessionKeyShares

getSignSessionKeyShares(url: string, params: GetSignSessionKeySharesProp, requestId: string): Promise<any>
Parameters
- url: string
- params: GetSignSessionKeySharesProp
- requestId: string
Returns Promise<any>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2675

getSignature

getSignature(shareData: any[], requestId: string): Promise<any>
Get a single signature

Returns
signature
Parameters
- shareData: any[]
  
  from all node promises
- requestId: string
Returns Promise<any>
Implementation of ILitNodeClient.getSignature
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1475

getSignatures

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

Returns
Parameters
- signedData: any[]
- requestId: string = ''
Returns any
Implementation of ILitNodeClient.getSignatures
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1312

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>
Implementation of ILitNodeClient.getSignedToken
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1897

getSigningShareForDecryption

getSigningShareForDecryption(url: string, params: GetSigningShareForDecryptionRequest, requestId: string): Promise<NodeCommandResponse>
Get signature shares for decryption.

Returns
Parameters
- url: string
- params: GetSigningShareForDecryptionRequest
- requestId: string
Returns Promise<NodeCommandResponse>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:816

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>
Implementation of ILitNodeClient.getSigningShareForToken
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:792

getWalletSig

getWalletSig(__namedParameters: GetWalletSigProps): Promise<AuthSig>
Get the signature from local storage, if not, generates one
Parameters
- __namedParameters: GetWalletSigProps
Returns Promise<AuthSig>
Implementation of LitClientSessionManager.getWalletSig
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:485

isSessionKeyPair

isSessionKeyPair(obj: any): obj is SessionKeyPair
Check if a given object is of type SessionKeyPair.

Returns
True if the object is of type SessionKeyPair.
Parameters
- obj: any
  
  The object to check.
Returns obj is SessionKeyPair
Implementation of LitClientSessionManager.isSessionKeyPair
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:409

parseResponses

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

Returns
JSON object
Parameters
- responseString: string
Returns any
Implementation of ILitNodeClient.parseResponses
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:353

pkpSign

pkpSign(params: JsonPkpSignRequest): Promise<any>
Parameters
- params: JsonPkpSignRequest
Returns Promise<any>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1748

runOnTargetedNodes

runOnTargetedNodes(params: ExecuteJsProps): Promise<RejectedNodePromises | SuccessNodePromises<NodeCommandResponse>>
Run lit action on a single deterministicly selected node. It's important that the nodes use the same deterministic selection algorithm.

Lit Action: dataToHash -> IPFS CID QmUjX8MW6StQ7NKNdaS6g4RMkvN5hcgtKmEi8Mca6oX4t3

Returns
Parameters
- params: ExecuteJsProps
Returns Promise<RejectedNodePromises | SuccessNodePromises<NodeCommandResponse>>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:991

signConditionEcdsa

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

Returns
Parameters
- url: string
- params: SignConditionECDSA
- requestId: string
Returns Promise<NodeCommandResponse>
Implementation of ILitNodeClient.signConditionEcdsa
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:841

signSessionKey

signSessionKey(params: SignSessionKeyProp): Promise<SignSessionKeyResponse>
Sign a session public key using a PKP, which generates an authSig.

Returns
An object containing the resulting signature.
Parameters
- params: SignSessionKeyProp
Returns Promise<SignSessionKeyResponse>
Implementation of LitClientSessionManager.signSessionKey
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2434

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>
Implementation of ILitNodeClient.validateAndSignEcdsa
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:2323

`Static` generateSessionCapabilityObjectWithWildcards

generateSessionCapabilityObjectWithWildcards(litResources: ILitResource[], addAllCapabilities?: boolean, rateLimitAuthSig?: AuthSig): Promise<ISessionCapabilityObject>
Generates wildcard capability for each of the LIT resources specified.
Parameters
- litResources: ILitResource[]
  
  is an array of LIT resources
- Optional addAllCapabilities: boolean
  
  is a boolean that specifies whether to add all capabilities for each resource
- Optional rateLimitAuthSig: AuthSig
Returns Promise<ISessionCapabilityObject>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:425

`Static` getClaims

getClaims(claims: any[]): Record<string, {
derivedKeyId: string;
signatures: Signature[];
}>
Parameters
- claims: any[]
Returns Record<string, {
derivedKeyId: string;
signatures: Signature[];
}>
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:144

`Static` getExpiration

getExpiration(): any
Get expiration for session

Returns any
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:471

`Static` normalizeParams

normalizeParams(params: ExecuteJsProps): ExecuteJsProps
Parameters
- params: ExecuteJsProps
Returns ExecuteJsProps
- Defined in packages/lit-node-client-nodejs/src/lib/lit-node-client-nodejs.ts:1493

Class LitNodeClientNodeJs

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

args: LitNodeClientConfig | CustomNetwork

Returns LitNodeClientNodeJs

Properties

Optional defaultAuthCallback

Type declaration

Parameters

authSigParams: AuthCallbackParams

Returns Promise<AuthSig>

Methods

Private #authCallbackAndUpdateStorageItem

Parameters

__namedParameters: { authCallback?: AuthCallback; authCallbackParams: AuthCallbackParams; }

Optional authCallback?: AuthCallback

authCallbackParams: AuthCallbackParams

Returns Promise<AuthSig>

Private #decryptWithSignatureShares

Parameters

networkPubKey: string

identityParam: Uint8Array

ciphertext: string

signatureShares: NodeBlsSigningShare[]

Returns Uint8Array

Private #getIdentityParamForEncryption

Parameters

hashOfConditionsStr: string

hashOfPrivateDataStr: string

Returns string

Private #isSuccessNodePromises

Type Parameters

T

Parameters

res: any

Returns res is SuccessNodePromises<T>

_getFlattenShare

Parameters

share: any

Returns SigShare

checkNeedToResignSessionKey

Parameters

__namedParameters: { authSig: AuthSig; resourceAbilityRequests: LitResourceAbilityRequest[]; sessionKeyUri: any; }

authSig: AuthSig

resourceAbilityRequests: LitResourceAbilityRequest[]

sessionKeyUri: any

Returns Promise<boolean>

claimKeyId

Returns

Parameters

params: ClaimRequest<ClaimProcessor>

Returns Promise<ClaimKeyResponse>

combineSharesAndGetJWT

Returns

Parameters

signatureShares: NodeBlsSigningShare[]

requestId: string = ''

Returns string

createCapacityDelegationAuthSig

Parameters

params: CapacityCreditsReq

Returns Promise<CapacityCreditsRes>

decrypt

Parameters

params: DecryptRequest

Returns Promise<DecryptResponse>

encrypt

Parameters

params: EncryptRequest

Returns Promise<EncryptResponse>

executeJs

Returns

Parameters

`Optional` defaultAuthCallback

`Private` #authCallbackAndUpdateStorageItem

__namedParameters: {
authCallback?: AuthCallback;
authCallbackParams: AuthCallbackParams;
}

`Optional` authCallback?: AuthCallback

`Private` #decryptWithSignatureShares

`Private` #getIdentityParamForEncryption

`Private` #isSuccessNodePromises

__namedParameters: {
authSig: AuthSig;
resourceAbilityRequests: LitResourceAbilityRequest[];
sessionKeyUri: any;
}

__namedParameters: {
authSig: AuthSig;
dataToHash: string;
debug?: boolean;
}

`Optional` debug?: boolean

Returns {
exp: any;
iat: any;
}