Class Metamask

constructor

• new Metamask(
      extensions: Extension[],
      context: BrowserContext,
      isFlask?: boolean,
      debug?: boolean,
  ): Metamask

• Parameters

  • extensions: Extension[]
  • context: BrowserContext
  • OptionalisFlask: boolean = false
  • Optionaldebug: boolean = false

  Returns Metamask

context

extension

extraExtensions

isFlask

page

getSnaps

• getSnaps(page: Page): Promise<InstallSnapsResult>

• Get snaps

  Parameters

  • page: Page

    Page to run getSnaps

  Returns Promise<InstallSnapsResult>

getVersion

• getVersion(page: Page): Promise<any>

• Get version

  Parameters

  • page: Page

    Page to run getVersion

  Returns Promise<any>

goBack

• goBack(): Promise<Page>

• Returns Promise<Page>

goToHomepage

• goToHomepage(snapId: string): Promise<Page>

• Go to the snaps homepage

  Parameters

  • snapId: string

    Snap ID to select snap. ie. 'npm:filsnap', 'local:http://localhost:8080'

  Returns Promise<Page>

installSnap

• installSnap(options: InstallSnapOptions): Promise<InstallSnapsResult>

• Install a snap

  Parameters

  • options: InstallSnapOptions

  Returns Promise<InstallSnapsResult>

invokeSnap

• invokeSnap<R>(opts: InvokeSnapOptions): Promise<R>

• Invoke Snap

  Type Parameters

  • R

  Parameters

  • opts: InvokeSnapOptions

  Returns Promise<R>

setup

• setup(options?: SetupOptions): Promise<Metamask>

• Setup Metamask with a mnemonic and password

  Parameters

  • options: SetupOptions = {}

  Returns Promise<Metamask>

teardown

• teardown(): void

• Returns void

waitForConfirmation

• waitForConfirmation(confirm?: boolean): Promise<void>

• Wait for metamask confirmation dialog to appear and confirm or cancel

  Parameters

  • Optionalconfirm: boolean = true

  Returns Promise<void>

waitForDialog

• waitForDialog(name: string | RegExp | (url: URL) => boolean): Promise<Page>

• Wait for a dialog

  Parameters

  • name: string | RegExp | (url: URL) => boolean

    A glob pattern, regex pattern or predicate receiving [URL] to match while waiting for the navigation. Note that if the parameter is a string without wildcard characters, the method will wait for navigation to URL that is exactly equal to the string.

  Returns Promise<Page>