Class AccountMetamaskFactory

A factory class that generates instances of AccountMetamask.

See

Hierarchy (View Summary)

default
- AccountMetamaskFactory

Index

Constructors

Accessors

Methods

discover ensureReady getSnapVersion initialize installSnap requestSnap

Constructors

constructor

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

Accessors

provider

get provider(): BaseProvider
Returns BaseProvider
Deprecated
this class is not intended to provide raw access to the provider
- Defined in account/MetamaskFactory.ts:36

Methods

discover

discover(node: 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:21

ensureReady

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

Returns Promise<void>
Deprecated
use requestSnap instead
- Defined in account/MetamaskFactory.ts:138

getSnapVersion

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

initialize

initialize(accountIndex: number): 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:166

installSnap

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

Returns Promise<SnapDetails>
Deprecated
use requestSnap instead
- Defined in account/MetamaskFactory.ts:105

requestSnap

requestSnap(version?: string): Promise<SnapDetails>
Request MetaMask to install Aeternity snap or connect it to the current aepp. MetaMask can have only one Aeternity snap version installed at a time. This method is intended to upgrade the snap to a specified version if needed by the aepp. If Aeternity snap is installed but wasn't used by the aepp, then the user still needs to approve the connection. If the currently installed version corresponds to the version range, then the snap won't be upgraded. To downgrade the snap, the user must manually uninstall the current version.
Parameters
- version: string = ...
  Snap version range (e.g. 1, 0.1.*, ^0.0.9, ~0.0.9; >=0.0.9 <0.1.0) (default: a version range supported by sdk)
Returns Promise<SnapDetails>
- Defined in account/MetamaskFactory.ts:124