Class PKPEthersWallet

constructor

• new PKPEthersWallet(prop): PKPEthersWallet

• Parameters

  • prop: PKPEthersWalletProp

  Returns PKPEthersWallet

Readonly_isSigner

Readonlyaddress

OptionalchainId

OptionalmanualGasLimit

OptionalmanualGasPrice

Optionalnonce

provider

rpcProvider

litNodeClientReady

• get litNodeClientReady(): boolean

• Returns boolean

mnemonic

• get mnemonic(): never

• Returns never

privateKey

• get privateKey(): never

• Returns never

publicKey

• get publicKey(): string

• Returns string

_checkProvider

• _checkProvider(): void

• Returns void

_signTypedData

• _signTypedData(domain, types, value): Promise<string>

• Parameters

  • domain: TypedDataDomain
  • types: Record<string, TypedDataField[]>
  • value: Record<string, any>

  Returns Promise<string>

call

• call(transaction, blockTag?): Promise<string>

• Parameters

  • transaction: Deferrable<TransactionRequest>
  • blockTag: BlockTag | Promise<BlockTag> = 'latest'

  Returns Promise<string>

checkTransaction

• checkTransaction(): never

• Returns never

connect

• connect(): never

• Returns never

encrypt

• encrypt(password, options?, progressCallback?): Promise<string>

• Parameters

  • password: string | Bytes
  • Optionaloptions: ProgressCallback | EncryptOptions
  • OptionalprogressCallback: ProgressCallback

  Returns Promise<string>

estimateGas

• estimateGas(transaction): Promise<BigNumber>

• Parameters

  • transaction: Deferrable<TransactionRequest>

  Returns Promise<BigNumber>

getAddress

• getAddress(): Promise<string>

• Returns Promise<string>

getBalance

• getBalance(blockTag?): Promise<BigNumber>

• Parameters

  • OptionalblockTag: BlockTag

  Returns Promise<BigNumber>

getChainId

• getChainId(): Promise<number>

• Returns Promise<number>

getFeeData

• getFeeData(): Promise<FeeData>

• Returns Promise<FeeData>

getGasPrice

• getGasPrice(): Promise<BigNumber>

• Returns Promise<BigNumber>

getRpc

• getRpc(): string

• Returns string

getTransactionCount

• getTransactionCount(blockTag?): Promise<number>

• Parameters

  • OptionalblockTag: BlockTag

  Returns Promise<number>

handleRequest

• handleRequest<T>(payload): Promise<T>

• Type Parameters

  • T = string | Transaction

  Parameters

  • payload: ETHRequestSigningPayload

  Returns Promise<T>

init

• init(): Promise<void>

• Initializes the PKPEthersWallet instance and its dependencies

  Returns Promise<void>

populateTransaction

• populateTransaction(): never

• Returns never

request

• request<T>(payload): Promise<T>

• Type Parameters

  • T = string | Transaction

  Parameters

  • payload: ETHRequestSigningPayload

  Returns Promise<T>

resetManualSettings

• resetManualSettings(): void

• Returns void

resolveName

• resolveName(): never

• Returns never

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.

sendTransaction

• sendTransaction(transaction): Promise<any>

• Parameters

  • transaction: any

  Returns Promise<any>

setChainId

• setChainId(chainId): void

• Parameters

  • chainId: number

  Returns void

setGasLimit

• setGasLimit(gasLimit): void

• Parameters

  • gasLimit: string

  Returns void

setGasPrice

• setGasPrice(gasPrice): void

• Parameters

  • gasPrice: string

  Returns void

setNonce

• setNonce(nonce): void

• Parameters

  • nonce: string

  Returns void

setRpc

• setRpc(rpc): Promise<void>

• Parameters

  • rpc: string

  Returns Promise<void>

signMessage

• signMessage(message): Promise<string>

• Parameters

  • message: string | Bytes

  Returns Promise<string>

signTransaction

• signTransaction(transaction): Promise<string>

• Parameters

  • transaction: TransactionRequest

  Returns Promise<string>

StaticcreateRandom

• createRandom(options?): Wallet

• Static methods to create Wallet instances.

  Parameters

  • Optionaloptions: {
        extraEntropy?: Uint8Array;
        locale?: Wordlist;
        path?: string;
    }

    • OptionalextraEntropy?: Uint8Array

    • Optionallocale?: Wordlist

    • Optionalpath?: string

  Returns Wallet

StaticfromEncryptedJson

• fromEncryptedJson(json, password, progressCallback?): Promise<Wallet>

• Parameters

  • json: string
  • password: string | Bytes
  • OptionalprogressCallback: ProgressCallback

  Returns Promise<Wallet>

StaticfromEncryptedJsonSync

• fromEncryptedJsonSync(json, password): Wallet

• Parameters

  • json: string
  • password: string | Bytes

  Returns Wallet

StaticfromMnemonic

• fromMnemonic(mnemonic, path?, wordlist?): Wallet

• Parameters

  • mnemonic: string
  • Optionalpath: string
  • Optionalwordlist: Wordlist

  Returns Wallet