Class PKPEthersWallet

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

Hierarchy

PKPBase
- PKPEthersWallet

Implements

Signer
ExternallyOwnedAccount
TypedDataSigner
PKPClientHelpers

Constructors

constructor

new PKPEthersWallet(prop: PKPBaseProp): PKPEthersWallet
Parameters
- prop: PKPBaseProp
Returns PKPEthersWallet
Overrides PKPBase.constructor
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:72

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

provider

provider: Provider

rpcProvider

rpcProvider: JsonRpcProvider

Accessors

mnemonic

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

privateKey

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

publicKey

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

Methods

_checkProvider

_checkProvider(operation?: string): void
Parameters
- Optional operation: string
Returns void
Implementation of Signer._checkProvider
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:480

_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:263

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:431

checkTransaction

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

connect

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

encrypt

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

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:425

getAddress

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

Returns
- Address associated with concrete type of PKPBase
Returns Promise<string>
Implementation of Signer.getAddress

Inherited from PKPBase.getAddress
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:140

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:413

getChainId

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

getFeeData

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

getGasPrice

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

getRpc

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

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:419

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:98

populateTransaction

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

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:107

resetManualSettings

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

resolveName

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

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:339

setChainId

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

setGasLimit

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

setGasPrice

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

setNonce

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

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:94

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:241

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:149

`Static` createRandom

createRandom(options?: any): Wallet
Static methods to create Wallet instances.
Parameters
- Optional options: any
Returns Wallet
- Defined in packages/pkp-ethers/src/lib/pkp-ethers.ts:365

`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:382

`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:394

`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:398

Generated using TypeDoc