Class PKPEthersWallet

Hierarchy

PKPEthersWallet

Implements

PKPWallet
Signer
ExternallyOwnedAccount
TypedDataSigner
PKPClientHelpers

Constructors

constructor

new PKPEthersWallet(prop: PKPEthersWalletProp): PKPEthersWallet
Parameters
- prop: PKPEthersWalletProp
Returns PKPEthersWallet
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:83

Properties

`Readonly` _isSigner

_isSigner: boolean

`Readonly` address

address: string

`Optional` chainId

chainId?: number

`Optional` manualGasLimit

manualGasLimit?: string

`Optional` manualGasPrice

manualGasPrice?: string

`Optional` nonce

nonce?: string

`Private` `Readonly` pkpBase

pkpBase: PKPBase<PKPBaseDefaultParams>

provider

provider: Provider

rpcProvider

rpcProvider: StaticJsonRpcProvider

Accessors

litNodeClientReady

get litNodeClientReady(): boolean
Returns boolean
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:79

mnemonic

get mnemonic(): any
Returns any
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:518

privateKey

get privateKey(): string
Returns string
Implementation of ExternallyOwnedAccount.privateKey
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:522

publicKey

get publicKey(): string
Returns string
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:159

Methods

_checkProvider

_checkProvider(): void
Returns void
Implementation of Signer._checkProvider
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:512

_signTypedData

_signTypedData(domain: TypedDataDomain, types: Record<string, TypedDataField[]>, value: Record<string, any>): Promise<string>
Parameters
- domain: TypedDataDomain
- types: Record<string, TypedDataField[]>
- value: Record<string, any>
Returns Promise<string>
Implementation of TypedDataSigner._signTypedData
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:291

call

call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>
Parameters
- transaction: Deferrable<TransactionRequest>
- Optional blockTag: BlockTag
Returns Promise<string>
Implementation of Signer.call
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:468

checkTransaction

checkTransaction(): Deferrable<TransactionRequest>
Returns Deferrable<TransactionRequest>
Implementation of Signer.checkTransaction
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:504

connect

connect(): never
Returns never
Implementation of Signer.connect
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:175

encrypt

encrypt(password: string | Bytes, options?: ProgressCallback | EncryptOptions, progressCallback?: ProgressCallback): Promise<string>
Parameters
- password: string | Bytes
- Optional options: ProgressCallback | EncryptOptions
- Optional progressCallback: ProgressCallback
Returns Promise<string>
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:345

estimateGas

estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>
Parameters
- transaction: Deferrable<TransactionRequest>
Returns Promise<BigNumber>
Implementation of Signer.estimateGas
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:462

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Implementation of Signer.getAddress
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:163

getBalance

getBalance(blockTag?: BlockTag): Promise<BigNumber>
Parameters
- Optional blockTag: BlockTag
Returns Promise<BigNumber>
Implementation of Signer.getBalance
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:450

getChainId

getChainId(): Promise<any>
Returns Promise<any>
Implementation of Signer.getChainId
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:489

getFeeData

getFeeData(): any
Returns any
Implementation of Signer.getFeeData
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:496

getGasPrice

getGasPrice(): any
Returns any
Implementation of Signer.getGasPrice
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:493

getRpc

getRpc(): string
Returns string
Implementation of PKPClientHelpers.getRpc
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:110

getTransactionCount

getTransactionCount(blockTag?: BlockTag): Promise<number>
Parameters
- Optional blockTag: BlockTag
Returns Promise<number>
Implementation of Signer.getTransactionCount
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:456

handleRequest

handleRequest<T>(payload: ETHRequestSigningPayload): Promise<T>
Type Parameters
- T = string | Transaction
Parameters
- payload: ETHRequestSigningPayload
Returns Promise<T>
Implementation of PKPClientHelpers.handleRequest
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:121

init

init(): Promise<void>
Initializes the PKPEthersWallet instance and its dependencies

Returns Promise<void>
Implementation of PKPWallet.init
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:171

populateTransaction

populateTransaction(): Promise<TransactionRequest>
Returns Promise<TransactionRequest>
Implementation of Signer.populateTransaction
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:508

request

request<T>(payload: ETHRequestSigningPayload): Promise<T>
Type Parameters
- T = string | Transaction
Parameters
- payload: ETHRequestSigningPayload
Returns Promise<T>
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:130

resetManualSettings

resetManualSettings(): void
Returns void
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:152

resolveName

resolveName(): Promise<string>
Returns Promise<string>
Implementation of Signer.resolveName
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:500

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>
Implementation of PKPWallet.runLitAction
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:538

runSign

runSign(toSign: Uint8Array): Promise<SigResponse>
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<SigResponse>
Implementation of PKPWallet.runSign
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:551

sendTransaction

sendTransaction(transaction: any): Promise<any>
Parameters
- transaction: any
Returns Promise<any>
Implementation of Signer.sendTransaction
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:371

setChainId

setChainId(chainId: number): void
Parameters
- chainId: number
Returns void
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:148

setGasLimit

setGasLimit(gasLimit: string): void
Parameters
- gasLimit: string
Returns void
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:140

setGasPrice

setGasPrice(gasPrice: string): void
Parameters
- gasPrice: string
Returns void
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:136

setNonce

setNonce(nonce: string): void
Parameters
- nonce: string
Returns void
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:144

setRpc

setRpc(rpc: string): Promise<void>
Parameters
- rpc: string
Returns Promise<void>
Implementation of PKPClientHelpers.setRpc
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:114

signMessage

signMessage(message: string | Bytes): Promise<string>
Parameters
- message: string | Bytes
Returns Promise<string>
Implementation of Signer.signMessage
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:270

signTransaction

signTransaction(transaction: TransactionRequest): Promise<string>
Parameters
- transaction: TransactionRequest
Returns Promise<string>
Implementation of Signer.signTransaction
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:179

`Static` createRandom

createRandom(options?: {
    extraEntropy?: Uint8Array;
    locale?: Wordlist;
    path?: string;
}): Wallet
Static methods to create Wallet instances.
Parameters
- Optional options: {
      extraEntropy?: Uint8Array;
      locale?: Wordlist;
      path?: string;
  }
  - Optional extraEntropy?: Uint8Array
  - Optional locale?: Wordlist
  - Optional path?: string
Returns Wallet
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:398

`Static` fromEncryptedJson

fromEncryptedJson(json: string, password: string | Bytes, progressCallback?: ProgressCallback): Promise<Wallet>
Parameters
- json: string
- password: string | Bytes
- Optional progressCallback: ProgressCallback
Returns Promise<Wallet>
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:419

`Static` fromEncryptedJsonSync

fromEncryptedJsonSync(json: string, password: string | Bytes): Wallet
Parameters
- json: string
- password: string | Bytes
Returns Wallet
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:431

`Static` fromMnemonic

fromMnemonic(mnemonic: string, path?: string, wordlist?: Wordlist): Wallet
Parameters
- mnemonic: string
- Optional path: string
- Optional wordlist: Wordlist
Returns Wallet
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:435

Class PKPEthersWallet

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

prop: PKPEthersWalletProp

Returns PKPEthersWallet

Properties

Readonly _isSigner

Readonly address

Optional chainId

Optional manualGasLimit

Optional manualGasPrice

Optional nonce

Private Readonly pkpBase

provider

rpcProvider

Accessors

litNodeClientReady

Returns boolean

mnemonic

Returns any

privateKey

Returns string

publicKey

Returns string

Methods

_checkProvider

Returns void

_signTypedData

Parameters

domain: TypedDataDomain

types: Record<string, TypedDataField[]>

value: Record<string, any>

Returns Promise<string>

call

Parameters

transaction: Deferrable<TransactionRequest>

Optional blockTag: BlockTag

Returns Promise<string>

checkTransaction

Returns Deferrable<TransactionRequest>

connect

Returns never

encrypt

Parameters

password: string | Bytes

Optional options: ProgressCallback | EncryptOptions

Optional progressCallback: ProgressCallback

Returns Promise<string>

estimateGas

Parameters

transaction: Deferrable<TransactionRequest>

Returns Promise<BigNumber>

getAddress

Returns Promise<string>

getBalance

Parameters

Optional blockTag: BlockTag

Returns Promise<BigNumber>

getChainId

Returns Promise<any>

getFeeData

Returns any

getGasPrice

Returns any

getRpc

Returns string

getTransactionCount

Parameters

Optional blockTag: BlockTag

Returns Promise<number>

handleRequest

Type Parameters

`Readonly` _isSigner

`Readonly` address

`Optional` chainId

`Optional` manualGasLimit

`Optional` manualGasPrice

`Optional` nonce

`Private` `Readonly` pkpBase

`Optional` blockTag: BlockTag

`Optional` options: ProgressCallback | EncryptOptions

`Optional` progressCallback: ProgressCallback

`Optional` blockTag: BlockTag

`Optional` blockTag: BlockTag

`Static` createRandom

`Optional` options: {
extraEntropy?: Uint8Array;
locale?: Wordlist;
path?: string;
}

`Optional` extraEntropy?: Uint8Array

`Optional` locale?: Wordlist

`Optional` path?: string