Class AccountMetamaskFactory

A factory class that generates instances of AccountMetamask.

Hierarchy (view full)

default
- AccountMetamaskFactory

Index

Constructors

Properties

Methods

discover ensureReady getSnapVersion initialize installSnap

Constructors

constructor

new AccountMetamaskFactory(provider?): AccountMetamaskFactory
Parameters
- Optionalprovider: BaseProvider
  Connection to MetaMask to use
Returns AccountMetamaskFactory
Overrides default.constructor
- Defined in account/MetamaskFactory.ts:32

Properties

`Readonly`provider

provider: BaseProvider

Methods

discover

discover(node): Promise<AccountBase[]>
Discovers accounts in set that already have been used (has any on-chain transactions). It returns an empty array if none of accounts been used. If a used account is preceded by an unused account then it would be ignored.
Parameters
- node: Node
  Instance of Node to get account information from
Returns Promise<AccountBase[]>
Inherited from default.discover
- Defined in account/BaseFactory.ts:20

ensureReady

ensureReady(): Promise<void>
It throws an exception if MetaMask or Aeternity snap has an incompatible version or is not installed.

Returns Promise<void>
- Defined in account/MetamaskFactory.ts:84

getSnapVersion

getSnapVersion(): Promise<string>
Returns Promise<string>
the version of snap installed in MetaMask
- Defined in account/MetamaskFactory.ts:100

initialize

initialize(accountIndex): Promise<AccountMetamask>
Get an instance of AccountMetaMask for a given account index.
Parameters
- accountIndex: number
  Index of account
Returns Promise<AccountMetamask>
Overrides default.initialize
- Defined in account/MetamaskFactory.ts:116

installSnap

installSnap(): Promise<SnapDetails>
Request MetaMask to install Aeternity snap.

Returns Promise<SnapDetails>
- Defined in account/MetamaskFactory.ts:70