Class Wallet

Hierarchy

Signer
- Wallet

Implements

ExternallyOwnedAccount
TypedDataSigner

Index

Constructors

Properties

_mnemonic _signingKey address provider

Accessors

mnemonic privateKey publicKey

Methods

_signTypedData connect encrypt getAddress signMessage signTransaction createRandom fromEncryptedJson fromEncryptedJsonSync fromMnemonic

Constructors

constructor

new Wallet(privateKey: BytesLike | ExternallyOwnedAccount | SigningKey, provider?: Provider): Wallet
Parameters
- privateKey: BytesLike | ExternallyOwnedAccount | SigningKey
- Optional provider: Provider
Returns Wallet
Overrides Signer.constructor
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:13

Properties

`Readonly` _mnemonic

_mnemonic: (() => Mnemonic)

Type declaration

- (): Mnemonic
- Returns Mnemonic

`Readonly` _signingKey

_signingKey: (() => SigningKey)

Type declaration

- (): SigningKey
- Returns SigningKey

`Readonly` address

address: string

`Readonly` provider

provider: Provider

Accessors

mnemonic

get mnemonic(): Mnemonic
Returns Mnemonic
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:14

privateKey

get privateKey(): string
Returns string
Implementation of ExternallyOwnedAccount.privateKey
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:15

publicKey

get publicKey(): string
Returns string
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:16

Methods

_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 node_modules/@ethersproject/wallet/lib/index.d.ts:21

connect

connect(provider: Provider): Wallet
Parameters
- provider: Provider
Returns Wallet
Inherited from Signer.connect
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:18

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 node_modules/@ethersproject/wallet/lib/index.d.ts:22

getAddress

getAddress(): Promise<string>
Returns Promise<string>
Inherited from Signer.getAddress
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:17

signMessage

signMessage(message: string | Bytes): Promise<string>
Parameters
- message: string | Bytes
Returns Promise<string>
Inherited from Signer.signMessage
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:20

signTransaction

signTransaction(transaction: TransactionRequest): Promise<string>
Parameters
- transaction: TransactionRequest
Returns Promise<string>
Inherited from Signer.signTransaction
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:19

`Static` createRandom

createRandom(options?: any): Wallet
Static methods to create Wallet instances.
Parameters
- Optional options: any
Returns Wallet
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:26

`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 node_modules/@ethersproject/wallet/lib/index.d.ts:27

`Static` fromEncryptedJsonSync

fromEncryptedJsonSync(json: string, password: string | Bytes): Wallet
Parameters
- json: string
- password: string | Bytes
Returns Wallet
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:28

`Static` fromMnemonic

fromMnemonic(mnemonic: string, path?: string, wordlist?: Wordlist): Wallet
Parameters
- mnemonic: string
- Optional path: string
- Optional wordlist: Wordlist
Returns Wallet
- Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:29

Generated using TypeDoc