Skip to content
This repository was archived by the owner on Nov 11, 2020. It is now read-only.

Latest commit

 

History

History
228 lines (144 loc) · 4.79 KB

MISTAPI.md

File metadata and controls

228 lines (144 loc) · 4.79 KB

Oystr API

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

Note for dapp developers

To make your dapp compatible with other browsers, it is recommended that you check the oystr object before you use it:

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

You have three different possibilities to use web3:

// 1. simply use it: web3 comes already defined
web3

// 2. optionally use web3 from Oystr or load if outside of Oystr
if(typeof web3 === 'undefined')
  web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));

// 3. always use web3 provided by the dapp ("Web3" won't be supplied by Oystr), but the provider from Oystr
if(typeof web3 !== 'undefined')
  web3 = new Web3(web3.currentProvider);
else
  web3 = new Web3(new Web3.providers.HttpProvider("http://localhost:8545"));

API

oystr.platform

Returns the current platform, oystr is running on:

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

oystr.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 param

Example

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

oystr.menu

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

oystr.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

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

Full example

oystr.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');
})

oystr.menu.clear()

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

Parameters

None

oystr.menu.remove(id)

Removes a sub menu entry.

Parameters

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

oystr.menu.select(id)

Selects the according sub menu entry.

Parameters

  1. String the sub menu entry identifier

oystr.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

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

Works like oystr.menu.add(), but all but the id parameters are optional.

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

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

oystr.sounds

Provides a list of sounds.

oystr.sounds.bip()

Makes a bip sound.

Parameters

None

oystr.sounds.bloop()

Makes a bloop sound.

Parameters

None

oystr.sounds.invite()

Makes an invite sound.

Parameters

None