Class PKPBase<T>

OptionalauthContext

compressedPubKey

compressedPubKeyBuffer

OptionalcontrollerAuthMethods

OptionalcontrollerSessionSigs

debug

OptionallitActionCode

OptionallitActionIPFS

litActionJsParams

litNodeClient

Optionalrpcs

uncompressedPubKey

uncompressedPubKeyBuffer

useAction

controllerAuthSig

• get controllerAuthSig(): AuthSig

• Returns AuthSig

  Deprecated

  • Use a different authentication method instead.
• set controllerAuthSig(value): void

• Parameters

  • value: AuthSig

  Returns void

  Deprecated

  • Use a different authentication method instead.

litNodeClientReady

• get litNodeClientReady(): boolean

• Returns boolean

ensureLitNodeClientReady

• ensureLitNodeClientReady(): Promise<void>

• Ensures that the LitNode client is ready for use by waiting for initialization if necessary. If the client is already ready, this function does nothing.

  Returns Promise<void>

  • A Promise that resolves when the LitNode client is ready for use.

init

• init(): Promise<void>

• Initializes the PKPBase instance by connecting to the LIT node.

  Returns Promise<void>

log

• log(...args): void

• Logs the provided arguments to the console, but only if debugging is enabled.

  Parameters

  • Rest...args: any[]

    The values to be logged to the console.

  Returns void

  • This function does not return a value.

runLitAction

• runLitAction(toSign, sigName): Promise<any>

• Runs the specified Lit action with the given parameters.

  Parameters

  • toSign: Uint8Array

    The data to be signed by the Lit action.
  • sigName: string

    The name of the signature to be returned by the Lit action.

  Returns Promise<any>

  • A Promise that resolves with the signature returned by the Lit action.

  Throws

  • Throws an error if pkpPubKey is not provided, if controllerAuthSig or controllerSessionSigs is not provided, if controllerSessionSigs is not an object, if executeJsArgs does not have either code or ipfsId, or if an error occurs during the execution of the Lit action.

runSign

• runSign(toSign): Promise<SigResponse>

• Sign the provided data with the PKP private key.

  Parameters

  • toSign: Uint8Array

    The data to be signed.

  Returns Promise<SigResponse>

  • A Promise that resolves with the signature of the provided data.

  Throws

  • Throws an error if pkpPubKey is not provided, if controllerAuthSig or controllerSessionSigs is not provided, if controllerSessionSigs is not an object, or if an error occurs during the signing process.

StaticcreateInstance

• createInstance(pkpBaseProp): PKPBase<PKPBaseDefaultParams>

• Creates a new instance of the PKPBase class with the provided properties.

  Parameters

  • pkpBaseProp: PKPBaseProp

    The properties for the PKPBase instance.

  Returns PKPBase<PKPBaseDefaultParams>

  • A new instance of the PKPBase class.