Wallet Library

A pure and extensible JavaScript Wallet Library for Dash

Warning: This library should only be used in production when connected to trusted nodes. Although it provides easy access to wallet functionality without requiring a full node, it does not verify synchronized blockchain data (e.g., the masternode list, InstantSend transactions, ChainLocks) or check transactions against block headers.

Table of Contents

• Install
• Usage
• Documentation
• Maintainers
• Contributing
• License

Background

Dash is a powerful new peer-to-peer platform for the next generation of financial technology. The decentralized nature of the Dash network allows for highly resilient Dash infrastructure, and the developer community needs reliable, open-source tools to implement Dash apps and services.

Install

Node

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

Having NodeJS installed, just type in your terminal :

npm install @dashevo/wallet-lib

CDN Standalone

For browser usage, you can also directly rely on unpkg. Below, we also assume you use localForage as your persistence adapter.

<script src="https://unpkg.com/@dashevo/wallet-lib"></script>
<script src="https://unpkg.com/localforage"></script>
const wallet = new Wallet({adapter: localforage});

Usage

In your file, where you want to execute it :

const { Wallet, EVENTS } = require('@dashevo/wallet-lib');

const wallet = new Wallet();

// We can dump our initialization parameters
const mnemonic = wallet.exportWallet();

// Hook on headers and TX sync progress events
wallet.on(EVENTS.HEADERS_SYNC_PROGRESS, (progressInfo) => {
  const {
    confirmedProgress,
    totalProgress,
    confirmedSyncedCount,
    totalSyncedCount,
    totalCount
  } = progressInfo;
})

wallet.on(EVENTS.TRANSACTIONS_SYNC_PROGRESS, (progressInfo) => {
  const {
    progress,
    syncedBlocksCount,
    totalBlocksCount,
    transactionsCount
  } = progressInfo;
})

wallet.getAccount().then((account) => {
  // At this point, account has fetch all UTXOs if they exists
  const balance = account.getTotalBalance();
  console.log(`Balance: ${balance}`);

  // We easily can get a new address to fund
  const { address } = account.getUnusedAddress();
});

Wallet will by default connects to DAPI and use either localforage (browser based device) or a InMem adapter. Account will by default be on expected BIP44 path (...0/0).

Transports:

Insight-Client has been removed from MVP and is not working since Wallet-lib v3.0.

• DAPI-Client

Adapters :

• LocalForage
• ReactNative AsyncStorage

Documentation

You can see some examples here.

More extensive documentation is available at https://dashpay.github.io/platform/Wallet-library/ along with additional examples & snippets.

Maintainers

Wallet-Lib is maintained by the Dash Core Developers. We want to thank all members of the community that have submitted suggestions, issues and pull requests.

Contributing

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

License

MIT © Dash Core Group, Inc.