Class PKPBase<T>

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

Type Parameters

Hierarchy

Constructors

constructor

Properties

PREFIX compressedPubKey compressedPubKeyBuffer controllerAuthMethods? controllerAuthSig? controllerSessionSigs? debug litActionCode? litActionIPFS? litActionJsParams litNodeClient litNodeClientReady orange red reset rpcs? sessionSigsExpiration? uncompressedPubKey uncompressedPubKeyBuffer useAction

Methods

createAndSetSessionSigs ensureLitNodeClientReady getAddress init log runLitAction runSign setCompressedPubKeyAndBuffer setLitAction setLitActionJsParams setUncompressPubKeyAndBuffer throwError

Constructors

constructor

Properties

Private PREFIX

PREFIX: string = '[PKPBase]'

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

createAndSetSessionSigs

ensureLitNodeClientReady

  • 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>

getAddress

  • Base method to be overridden by subclasses.

    Returns

    • Address associated with concrete type of PKPBase

    Returns Promise<string>

init

log

  • 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

runLitAction

  • 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>

runSign

setCompressedPubKeyAndBuffer

setLitAction

  • 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

setLitActionJsParams

  • A function that sets the value of the litActionJsParams property to the given params object.

    Returns

    Member Of

    SomeClass

    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

setUncompressPubKeyAndBuffer

throwError

  • 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

Settings

Member Visibility

Theme

Generated using TypeDoc