Skip to content

Latest commit

 

History

History

README.md

Evo SDK

NPM Version Build Status Release Date standard-readme compliant

TypeScript SDK for building applications on Dash Platform

Evo SDK provides a high-level, strongly-typed interface for interacting with Dash Platform on supported networks. It wraps the WebAssembly-based @dashevo/wasm-sdk in ergonomic facades covering identities, documents, data contracts, tokens, DPNS, and more. The SDK works in both Node.js and modern browsers.

Table of Contents

Install

npm install @dashevo/evo-sdk

The package is ESM-only ("type": "module"). In CommonJS projects, use dynamic import(). Requires Node.js >= 18.18.

Usage

Trusted mode is required for all queries. It pre-fetches quorum public keys so the SDK can verify Platform proofs.

import { EvoSDK } from '@dashevo/evo-sdk';

const sdk = EvoSDK.testnetTrusted(); // or mainnetTrusted()
await sdk.connect();

const epoch = await sdk.epoch.current();
console.log('Current epoch:', epoch.index);

Facades

The SDK organises its API into domain-specific facades, each accessible as a property on the EvoSDK instance:

Facade Description
sdk.addresses Query balances, transfer credits, withdraw to L1
sdk.identities Fetch, create, update, and top up identities
sdk.documents Query, create, replace, delete, and transfer documents
sdk.contracts Fetch, publish, and update data contracts
sdk.tokens Mint, burn, transfer, freeze tokens and query balances
sdk.dpns Register and resolve Dash Platform names
sdk.epoch Query epoch information and evonode proposed blocks
sdk.protocol Protocol version upgrade state and voting
sdk.stateTransitions Broadcast and wait for state transitions
sdk.system System status, quorum info, and total credits
sdk.group Group membership, actions, and contested resources
sdk.voting Contested resource vote states and polls

A wallet namespace is also exported with utilities for mnemonic generation, key derivation, address validation, and message signing.

Contributing

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

License

MIT © Dash Core Group, Inc.