Class ProviderInternalHDWallet

Provider internal Base wallet class.

This is the most basic wallet implementation we can have:

This wallet is generated by a list of private keys

Hierarchy (view full)

ProviderInternalBaseWallet
- ProviderInternalHDWallet

Index

Constructors

constructor

new ProviderInternalHDWallet(mnemonic, count?, initialIndex?, derivationPath?, options?): ProviderInternalHDWallet
Create a new HD wallet.
Parameters
- mnemonic: string[]
  Mnemonic of the wallet as an array of words.
- count: number = 1
  Number of accounts to generate.
- initialIndex: number = 0
  Initial index of the accounts to generate.
- derivationPath: string = HDKey.VET_DERIVATION_PATH
  Derivation path of the wallet.
- Optionaloptions: {
  gasPayer?: SignTransactionOptions;
  }
  Options for signing a transaction with gasPayer.
  - OptionalgasPayer?: SignTransactionOptions
Returns ProviderInternalHDWallet
Overrides ProviderInternalBaseWallet.constructor
- Defined in provider/helpers/provider-internal-wallets/hd-wallet/provider-internal-hd-wallet.ts:35

Properties

`Readonly`accounts

accounts: ProviderInternalWalletAccount[]

List of accounts in the wallet.

`Readonly`count

count: number

Number of accounts to generate.

`Readonly`derivationPath

derivationPath: string

Derivation path of the wallet.

`Optional` `Readonly`gasPayer

gasPayer?: SignTransactionOptions

Options for signing a transaction with gasPayer.

`Readonly`initialIndex

initialIndex: number

Initial index of the accounts to generate.

`Readonly`mnemonic

mnemonic: string[]

Mnemonic of the wallet.

Methods

getAccount

getAccount(addressOrIndex?): Promise<ProviderInternalWalletAccount>
Get an account given an address or an index.
Parameters
- OptionaladdressOrIndex: string | number
  Address or index of the account.
Returns Promise<ProviderInternalWalletAccount>
The account with the given address, or null if not found.
Inherited from ProviderInternalBaseWallet.getAccount
- Defined in provider/helpers/provider-internal-wallets/base-wallet/provider-internal-base-wallet.ts:48

getAccountSync

getAccountSync(addressOrIndex?): ProviderInternalWalletAccount
SYNC Version of getAccount()

Get an account given an address or an index.
Parameters
- OptionaladdressOrIndex: string | number
  Address or index of the account.
Returns ProviderInternalWalletAccount
The account with the given address, or null if not found.

Throws
Inherited from ProviderInternalBaseWallet.getAccountSync
- Defined in provider/helpers/provider-internal-wallets/abstract-wallet/abstract-provider-internal-wallet.ts:128

getAddresses

getAddresses(): Promise<string[]>
Get the list of addresses in the wallet.

Returns Promise<string[]>
The list of addresses in the wallet.
Inherited from ProviderInternalBaseWallet.getAddresses
- Defined in provider/helpers/provider-internal-wallets/base-wallet/provider-internal-base-wallet.ts:38

getAddressesSync

getAddressesSync(): string[]
SYNC Version of getAddresses()

Get the list of addresses in the wallet.

Returns string[]
The list of addresses in the wallet.
Inherited from ProviderInternalBaseWallet.getAddressesSync
- Defined in provider/helpers/provider-internal-wallets/abstract-wallet/abstract-provider-internal-wallet.ts:105

getGasPayer

getGasPayer(): Promise<SignTransactionOptions>
Get the options for signing a transaction with gasPayer (if any).

Returns Promise<SignTransactionOptions>
The options for signing a transaction with gasPayer.
Inherited from ProviderInternalBaseWallet.getGasPayer
- Defined in provider/helpers/provider-internal-wallets/base-wallet/provider-internal-base-wallet.ts:59

getGasPayerSync

getGasPayerSync(): SignTransactionOptions
SYNC Version of getGasPayer()

Get the options for signing a transaction with gasPayer (if any).

Returns SignTransactionOptions
The options for signing a transaction with gasPayer.
Inherited from ProviderInternalBaseWallet.getGasPayerSync
- Defined in provider/helpers/provider-internal-wallets/abstract-wallet/abstract-provider-internal-wallet.ts:170

getSigner

getSigner(parentProvider, addressOrIndex?): Promise<VeChainSigner>
Get a signer into the internal wallet provider for the given address.
Parameters
- parentProvider: AvailableVeChainProviders
  The parent provider of the Internal Wallet.
- OptionaladdressOrIndex: string | number
  Address of the account.
Returns Promise<VeChainSigner>
The signer for the given address.
Inherited from ProviderInternalBaseWallet.getSigner
- Defined in provider/helpers/provider-internal-wallets/base-wallet/provider-internal-base-wallet.ts:24

getSignerSync

getSignerSync(parentProvider, addressOrIndex?): VeChainSigner
SYNC Version of getSigner()

Get a signer into the internal wallet provider for the given address.
Parameters
- parentProvider: AvailableVeChainProviders
  The parent provider of the Internal Wallet.
- OptionaladdressOrIndex: string | number
  Address or index of the account.
Returns VeChainSigner
The signer for the given address.
Inherited from ProviderInternalBaseWallet.getSignerSync
- Defined in provider/helpers/provider-internal-wallets/abstract-wallet/abstract-provider-internal-wallet.ts:72

Class ProviderInternalHDWallet

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

OptionalgasPayer?: SignTransactionOptions

Returns ProviderInternalHDWallet

Properties

Readonlyaccounts

Readonlycount

ReadonlyderivationPath

Optional ReadonlygasPayer

ReadonlyinitialIndex

Readonlymnemonic

Methods

getAccount

Parameters

Returns Promise<ProviderInternalWalletAccount>

getAccountSync

Parameters

Returns ProviderInternalWalletAccount

Throws

getAddresses

Returns Promise<string[]>

getAddressesSync

Returns string[]

getGasPayer

Returns Promise<SignTransactionOptions>

getGasPayerSync

Returns SignTransactionOptions

getSigner

Parameters

Returns Promise<VeChainSigner>

getSignerSync

Parameters

Returns VeChainSigner

Settings

On This Page

`Optional`gasPayer?: SignTransactionOptions

`Readonly`accounts

`Readonly`count

`Readonly`derivationPath

`Optional` `Readonly`gasPayer

`Readonly`initialIndex

`Readonly`mnemonic