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

2.0.0 (2020-03-27)

• breaking:
  • renamed DashJS namespace to SDK namespace.
  • renamed SDK namespace to Client namespace (DashJS.SDK -> SDK.Client).
  • moved L1 primitive namespace from SDK.* to SDK.Core.*.
  • moved L2 primitive namespace from SDK.* to SDK.Platform.*.
  • exported file for web environment is now Dash instead of DashJS
• feat:
  • Sign and verify message (#24)
• impr:
  • Typings documentation (#30)
  • Code cleanup (#31)
  • Export all Dashcore Primitives (under SDK.Core.*)
• fix:
  • fix(contracts): pass data contract without array (#32 in #31)
  • fix: remove .serialize() before broadcasting records (#e047d515a12d0d14ff69b4fe3ea5b8b10bd6f890)
  • Identity/register: updated getUTXOS usages on (#afda5bbafb940b2e15d5e773d0e8fc5fbc48ee13)
  • fix(StateTransitionBuilder): records type detection (#b49f74b4b8e03e9d1020dd789c62f4310a4fc1ad)
  • broadcasting of contracts (#f4b63e6be692841f1b138e5b058e531a0873f456, #4aa31fec0e5579d7ef8b9222576863a069b95fd3)
• chore:
  • updated for new evonet (updated wallet-lib to 6.0.0)
  • updated dapi-client to 0.11 (#fba4d55d3281bec5e65605787dd23a6ca3517476)
  • updated DPNS contractID on evonet (#d0cf11d30cf7c9aaef1ffa4a2b8a955fbf5b1184)