Mist API

June 29, 2018 ยท View on GitHub

Mist provides an API for dapp developers to use special features only available in Mist.

You can check for the mist object in your dapp:

if (typeof mist !== 'undefined') {
    ...
}

We recommend initializing your web3 library with our provider:

if (typeof web3 !== 'undefined') {
  web3 = new Web3(web3.currentProvider);
} else {
  web3 = new Web3('ws://localhost:8546');
}

API

mist.platform

Returns the current platform, mist is running on:

  • darwin (Mac OSX)
  • win32 (Windows)
  • linux (Linux)

mist.requestAccount(callback)

Asks the user to provide, or create a new account.

Parameters

  1. Function The callback to be called with the new address as the second parameter.

Example

mist.requestAccount(function(error, address) {
  console.log('Added new account', address);
});

mist.menu

Provides functionality to control the sub menu of your dapp, when its added to the sidebar.

mist.menu.add([id,] options, callback)

Adds/Updates a sub menu entry, which is placed below you dapp button in the sidebar.

Parameters

  1. String optional and id string to identify your sub menu entry when updating.
  2. Object The menu options:
    • name (String): The name of the sub menu button.
    • badge (String|null) optional: The badge text for the sub menu button, e.g. 50.
    • position (Number) optional: The position of the submenu button, 1 is on the top.
    • selected (Boolean) optional: Whether or not this sub menu entry is currently selected.
  3. Function optional: The callback to be called when the sub menu entry is clicked.

Minimal example

mist.menu.add({ name: 'My account' });

Full example

mist.menu.add(
  'tkrzU',
  {
    name: 'My Meny Entry',
    badge: 50,
    position: 1,
    selected: true
  },
  function() {
    // Redirect
    window.location = 'http://domain.com/send';
    // Using history pushstate
    history.pushState(null, null, '/my-entry');
    // In Meteor iron:router
    Router.go('/send');
  }
);

mist.menu.clear()

Removes all sub menu entries. You can use this when you reload your app, to clear up incorrect menu entries, which might have been lost since the last session.

Parameters

None

mist.menu.remove(id)

Removes a sub menu entry.

Parameters

  1. String and id string to identify your sub menu.

mist.menu.select(id)

Selects the respective sub menu entry.

Parameters

  1. String the sub menu entry identifier.

mist.menu.setBadge(text)

Sets the main badge of your dapp, right below your dapps menu button.

Parameters

  1. String the string used as the badge text.

mist.menu.update(id, [, options][, callback])

Works like mist.menu.add(), but only the id parameter is required.

Parameters

  1. String and id string to identify your sub menu entry.
  2. Object The menu options:
    • name (String): (optional) The name of the sub menu button.
    • badge (String|null): (optional) The badge text for the sub menu button, e.g. 50.
    • position (Number): (optional) The position of the submenu button, 1 is on the top.
    • selected (Boolean): (optional) Whether or not this sub menu entry is currently selected.
  3. Function (optional) The callback to be called when the sub menu entry is clicked.

Example

mist.menu.update('tkrzU', {
  badge: 50,
  position: 2
});

mist.sounds

Provides a list of sounds.

mist.sounds.bip()

Makes a bip sound.

Parameters

None

mist.sounds.bloop()

Makes a bloop sound.

Parameters

None

mist.sounds.invite()

Makes an invite sound.

Parameters

None