Dash Platform Evo JS SDK Documentation
Overview
The Dash Platform Evo JS SDK exposes a modern JavaScript interface for interacting with platform data and submitting state transitions. This documentation mirrors the legacy layout so you can quickly find queries and transitions while using the Evo SDK.
Key Concepts
- Queries: Read-only operations that fetch data from Dash Platform
- State Transitions: Mutating operations that require properly authorized identities
- Proofs: Many queries can return cryptographic proofs for verification
- Credits: Platform fees are collected in credits; keep balances funded before submitting transitions
- Default Limits: Optional limit arguments default to a maximum of 100 items unless specified
Tip: Examples below execute against Dash Platform Testnet via the Evo SDK client. Click "Run" to invoke any example.
5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5BkThis identity has activity on testnet and is safe to use for read-only demonstrations.
Queries
Identity Queries
Get Identity
Fetch an identity by its identifier.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Identity (Unproved)
Fetch an identity without requesting cryptographic proofs.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Identity Keys
Retrieve public keys for an identity, including support for specific key IDs or purpose searches.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Options: All Keys, Specific Key IDs, Search by Purpose Map
Example: [0,1,2]
Example: {"0": {"0": "current"}, "1": {"0": "all"}}
Example
Get Contract Keys for Identities
Fetch contract-specific keys for one or more identities.
Parameters:
Example: ["5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"]
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Options: Authentication (0), Encryption (1), Decryption (2), Transfer (3), Voting (5)
Example
Get Identity Nonce
Retrieve the global nonce associated with an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Identity Contract Nonce
Retrieve the per-contract nonce for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example
Get Identity Balance
Fetch the credit balance for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Multiple Identity Balances
Fetch balances for multiple identities in a single request.
Parameters:
Example: ["5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"]
Example
Get Identity Balance & Revision
Retrieve both the balance and revision number for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Identity by Unique Public Key Hash
Lookup an identity via its unique public key hash.
Parameters:
Example: b7e904ce25ed97594e72f7af0e66f298031c1754
Example
Get Identity by Non-Unique Public Key Hash
Lookup identities that match a non-unique public key hash.
Parameters:
Example: 518038dc858461bcee90478fd994bba8057b7531
Example
Get Identity Token Balances
Retrieve balances for a set of token IDs held by an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example: ["Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv"]
Example
Get Token Balances for Identities
Fetch balances for multiple identities for a single token.
Parameters:
Example: ["5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"]
Example: Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv
Example
Get Identity Token Info
Retrieve token metadata and balances for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example: ["Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv"]
Example
Get Token Info for Identities
Retrieve token metadata for multiple identities for a single token.
Parameters:
Example: ["5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"]
Example: Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv
Example
Data Contract Queries
Get Data Contract
Fetch a data contract by its identifier.
Parameters:
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example
Get Data Contract History
Retrieve the version history for a data contract.
Parameters:
Example: HLY575cNazmc5824FxqaEMEBuzFeE4a98GDRNKbyJqCM
Example
Get Data Contracts
Fetch multiple data contracts by their identifiers.
Parameters:
Example: ["GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec","ALybvzfcCwMs7sinDwmtumw17NneuW7RgFtFHgjKmF3A"]
Example
Document Queries
Get Documents
Query documents from a data contract using optional filters.
Parameters:
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example: domain
Example: [["normalizedParentDomainName", "==", "dash"], ["normalizedLabel", "==", "therea1s11mshaddy5"]]
Example: [["$createdAt","desc"]]
Example
Get Document
Fetch a specific document by ID.
Parameters:
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example: domain
Example: 7NYmEKQsYtniQRUmxwdPGeVcirMoPh5ZPyAKz8BWFy3r
Example
DPNS Queries
Get Primary Username
Fetch the primary DPNS username for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
List Usernames for Identity
Fetch all DPNS usernames owned by an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Username by Name
Fetch DPNS username details by full name.
Parameters:
Example: alice.dash
Example
Resolve DPNS Name
Resolve a DPNS name to its identity information.
Parameters:
Example: alice.dash
Example
Check DPNS Availability
Check if a DPNS label is available for registration.
Parameters:
Example: alice
Example
Convert to Homograph Safe
Convert a label to its homograph-safe representation.
Parameters:
Example: ąlice
Example
Validate Username
Validate whether a label conforms to DPNS username rules.
Parameters:
Example: alice
Example
Is Contested Username
Check if a label is currently part of a contested DPNS registration.
Parameters:
Example: alice
Example
Voting & Contested Resources
Get Contested Resources
List contested resources for a document type and index.
Parameters:
Example: domain
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example
Get Contested Resource Vote State
Retrieve vote tallies for a contested resource.
Parameters:
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example: domain
Example: ["dash","alice"]
Example: documents
Example
Get Voters for Identity
List voters that voted for a specific identity in a contested resource.
Parameters:
Example: GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec
Example: domain
Example: ["dash","alice"]
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Identity Votes
Fetch contested resource votes submitted by a particular identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Vote Polls by End Date
Fetch vote polls filtered by end time. Use JSON time info for standard responses or millisecond timestamps with proof.
Parameters:
Example
Protocol & Version
Get Protocol Version Upgrade State
Retrieve protocol upgrade vote tallies.
Parameters:
No parameters required
Example
Get Protocol Version Vote Status
Fetch voting status for masternodes on protocol upgrades.
Parameters:
Example: 143dcd6a6b7684fde01e88a10e5d65de9a29244c5ecd586d14a342657025f113
Example
Epoch & Block Queries
Get Epochs Info
Retrieve summary information for one or more epochs.
Parameters:
Example
Get Current Epoch
Fetch the current platform epoch.
Parameters:
No parameters required
Example
Get Finalized Epoch Infos
Retrieve finalized epoch information for a range.
Parameters:
Example
Get Epoch Blocks by Evonode IDs
Fetch proposed blocks for specific evonode ProTx hashes.
Parameters:
Example: ["143dcd6a6b7684fde01e88a10e5d65de9a29244c5ecd586d14a342657025f113"]
Example
Get Epoch Blocks by Range
Fetch proposed blocks in range order.
Parameters:
Example: 143dcd6a6b7684fde01e88a10e5d65de9a29244c5ecd586d14a342657025f113
Example
Token Queries
Get Token Statuses
Retrieve status information for one or more tokens.
Parameters:
Example: ["Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv"]
Example
Get Direct Purchase Prices
Fetch direct purchase prices for tokens.
Parameters:
Example: ["Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv"]
Example
Get Token Contract Info
Retrieve metadata for a token contract.
Parameters:
Example: ALybvzfcCwMs7sinDwmtumw17NneuW7RgFtFHgjKmF3A
Example
Get Token Distribution Last Claim
Fetch the last perpetual distribution claim for an identity and token.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example: Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv
Example
Get Token Total Supply
Fetch the total supply for a token.
Parameters:
Example: Hqyu8WcRwXCTwbNxdga4CN5gsVEGc67wng4TFzceyLUv
Example
Get Token Price by Contract
Retrieve the price details for a token indexed by contract position.
Parameters:
Example: ALybvzfcCwMs7sinDwmtumw17NneuW7RgFtFHgjKmF3A
Example: 0
Example
Group Queries
Get Group Info
Fetch metadata for a specific group contract position.
Parameters:
Example: 49PJEnNx7ReCitzkLdkDNr4s6RScGsnNexcdSZJ1ph5N
Example: 0
Example
List Group Infos
List group information entries for a contract.
Parameters:
Example: 49PJEnNx7ReCitzkLdkDNr4s6RScGsnNexcdSZJ1ph5N
Example
Get Group Members
Retrieve member entries for a group.
Parameters:
Example: 49PJEnNx7ReCitzkLdkDNr4s6RScGsnNexcdSZJ1ph5N
Example: 0
Example
Get Group Actions
Fetch actions associated with a group.
Parameters:
Example: 49PJEnNx7ReCitzkLdkDNr4s6RScGsnNexcdSZJ1ph5N
Example: 0
Options: PENDING, ACTIVE, EXECUTED, CANCELLED
Example
Get Group Action Signers
List signers for a specific group action.
Parameters:
Example: 49PJEnNx7ReCitzkLdkDNr4s6RScGsnNexcdSZJ1ph5N
Example: 0
Options: PENDING, ACTIVE, EXECUTED, CANCELLED
Example
Get Identity Groups
Fetch group memberships for an identity.
Parameters:
Example: 5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk
Example
Get Groups Data Contracts
Fetch group configuration documents for the supplied data contracts.
Parameters:
Example: ["GWRSAVFMjXx8HpQFaNJMqBV7MBgMK4br5UESsB4S31Ec"]
Example
System & Utility
Get Platform Status
Retrieve basic platform status information.
Parameters:
No parameters required
Example
Get Current Quorums Info
Fetch details about currently active quorums.
Parameters:
No parameters required
Example
Get Prefunded Specialized Balance
Retrieve a prefunded specialized balance entry.
Parameters:
Example: AzaU7zqCT7X1kxh8yWxkT9PxAgNqWDu4Gz13emwcRyAT
Example
Get Total Credits in Platform
Fetch the total credit balance stored in the platform.
Parameters:
No parameters required
Example
Get Path Elements
Access items in the GroveDB state tree by specifying a path and keys.
Parameters:
Example: ["32"]
Example: ["5DbLwAxGBzUzo81VewMUwn4b5P4bpv9FNFybi25XB5Bk"]
Example
Wait for State Transition Result
Wait for a state transition to be processed and return the result.
Parameters:
Example: 0000000000000000000000000000000000000000000000000000000000000000
Example
State Transitions
State transitions require valid identities, funds, and private keys. Configure your Evo SDK client appropriately before running these operations on mainnet.
Identity Transitions
Identity Create
Create a new identity with initial credits
Parameters:
Hex-encoded JSON asset lock proof
WIF format private key
JSON array of public keys. Key requirements: ECDSA_SECP256K1 requires privateKeyHex or privateKeyWif for signing, BLS12_381 requires privateKeyHex for signing, ECDSA_HASH160 requires either the data field (base64-encoded 20-byte public key hash) or privateKeyHex (produces empty signatures).
Example
Identity Top Up
Add credits to an existing identity
Parameters:
Base58 format identity ID
Hex-encoded JSON asset lock proof
WIF format private key
Example
Identity Update
Update identity keys (add or disable)
Parameters:
Example: [{"keyType":"ECDSA_HASH160","purpose":"AUTHENTICATION","data":"base64_key_data"}]
Example: 2,3,5
Example
Identity Credit Transfer
Transfer credits between identities
Parameters:
Example
Identity Credit Withdrawal
Withdraw credits from identity to Dash address
Parameters:
Example
Data Contract Transitions
Data Contract Create
Create a new data contract
Parameters:
Example: { "note": { "type": "object", "properties": { "message": { "type": "string", "maxLength": 100, "position": 0 } }, "required": ["message"], "additionalProperties": false } }
Example: {}
Example: {}
Example
Data Contract Update
Add document types, groups, or tokens to an existing data contract
Parameters:
Example: { "newType": { "type": "object", "properties": { "field": { "type": "string", "maxLength": 100, "position": 0 } }, "required": ["field"], "additionalProperties": false } }
Example: {}
Example: {}
Example
Document Transitions
Document Create
Create a new document
Parameters:
Example
Document Replace
Replace an existing document
Parameters:
Example
Document Delete
Delete an existing document
Parameters:
Example
Document Transfer
Transfer document ownership
Parameters:
Example
Document Purchase
Purchase a document
Parameters:
Example
Document Set Price
Set or update document price
Parameters:
Example
DPNS Register Name
Register a new DPNS username
Parameters:
Example: Enter username (e.g., alice)
Example
Token Transitions
Token Burn
Burn tokens
Parameters:
Example
Token Mint
Mint new tokens
Parameters:
Example
Token Claim
Claim tokens from a distribution
Parameters:
Options: Perpetual, Pre-programmed
Example
Token Set Price
Set or update the price for direct token purchases
Parameters:
Options: Single Price, Tiered Pricing
Example: Leave empty to remove pricing
Example
Token Direct Purchase
Purchase tokens directly at the configured price
Parameters:
Example
Token Config Update
Update token configuration settings
Parameters:
Options: Conventions, Max Supply, Perpetual Distribution, New Tokens Destination Identity, Minting Allow Choosing Destination, Manual Minting, Manual Burning, Conventions Control Group, Conventions Admin Group, Max Supply Control Group, Max Supply Admin Group
Example
Token Transfer
Transfer tokens between identities
Parameters:
Example
Token Freeze
Freeze tokens for a specific identity
Parameters:
Example
Token Unfreeze
Unfreeze tokens for a specific identity
Parameters:
Example
Token Destroy Frozen
Destroy frozen tokens
Parameters:
Example
Voting Transitions
DPNS Username
Cast a vote for a contested DPNS username
Parameters:
Example: Enter the contested username (e.g., 'myusername')
Options: Abstain, Lock (Give to no one), Vote for Identity
Example: Identity ID to vote for
Example
Contested Resource
Cast a vote for contested resources as a masternode
Parameters:
Example: Contract ID containing the contested resource
Options: Abstain, Lock (Give to no one), Vote for Identity
Example: Identity ID to vote for