Package Exports

dash

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (dash) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

DashJS

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

DashJS 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 in the :

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 @dashevo/dashjs in your terminal.

npm install @dashevo/dashjs

CDN Standalone

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

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

Usage

import DashJS from "@dashevo/dashjs"; 
import schema from "./schema.json";

const network = "testnet";
const opts = {
    network,
    mnemonic: "arena light cheap control apple buffalo indicate rare motor valid accident isolate",
    schema
};
const sdk = new DashJS.SDK(opts);
const account = sdk.wallet.getAccount();
async function sendPayment(){
    const txOpts = {recipient:{address:'yLptqWxjgTxtwKJuLHoGY222NnoeqYuN8h', amount:0.12}};
    const tx = await account.createTransaction(txOpts)
    console.log(tx)
}

async function readDocument() {
    const profile = await sdk.platform.fetchDocuments('profile',{name:'Bob'})
    console.log(profile);
}

In a nutshell

If you use multiple contracts, fetchDocuments is done using dot-locator dashpay.profile and passing a named-schemas object. See more on how to work with multiple contracts in detail

Dependencies

DashJS 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 DashJS only wraps around them to provide a single interface that is easy to use (and thus has less features).

dash