dash

Dash SDK

Dash library for JavaScript/TypeScript ecosystem (Wallet, DAPI, Primitives, BLS, ...)

Dash library allows you to transact on L1 or fetch/register documents on L2 within a single library, including management and signing of your documents.

Find more information in the Documentation.

Install

ES5/ES6 via NPM

In order to use this library, you will need to add it to your project as a dependency.

Having NodeJS installed, just type : npm install dash in your terminal.

npm install dash

CDN Standalone

For browser usage, you can also directly rely on unpkg :

<script src="https://unpkg.com/dash"></script>

Usage

const Dash = require("dash");

const client = new Dash.Client({
  network: "testnet",
  mnemonic: "arena light cheap control apple buffalo indicate rare motor valid accident isolate",
});

client.isReady().then(async () => {
  const {account, platform} = client;
  console.log("Funding address", account.getUnusedAddress().address);
  console.log("Confirmed Balance", account.getConfirmedBalance());
  console.log(await platform.names.get('alice'));
});

Dependencies

Dash SDK works using multiple dependencies that might interest you :

• Wallet-Lib - Wallet management for handling, signing and broadcasting transactions (HD44).
• Dashcore-Lib - Providing the main primitives (Block, Transaction,...).
• DAPI-Client - Client library for accessing DAPI endpoints.
• DPP - Implementation (JS) of Dash Platform Protocol.

Some features might be more extensive in those libs, as Dash SDK only wraps around them to provide a single interface that is easy to use (and thus has less features).

Licence

MIT © Dash Core Group, Inc.

Changelog

3.0.0 (2020-04-24)

• breaking:

  • Identity registration will use HDKeys(0) instead 1 (https://github.com/dashevo/DashJS/pull/41/commits/4bbc54d265c679affbd043b03a88f8ed2f1d52fb)
  • contract.broadcast() now returns dataContract (https://github.com/dashevo/DashJS/pull/41/commits/6f7e9225f317525388fb7701619da74b5d76222b#diff-486b5234782255b516fe9c1868c7d3b0R19)
  • identities.broadcast() now return identity (https://github.com/dashevo/DashJS/pull/41/commits/4bbc54d265c679affbd043b03a88f8ed2f1d52fb#diff-27f47e1bd838b3993aed5eaa396a00e5R90)
  • document.broadcast() creation is now performed via passing documents to be created in an array of property create. {create:[document]} (https://github.com/dashevo/DashJS/commit/91127d774a339c4204891f5863c91a64d521ddb8#diff-0202b3d53936b94585a8c0cfa0481bccR10)

• feat:

  • added replacement of a document. (#41)
  • added deletion of a document (#41)

• impr:

  • update to dpp 0.12 (#41)

• fix:

  • properly release (throw) catched error (#41)

• Chore, Docs & Tests:

  • bumped wallet-lib to 6.1 (#41)