Class: WalletFromEthers
"wallets/WalletFromEthers".WalletFromEthers
This is a wrapper class for ethers.Wallet. It allows us to customize some of the methods provided by
ethers.Wallet. We also use this to add some conversion methods adapted to our internal types.
Hierarchy#
Wallet
↳ WalletFromEthers
Implements#
- ExternallyOwnedAccount
- TypedDataSigner
Constructors#
constructor#
+ new WalletFromEthers(privateKey: string, mnemonic?: string): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:53
Parameters:#
| Name | Type |
|---|---|
privateKey | string |
mnemonic? | string |
Returns: WalletFromEthers
Properties#
_isSigner#
• Readonly _isSigner: boolean
Inherited from WalletFromEthers._isSigner
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:29
_mnemonic#
• Readonly _mnemonic: () => Mnemonic
Inherited from WalletFromEthers._mnemonic
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:12
_signingKey#
• Readonly _signingKey: () => SigningKey
Inherited from WalletFromEthers._signingKey
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:11
address#
• Readonly address: string
Inherited from WalletFromEthers.address
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:9
provider#
• Readonly provider: Provider
Inherited from WalletFromEthers.provider
Overrides void
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:10
Accessors#
mnemonic#
• get mnemonic(): Mnemonic
Inherited from WalletFromEthers.mnemonic
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:14
Returns: Mnemonic
privateKey#
• get privateKey(): string
Inherited from WalletFromEthers.privateKey
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:15
Returns: string
publicKey#
• get publicKey(): string
Inherited from WalletFromEthers.publicKey
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:16
Returns: string
Methods#
_checkProvider#
â–¸ _checkProvider(operation?: string): void
Inherited from WalletFromEthers._checkProvider
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:42
Parameters:#
| Name | Type |
|---|---|
operation? | string |
Returns: void
_signTypedData#
â–¸ _signTypedData(domain: TypedDataDomain, types: Record<string, Array<TypedDataField>>, value: Record<string, any>): Promise<string>
Inherited from WalletFromEthers._signTypedData
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:21
Parameters:#
| Name | Type |
|---|---|
domain | TypedDataDomain |
types | Record<string, Array<TypedDataField>> |
value | Record<string, any> |
Returns: Promise<string>
call#
â–¸ call(transaction: Deferrable<TransactionRequest>, blockTag?: BlockTag): Promise<string>
Inherited from WalletFromEthers.call
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:34
Parameters:#
| Name | Type |
|---|---|
transaction | Deferrable<TransactionRequest> |
blockTag? | BlockTag |
Returns: Promise<string>
checkTransaction#
â–¸ checkTransaction(transaction: Deferrable<TransactionRequest>): Deferrable<TransactionRequest>
Inherited from WalletFromEthers.checkTransaction
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:40
Parameters:#
| Name | Type |
|---|---|
transaction | Deferrable<TransactionRequest> |
Returns: Deferrable<TransactionRequest>
connect#
â–¸ connect(provider: Provider): Wallet
Inherited from WalletFromEthers.connect
Overrides void
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:18
Parameters:#
| Name | Type |
|---|---|
provider | Provider |
Returns: Wallet
encrypt#
â–¸ encrypt(password: Bytes | string, options?: any, progressCallback?: ProgressCallback): Promise<string>
Inherited from WalletFromEthers.encrypt
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:22
Parameters:#
| Name | Type |
|---|---|
password | Bytes | string |
options? | any |
progressCallback? | ProgressCallback |
Returns: Promise<string>
estimateGas#
â–¸ estimateGas(transaction: Deferrable<TransactionRequest>): Promise<BigNumber>
Inherited from WalletFromEthers.estimateGas
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:33
Parameters:#
| Name | Type |
|---|---|
transaction | Deferrable<TransactionRequest> |
Returns: Promise<BigNumber>
getAddress#
â–¸ getAddress(): Promise<string>
Inherited from WalletFromEthers.getAddress
Overrides void
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:17
Returns: Promise<string>
getBalance#
â–¸ getBalance(blockTag?: BlockTag): Promise<BigNumber>
Inherited from WalletFromEthers.getBalance
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:31
Parameters:#
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns: Promise<BigNumber>
getChainId#
â–¸ getChainId(): Promise<number>
Inherited from WalletFromEthers.getChainId
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:36
Returns: Promise<number>
getFeeData#
â–¸ getFeeData(): Promise<FeeData>
Inherited from WalletFromEthers.getFeeData
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:38
Returns: Promise<FeeData>
getGasPrice#
â–¸ getGasPrice(): Promise<BigNumber>
Inherited from WalletFromEthers.getGasPrice
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:37
Returns: Promise<BigNumber>
getTransactionCount#
â–¸ getTransactionCount(blockTag?: BlockTag): Promise<number>
Inherited from WalletFromEthers.getTransactionCount
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:32
Parameters:#
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns: Promise<number>
populateTransaction#
â–¸ populateTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionRequest>
Inherited from WalletFromEthers.populateTransaction
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:41
Parameters:#
| Name | Type |
|---|---|
transaction | Deferrable<TransactionRequest> |
Returns: Promise<TransactionRequest>
resolveName#
â–¸ resolveName(name: string): Promise<string>
Inherited from WalletFromEthers.resolveName
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:39
Parameters:#
| Name | Type |
|---|---|
name | string |
Returns: Promise<string>
sendTransaction#
â–¸ sendTransaction(transaction: Deferrable<TransactionRequest>): Promise<TransactionResponse>
Inherited from WalletFromEthers.sendTransaction
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:35
Parameters:#
| Name | Type |
|---|---|
transaction | Deferrable<TransactionRequest> |
Returns: Promise<TransactionResponse>
signMessage#
â–¸ signMessage(message: Bytes | string): Promise<string>
Inherited from WalletFromEthers.signMessage
Overrides void
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:20
Parameters:#
| Name | Type |
|---|---|
message | Bytes | string |
Returns: Promise<string>
signTransaction#
â–¸ signTransaction(transaction: TransactionRequest): Promise<string>
Inherited from WalletFromEthers.signTransaction
Overrides void
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:19
Parameters:#
| Name | Type |
|---|---|
transaction | TransactionRequest |
Returns: Promise<string>
toEthersWalletData#
â–¸ toEthersWalletData(): EthersWalletData
Defined in src/wallets/WalletFromEthers.ts:75
Returns: EthersWalletData
toIdentityWalletData#
â–¸ toIdentityWalletData(identityAddress: string): IdentityWalletData
Defined in src/wallets/WalletFromEthers.ts:89
Parameters:#
| Name | Type |
|---|---|
identityAddress | string |
Returns: IdentityWalletData
toSafeWalletData#
â–¸ toSafeWalletData(safeAddress: string): any
Defined in src/wallets/WalletFromEthers.ts:103
Parameters:#
| Name | Type |
|---|---|
safeAddress | string |
Returns: any
createRandom#
â–¸ StaticcreateRandom(): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:32
Returns: WalletFromEthers
fromEncryptedJson#
â–¸ StaticfromEncryptedJson(encryptedJson: string, password: string, progressCallback?: (progress: number) => any): Promise<WalletFromEthers>
Overrides void
Defined in src/wallets/WalletFromEthers.ts:37
Parameters:#
| Name | Type |
|---|---|
encryptedJson | string |
password | string |
progressCallback? | (progress: number) => any |
Returns: Promise<WalletFromEthers>
fromEncryptedJsonSync#
â–¸ StaticfromEncryptedJsonSync(json: string, password: Bytes | string): Wallet
Inherited from WalletFromEthers.fromEncryptedJsonSync
Defined in node_modules/@ethersproject/wallet/lib/index.d.ts:28
Parameters:#
| Name | Type |
|---|---|
json | string |
password | Bytes | string |
Returns: Wallet
fromMnemonic#
â–¸ StaticfromMnemonic(mnemonic: string): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:50
Parameters:#
| Name | Type |
|---|---|
mnemonic | string |
Returns: WalletFromEthers
fromWalletData#
â–¸ StaticfromWalletData(walletData: EthersWalletData | IdentityWalletData | SafeWalletData): WalletFromEthers
Defined in src/wallets/WalletFromEthers.ts:24
Parameters:#
| Name | Type |
|---|---|
walletData | EthersWalletData | IdentityWalletData | SafeWalletData |
Returns: WalletFromEthers
isSigner#
â–¸ StaticisSigner(value: any): value is Signer
Inherited from WalletFromEthers.isSigner
Defined in node_modules/@ethersproject/abstract-signer/lib/index.d.ts:43
Parameters:#
| Name | Type |
|---|---|
value | any |
Returns: value is Signer