Class PKPBase<T>

A base class that can be shared between Ethers and Cosmos signers.

Type Parameters

T = PKPBaseDefaultParams

Hierarchy

PKPBase

Constructors

constructor

new PKPBase<T>(prop: PKPBaseProp): PKPBase<T>
Constructor for the PKPBase class. Initializes the instance with the provided properties.
Type Parameters
- T = PKPBaseDefaultParams
Parameters
- prop: PKPBaseProp
  
  The properties for the PKPBase instance.
Returns PKPBase<T>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:83

Properties

`Private` PREFIX

PREFIX: string = '[PKPBase]'

`Optional` authContext

authContext?: AuthenticationProps

compressedPubKey

compressedPubKey: string

compressedPubKeyBuffer

compressedPubKeyBuffer: Uint8Array

`Optional` controllerAuthMethods

controllerAuthMethods?: AuthMethod[]

`Optional` controllerAuthSig

controllerAuthSig?: AuthSig

`Optional` controllerSessionSigs

controllerSessionSigs?: SessionSigs

debug

debug: boolean

`Optional` litActionCode

litActionCode?: string

`Optional` litActionIPFS

litActionIPFS?: string

litActionJsParams

litActionJsParams: T

litNodeClient

litNodeClient: LitNodeClient

litNodeClientReady

litNodeClientReady: boolean = false

`Private` orange

orange: string = '\x1b[33m'

`Private` red

red: string = '\x1b[31m'

`Private` reset

reset: string = '\x1b[0m'

`Optional` rpcs

rpcs?: RPCUrls

`Optional` sessionSigsExpiration

sessionSigsExpiration?: string

uncompressedPubKey

uncompressedPubKey: string

uncompressedPubKeyBuffer

uncompressedPubKeyBuffer: Uint8Array

useAction

useAction: boolean

Methods

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
- A Promise that resolves when the LitNode client is ready for use.
Returns Promise<void>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:409

getAddress

getAddress(): Promise<string>
Base method to be overridden by subclasses.

Returns
- Address associated with concrete type of PKPBase
Returns Promise<string>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:190

init

init(): Promise<void>
Initializes the PKPBase instance by connecting to the LIT node.

Returns Promise<void>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:201

log

log(...args: any[]): void
Logs the provided arguments to the console, but only if debugging is enabled.

Returns
- This function does not return a value.
Parameters
- Rest ...args: any[]
  
  The values to be logged to the console.
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:422

runLitAction

runLitAction(toSign: Uint8Array, sigName: string): Promise<any>
Runs the specified Lit action with the given parameters.

Returns
- 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.
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>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:268

runSign

runSign(toSign: Uint8Array): Promise<any>
Sign the provided data with the PKP private key.

Returns
- 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.
Parameters
- toSign: Uint8Array
  
  The data to be signed.
Returns Promise<any>
- Defined in packages/pkp-base/src/lib/pkp-base.ts:351

setCompressedPubKeyAndBuffer

setCompressedPubKeyAndBuffer(prop: PKPBaseProp): void
Sets the compressed public key and its buffer representation.
Parameters
- prop: PKPBaseProp
  
  The properties for the PKPBase instance.
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:138

setLitAction

setLitAction(prop: PKPBaseProp): void
Sets the Lit action to be executed by the LitNode client.

Returns
- If both litActionCode and litActionIPFS are present, throws an Error. Otherwise, does not return a value.
Parameters
- prop: PKPBaseProp
  
  An object containing the parameters for the Lit action.
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:155

setLitActionJsParams

setLitActionJsParams<CustomType>(params: CustomType): void
A function that sets the value of the litActionJsParams property to the given params object.

Returns
Type Parameters
- CustomType = T
  
  A generic type that extends T, where T is the type of the litActionJsParams property.
Parameters
- params: CustomType
  
  An object of type CustomType that contains the parameters to be set as litActionJsParams.
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:181

setUncompressPubKeyAndBuffer

setUncompressPubKeyAndBuffer(prop: PKPBaseProp): void
Sets the uncompressed public key and its buffer representation.
Parameters
- prop: PKPBaseProp
  
  The properties for the PKPBase instance.
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:122

throwError

throwError(message: string): never
Logs an error message to the console and throws an Error with the same message.

Returns
- This function does not return a value since it always throws an Error.
Parameters
- message: string
  
  The error message to be logged and thrown.
Returns never
- Defined in packages/pkp-base/src/lib/pkp-base.ts:435

`Private` validateAuthContext

validateAuthContext(): void
Returns void
- Defined in packages/pkp-base/src/lib/pkp-base.ts:211

Class PKPBase<T>

Type Parameters

T = PKPBaseDefaultParams

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

T = PKPBaseDefaultParams

Parameters

prop: PKPBaseProp

Returns PKPBase<T>

Properties

Private PREFIX

Optional authContext

compressedPubKey

compressedPubKeyBuffer

Optional controllerAuthMethods

Optional controllerAuthSig

Optional controllerSessionSigs

debug

Optional litActionCode

Optional litActionIPFS

litActionJsParams

litNodeClient

litNodeClientReady

Private orange

Private red

Private reset

Optional rpcs

Optional sessionSigsExpiration

uncompressedPubKey

uncompressedPubKeyBuffer

useAction

Methods

ensureLitNodeClientReady

Returns

Returns Promise<void>

getAddress

Returns

Returns Promise<string>

init

Returns Promise<void>

log

Returns

Parameters

Rest ...args: any[]

Returns void

runLitAction

Returns

Throws

Parameters

toSign: Uint8Array

sigName: string

Returns Promise<any>

runSign

Returns

Throws

Parameters

toSign: Uint8Array

Returns Promise<any>

setCompressedPubKeyAndBuffer

Parameters

prop: PKPBaseProp

Returns void

setLitAction

Returns

Parameters

prop: PKPBaseProp

Returns void

setLitActionJsParams

Returns

Type Parameters

CustomType = T

Parameters

params: CustomType

Returns void

`Private` PREFIX

`Optional` authContext

`Optional` controllerAuthMethods

`Optional` controllerAuthSig

`Optional` controllerSessionSigs

`Optional` litActionCode

`Optional` litActionIPFS

`Private` orange

`Private` red

`Private` reset

`Optional` rpcs

`Optional` sessionSigsExpiration

`Rest` ...args: any[]

`Private` validateAuthContext