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
Constructors#
constructor#
+ new WalletFromEthers(privateKey: string, mnemonic?: string): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:46
Parameters:#
| Name | Type |
|---|---|
privateKey | string |
mnemonic? | string |
Returns: WalletFromEthers
Properties#
address#
• Readonly address: string
Inherited from WalletFromEthers.address
Defined in node_modules/ethers/wallet.d.ts:14
mnemonic#
• Readonly mnemonic: string
Inherited from WalletFromEthers.mnemonic
Defined in node_modules/ethers/wallet.d.ts:15
path#
• Readonly path: string
Inherited from WalletFromEthers.path
Defined in node_modules/ethers/wallet.d.ts:16
privateKey#
• Readonly privateKey: string
Inherited from WalletFromEthers.privateKey
Defined in node_modules/ethers/wallet.d.ts:17
provider#
• Readonly provider: Provider
Inherited from WalletFromEthers.provider
Overrides void
Defined in node_modules/ethers/wallet.d.ts:11
Methods#
connect#
â–¸ connect(provider: Provider): Wallet
Inherited from WalletFromEthers.connect
Defined in node_modules/ethers/wallet.d.ts:21
Create a new instance of this Wallet connected to provider.
Parameters:#
| Name | Type |
|---|---|
provider | Provider |
Returns: Wallet
encrypt#
â–¸ encrypt(password: Arrayish | string, options?: any, progressCallback?: ProgressCallback): Promise<string>
Inherited from WalletFromEthers.encrypt
Defined in node_modules/ethers/wallet.d.ts:28
Parameters:#
| Name | Type |
|---|---|
password | Arrayish | string |
options? | any |
progressCallback? | ProgressCallback |
Returns: Promise<string>
getAddress#
â–¸ getAddress(): Promise<string>
Inherited from WalletFromEthers.getAddress
Overrides void
Defined in node_modules/ethers/wallet.d.ts:22
Returns: Promise<string>
getBalance#
â–¸ getBalance(blockTag?: BlockTag): Promise<BigNumber>
Inherited from WalletFromEthers.getBalance
Defined in node_modules/ethers/wallet.d.ts:25
Parameters:#
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns: Promise<BigNumber>
getTransactionCount#
â–¸ getTransactionCount(blockTag?: BlockTag): Promise<number>
Inherited from WalletFromEthers.getTransactionCount
Defined in node_modules/ethers/wallet.d.ts:26
Parameters:#
| Name | Type |
|---|---|
blockTag? | BlockTag |
Returns: Promise<number>
sendTransaction#
â–¸ sendTransaction(transaction: TransactionRequest): Promise<TransactionResponse>
Inherited from WalletFromEthers.sendTransaction
Overrides void
Defined in node_modules/ethers/wallet.d.ts:27
Parameters:#
| Name | Type |
|---|---|
transaction | TransactionRequest |
Returns: Promise<TransactionResponse>
sign#
â–¸ sign(transaction: TransactionRequest): Promise<string>
Inherited from WalletFromEthers.sign
Defined in node_modules/ethers/wallet.d.ts:23
Parameters:#
| Name | Type |
|---|---|
transaction | TransactionRequest |
Returns: Promise<string>
signMessage#
â–¸ signMessage(message: Arrayish | string): Promise<string>
Inherited from WalletFromEthers.signMessage
Overrides void
Defined in node_modules/ethers/wallet.d.ts:24
Parameters:#
| Name | Type |
|---|---|
message | Arrayish | string |
Returns: Promise<string>
toEthersWalletData#
â–¸ toEthersWalletData(): EthersWalletData
Defined in src/wallets/WalletFromEthers.ts:57
Returns: EthersWalletData
toIdentityWalletData#
â–¸ toIdentityWalletData(identityAddress: string): IdentityWalletData
Defined in src/wallets/WalletFromEthers.ts:71
Parameters:#
| Name | Type |
|---|---|
identityAddress | string |
Returns: IdentityWalletData
createRandom#
â–¸ StaticcreateRandom(): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:25
Returns: WalletFromEthers
fromEncryptedJson#
â–¸ StaticfromEncryptedJson(encryptedJson: string, password: string, progressCallback?: (progress: number) => any): Promise<WalletFromEthers>
Overrides void
Defined in src/wallets/WalletFromEthers.ts:30
Parameters:#
| Name | Type |
|---|---|
encryptedJson | string |
password | string |
progressCallback? | (progress: number) => any |
Returns: Promise<WalletFromEthers>
fromMnemonic#
â–¸ StaticfromMnemonic(mnemonic: string): WalletFromEthers
Overrides void
Defined in src/wallets/WalletFromEthers.ts:43
Parameters:#
| Name | Type |
|---|---|
mnemonic | string |
Returns: WalletFromEthers
fromWalletData#
â–¸ StaticfromWalletData(walletData: EthersWalletData | IdentityWalletData): WalletFromEthers
Defined in src/wallets/WalletFromEthers.ts:17
Parameters:#
| Name | Type |
|---|---|
walletData | EthersWalletData | IdentityWalletData |
Returns: WalletFromEthers
isSigner#
â–¸ StaticisSigner(value: any): value is Signer
Inherited from WalletFromEthers.isSigner
Defined in node_modules/ethers/abstract-signer.d.ts:10
Parameters:#
| Name | Type |
|---|---|
value | any |
Returns: value is Signer