/mcashweb

Javascript API Library for interacting with the MCashChain Network https://mcash.network

Primary LanguageJavaScriptMIT LicenseMIT

What is McashWeb?

Mcash Web - Developer Document

Compatibility

  • Version built for Node.js v6 and above
  • Version built for browsers with more than 0.25% market share

You can access either version specifically from the dist folder.

McashWeb is also compatible with frontend frameworks such as:

  • Angular
  • React
  • Vue.

You can also ship McashWeb in a Chrome extension.

Installation

Node.js

npm install mcashweb

or

yarn add mcashweb

Browser

The asiest way to use McashWeb in a browser is to install it as above and copy the dist file to your working folder. For example:

cp node_modules/mcashweb/dist/McashWeb.js ./js/mcashweb.js

so that you can call it in your HTML page as

<script src="./js/mcashweb.js"><script>

Testnet

To use Mcash Testnet the following endpoint:

https://testnet.mcash.network

Anything you do should be explorable on https://testnet.mcashscan.io

Creating an Instance

First off, in your javascript file, define McashWeb:

const McashWeb = require('mcashweb');

const mcashWeb = new McashWeb({
    fullHost: 'https://mainnet.mcash.network',
    privateKey: 'your private key'
});

Licence

McashWeb is distributed under a MIT licence.