Skip to content
This repository has been archived by the owner on Jul 11, 2018. It is now read-only.

mobius-network/mobius-node-v1

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Mobius Node.js API Client

Version Downloads Try on RunKit

The Mobius Node.js Client provides simple access to the Mobius API for applications written on Node.js

Installation

Install the package with npm:

$ npm install @mobius-network/mobius-node --save

or with yarn

$ yarn add @mobius-network/mobius-node

Usage

For importing library use:

const Mobius = require('@mobius-network/mobius-node');

On ES6 it's look like:

import Mobius from '@mobius-network/mobius-node';

The library need to be configured with your API secret key which you can create in Mobius DApp Store

const mobius = new Mobius({
  apiKey: 'your_api_key',
});

Promises

Every method returns a chainable promise which can be used like this:

mobius.appStore
  .balance({ appUid: 'f9e5e943', email: 'mail@example.com' })
  .then(balance => {
    if (balance.numCredits > 0) {
      mobius.appStore.use({ appUid: '581d1351', email: 'mail@example.com', numCredits: 1 });
    }
  })
  .catch(error => console.error(error));

Methods

  • mobius.appStore.balance({ appUid, email })

    Get balance of credits for email.

  • mobius.appStore.use({ appUid, email, numCredits })

    Use numCredits from user with email.

  • mobius.tokens.register({ tokenType, name, symbol, address })

    Register a token.

  • mobius.tokens.balance({ tokenUid, address })

    Query the number of tokens specified by the token.

  • mobius.tokens.createAddress({ tokenUid, managed })

    Create an address for the token.

  • mobius.tokens.registerAddress({ tokenUid, address })

    Register an address for the token.

  • mobius.tokens.transferManaged({ tokenAddressUid, addressTo, numTokens })

    Transfer tokens from a Mobius managed address to a specified address.

  • mobius.tokens.transferInfo({ tokenAddressTransferUid })

    Get the status and transaction hash of a Mobius managed token transfer.

More information

See the REST API docs

Development

Run all tests

$ yarn install
$ yarn run test