js-dash-sdk

Dash SDK

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

No longer recommended for new projects. For new projects, use @dashevo/evo-sdk, which is built on the Rust/WASM SDK and supports cryptographic proof verification. This package is maintained internally for the platform test suite only.

SDK Comparison

Feature	dash (this package)	@dashevo/evo-sdk
Proof verification	🔴 Not supported — requires trusted nodes	🟢 All queries verified
Identities	🟡 Basic — get, register, topUp, update, transfer, withdraw	🟢 Full — 16+ methods with proof variants
Documents	🟡 Basic — create, broadcast, get	🟢 Full — query, get, create, replace, delete, transfer, purchase, setPrice
Data contracts	🟢 Full - create, publish, update, get, history	🟢 Full - fetch, getMany, history, publish, update
DPNS / names	🟡 Basic — register, resolve, search	🟢 Full — register, resolve, search, availability check, homograph safety
Tokens	🔴 Not supported	🟢 Full — mint, burn, transfer, freeze, unfreeze, purchase, claim, and more
Voting	🔴 Not supported	🟢 Full
Groups	🔴 Not supported	🟢 Full
Epoch management	🔴 Not supported	🟢 Full
System queries	🔴 Not supported	🟢 Full
Platform addresses	🔴 Not supported	🟢 Full
Wallet / key management	🟢 Full SPV wallet via wallet-lib	🟡 Key derivation utilities only (BIP44, WIF, signing)
Module format	CommonJS + UMD bundle	ESM only
Browser CDN	🟢 unpkg (UMD)	🟢 esm.sh (ESM)
Node.js requirement	Any	>= 18.18
TypeScript	🟢	🟢

Warning: This SDK should only be used in production when connected to trusted nodes. Although it provides easy access to Dash Platform without requiring a full node, it does not support Dash Platform’s proofs or verify synchronized blockchain data.

Dash library provides access via DAPI to use both the Dash Core network and Dash Platform on supported networks. The Dash Core network can be used to broadcast and receive payments. Dash Platform can be used to manage identities, register data contracts for applications, and submit or retrieve application data via documents.

Table of Contents

• Install
• Usage
• Dependencies
• Documentation
• Contributing
• License

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"); // or import Dash from "dash"

const client = new Dash.Client({
  wallet: {
    mnemonic: "arena light cheap control apple buffalo indicate rare motor valid accident isolate",
  },
  apps: {
    tutorialContract: {
      // Learn more on how to register Data Contract
      // https://dashplatform.readme.io/docs/tutorial-register-a-data-contract#registering-the-data-contract
      contractId: "<tutorial-contract-id>" 
    }
  }
});

// Accessing an account allow you to transact with the Dash Network
client.wallet.getAccount().then(async (account) => {
  console.log('Funding address', account.getUnusedAddress().address);

  const balance = account.getConfirmedBalance();
  console.log('Confirmed Balance', balance);

  if (balance > 0) {
    // Obtain identity - the base of all platform interactions
    // Read more on how to create an identity here: https://dashplatform.readme.io/docs/tutorial-register-an-identity
    const identityIds = account.identities.getIdentityIds();
    const identity = await client.platform.identities.get(identityIds[0]);

    // Prepare a new document containing a simple hello world sent to a hypothetical tutorial contract
    const document = await client.platform.documents.create(
      'tutorialContract.note',
      identity,
      { message: 'Hello World' },
    );

    // Broadcast the document into a new state transition
    await client.platform.documents.broadcast({ create: [document] }, identity);

    // Retrieve documents
    const documents = await client.platform.documents.get('tutorialContract.note', {
      limit: 2,
    });

    console.log(documents);
  }
});

Primitives and essentials

Dash SDK bundled into a standalone package, so that the end user never have to worry about mananaging polyfills or related dependencies

const Dash = require('dash')

const {
  Essentials: {
    Buffer  // Node.JS Buffer polyfill.
  },
  Core: { // @dashevo/dashcore-lib essentials
    Transaction, 
    PrivateKey,
    BlockHeader,
    // ...
  },
  PlatformProtocol: { // @dashevo/wasm-dpp essentials
    Identity,
    Identifier,
  },
  WalletLib: { // @dashevo/wallet-lib essentials
    EVENTS
  },
  DAPIClient, // @dashevo/dapi-client
} = Dash;

Dependencies

The Dash SDK works using multiple dependencies that might interest you:

• Wallet-Lib - Wallet management for handling, signing and broadcasting transactions (BIP-44 HD).
• Dashcore-Lib - Provides the main L1 blockchain primitives (Block, Transaction,...).
• DAPI-Client - Client library for accessing DAPI endpoints.
• Wasm-DPP - Implementation 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).

Documentation

More extensive documentation available at https://dashpay.github.io/platform/SDK/.

Contributing

Feel free to dive in! Open an issue or submit PRs.

License

MIT © Dash Core Group, Inc.