Contract Documents#
Contract Document Overview#
The documents object defines each type of document in the data contract. At a minimum, a document must consist of 1 or more properties. The additionalProperties properties keyword must be included as described in the constraints section and each property must be assigned a position.
Note
The $schema property is required for each document type but is automatically injected by the platform during contract enrichment. Do not include it in user-submitted document type definitions — providing it will result in a validation error.
The following example shows a minimal documents object defining a single document (note) with one property (message).
{
"note": {
"type": "object",
"properties": {
"message": {
"type": "string",
"position": 0
}
},
"additionalProperties": false
}
}
Documents may also define indices, a list of required or transient properties, and a custom configuration. Refer to this table for a brief description of the major document sections:
Feature |
Description |
|---|---|
Document-level settings affecting behavior such as mutability, deletion, and transferability |
|
Definitions and constraints for each field within a document |
|
Definitions for indexing document fields to support efficient querying |
Document Properties#
The properties object defines each field that a document will use. Each field consists of an object that, at a minimum, must define its data type (string, number, integer, boolean, array, object).
Fields may also apply a variety of optional JSON Schema constraints related to the format, range, length, etc. of the data. A full explanation of JSON Schema capabilities is beyond the scope of this document. For more information regarding its data types and the constraints that can be applied, please refer to the JSON Schema reference documentation.
Assigning Position#
Each property in a level must be assigned a unique position value, with ordering starting at zero and incrementing with each property. When using nested objects, position counting resets to zero for each level. This structure supports backward compatibility in data contracts by ensuring consistent ordering for serialization and deserialization processes.
Object Properties#
The object type cannot be an empty object but must have one or more defined properties. For example, the body property shown below is an object containing a single string property (objectProperty):
const contractDocuments = {
message: {
type: "object",
properties: {
body: {
type: "object",
position: 0,
properties: {
objectProperty: {
type: "string",
"position": 0
},
},
additionalProperties: false,
},
header: {
type: "string",
"position": 1
}
},
additionalProperties: false
}
};
Required Properties#
Each document may have some fields that are required for the document to be valid and other fields that are optional. Required fields are defined via the required array, which consists of a list of the field names from the document that must be present. Exclude the required object for documents without required properties.
"required": [
"<field name a>",
"<field name b>"
]
Example
The following example (excerpt from the DPNS contract’s domain document) demonstrates a document with required fields:
"required": [
"$createdAt",
"$updatedAt",
"$transferredAt",
"label",
"normalizedLabel",
"normalizedParentDomainName",
"preorderSalt",
"records",
"subdomainRules"
]
Adding required properties in a contract update#
Added in version 4.2.0.
A contract update may add a property to required only if the property also sets requiredSince to the contract version from which it is required. The value is an integer from 1 to 4294967295 and may not exceed the version of the contract that carries it. requiredSince is allowed only on top-level properties that are listed in required.
"properties": {
"avatarUrl": {
"type": "string",
"maxLength": 2048,
"position": 3,
"requiredSince": 2
}
}
Transient Properties#
Each document may have transient fields that require validation but do not need to be stored by the system once validated. Transient fields are defined in the transient array. Only include the transient object for documents with at least one transient property.
Example
The following example (from the DPNS contract’s domain document) demonstrates a document that has 1 transient field:
"transient": [
"preorderSalt"
]
Property References#
Added in version 4.2.0.
An identifier property (type: array, byteArray: true, contentMediaType: application/x.dash.dpp.identifier, minItems and maxItems of 32) may declare a refersTo object. Platform then checks at document write time that the referenced entity exists. Setting refersTo on any other property type is rejected.
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
|
|
string or array (32 bytes) |
No |
|
|
string (1-64 chars) |
Yes, for |
Name of the referenced document type. The referenced type must set |
|
object (1-10 entries) |
No |
|
|
string (1-256 chars) |
Yes, for |
Property of this document that holds the referenced key id. The |
contractId, documentType, and propertyAgreement are rejected unless type is permanentDocument; keyIdProperty is rejected unless type is identityPublicKey.
Property Constraints#
There are a variety of constraints currently defined for performance and security reasons.
Document Indices#
Document indices may be defined if indexing on document fields is required. The indices array should only be included for documents with at least one index.
Required Index Fields#
Each object in the indices array requires two fields:
Field |
Description |
|---|---|
|
A unique name for the index. |
|
An ordered array containing one |
Compound Indices
When defining an index with multiple properties, the ordering of properties is important. Refer to the mongoDB documentation for details. Dash uses GroveDB, which works similarly but requires listing all the index’s fields in query order by statements.
Optional Index Fields#
In addition to name and properties, an index may contain the following optional fields:
Option |
Purpose |
Details |
|---|---|---|
|
Determines whether duplicate values are allowed. |
Defaults to |
|
Determines whether the index includes entries whose properties are all null. |
Defaults to |
|
Makes matching values on a unique index subject to a masternode vote instead of first-come ownership. |
See Contested Indices. |
Aggregate flags |
Enable count, sum, and average fast paths. |
|
Ranked aggregate flags |
Enable top or bottom K queries. Added in 4.2.0. |
|
|
Buckets the first index property into fixed-length time windows. Added in 4.2.0. |
See Time-Range Indices. |
|
Omits an index entry when the first property is absent. Added in 4.2.0. |
Available only on |
|
Selects the value that keys each index entry. Added in 4.2.0. |
Available only on |
|
Creates index trees before referenced documents produce entries. Added in 4.2.0. |
Available only on |
Index objects do not accept any properties beyond those listed above. Starting with Dash Platform 4.2.0 (protocol version 14), index objects also accept the ranked aggregate keywords, timeRange, and the indexOnly-specific keywords terminal, preallocated, and skipIfAbsent. Under earlier protocol versions those keywords are rejected.
The following template shows the required shape and commonly used optional fields:
"indices": [
{
"name": "<index name a>",
"properties": [
{ "<field name a>": "asc" },
{ "<field name b>": "asc" }
],
"unique": true|false,
"nullSearchable": true|false,
"contested": {
"fieldMatches": [
{
"field": "<field name a>",
"regexPattern": "<regex>"
}
],
"resolution": 0
}
},
{
"name": "<index name b>",
"properties": [
{ "<field name c>": "asc" },
],
"countable": "countable"|"countableAllowingOffset"|"notCountable",
"rangeCountable": true|false,
"summable": "<integer field name>",
"rangeSummable": true|false,
"averageable": "<integer field name>",
"rangeAverageable": true|false
}
]
Example
The following example (excerpt from the DPNS contract’s preorder document) creates an index named saltedHash on the saltedDomainHash property and enforces uniqueness across all documents of that type:
"indices": [
{
"name": "saltedHash",
"properties": [
{
"saltedDomainHash": "asc"
}
],
"unique": true
}
]
Time-Range Indices#
Added in version 4.2.0: Protocol version 14 added time-range indices.
The optional timeRange object buckets an index’s first property into fixed-length time windows. It contains the following fields:
Field |
Type |
Required |
Description |
|---|---|---|---|
|
string |
Yes |
The first index property. It must be |
|
integer |
Yes |
Window length in seconds. It must be a multiple of |
|
integer |
Yes |
Number of seconds between window starts. |
|
integer |
No |
Grid offset in seconds. It must be less than |
|
integer |
No |
Entry lifetime in seconds, measured from the start of its window. It must be at least |
When ttl is set, an entry lives at most ttl seconds past the start of its window, plus a bounded cleanup lag. Expired windows cannot be queried. Indexes that bucket the same field on the same grid must all declare the same ttl, or all omit it.
Bytes written under a ttl index are charged as processing at the TTL ephemeral rate instead of storage and are not refunded on removal.
A time-range index may be unique only when range equals step and on is $createdAt. It cannot be contested, set nullSearchable to false, or be combined with preallocated.
Index-Only Options#
The following options are available only on document types with indexOnly: true:
Option |
Behavior and constraints |
|---|---|
|
When true, a document that omits the index’s first property writes no entry into this index. The first property must be a top-level property that is not in |
|
Names the property whose value keys each index entry. It may be |
|
Creates the index trees for entries referencing a document when that document is created. Every index property must be either the referring property of a same-contract |
Contested Indices#
Contested unique indices provide a way for multiple identities to compete for ownership when a new document field matches a predefined pattern. This system enables fair distribution of valuable documents, such as premium DPNS names, through community-driven decision-making.
A two week contest begins when a match occurs. For the first week, additional contenders can join by paying the contested document vote resolution fund fee (0.1 Dash from protocol version 14; 0.2 Dash in earlier versions). During this period, masternodes and evonodes vote on the outcome. The contest can result in the awarding of the document to the winner, a locked vote where no document is awarded, or potentially a restart of the contest if specific conditions are met.
The table below describes the properties used to configure a contested index:
Property Name |
Type |
Description |
|---|---|---|
fieldMatches |
array |
Array containing conditions to check |
fieldMatches.field |
string |
Name of the field to check for matches (1-256 characters) |
fieldMatches.regexPattern |
string |
Regex used to check for matches (1-256 characters) |
resolution |
integer |
Method to resolve the contest: |
description |
string |
Optional free-text note (1-256 characters) |
Example
This example (from the DPNS contract’s domain document) demonstrates the use of a contested index:
"contested": {
"fieldMatches": [
{
"field": "normalizedLabel",
"regexPattern": "^[a-zA-Z01-]{3,19}$"
}
],
"resolution": 0,
"description": "If the normalized label part of this index is less than 20 characters (all alphabet a-z, A-Z, 0, 1, and -) then a masternode vote contest takes place to give out the name"
}
Index Constraints#
For performance and security reasons, indices have the following constraints. These constraints are subject to change over time.
Description |
Value |
|---|---|
Minimum/maximum length of index |
|
Maximum number of indices |
|
Maximum number of unique indices |
|
Maximum number of contested indices |
|
Maximum number of properties in a single index |
|
Maximum |
|
Maximum |
604,800 seconds (1 week) |
Maximum length of indexed string property |
|
Usage of |
N/A |
Note: Dash Platform does not allow indices for arrays. |
|
Note: Dash Platform does not allow indices for arrays. |
See also
For all protocol constants, see Protocol Constants.
Document Configuration#
Documents support the following configuration options to provide flexibility in contract design. Only include configuration options in a data contract when using non-default values.
Document option |
Type |
Description |
|---|---|---|
|
boolean |
If true, documents keep a history of all changes. Default: false. |
|
boolean |
If true, documents are mutable. Default: true. |
|
boolean |
If true, documents can be deleted. Default: true. |
|
integer |
Transferable without a marketplace sell: |
|
integer |
Built-in marketplace system: |
|
integer |
Restriction of document creation: |
|
boolean |
If true, transfers of these documents are recorded in the document history contract. Default: false. |
|
boolean |
If true, purchases of these documents are recorded in the document history contract. Default: false. |
|
boolean |
If true, price updates on these documents are recorded in the document history contract. Default: false. |
|
boolean |
Added in 4.2.0. If true, documents of this type are stored only as index entries; there is no primary document row. Requires |
Security option |
Type |
Description |
|---|---|---|
integer |
Key requirements for identity encryption: |
|
integer |
Key requirements for identity decryption: |
|
|
integer |
Public key security level: |
Changed in version 4.2.0: A document type with documentsKeepHistory: true must also set canBeDeleted: false. Since canBeDeleted defaults to true, leaving it unset on a keep-history type is rejected when the contract is validated.
Token Costs#
The tokenCost option allows document types to require token payment for operations. When configured, users must pay a specified amount of tokens to perform each operation type. Each operation cost is defined as a documentActionTokenCost object with the following properties:
Property |
Type |
Required |
Description |
|---|---|---|---|
|
array (32 bytes) |
No |
Identifier of the contract containing the payment token. Omit it for a token in the current contract; setting it to the contract’s own id is rejected. |
|
integer (0–65535) |
Yes |
Position of the token within the contract |
|
integer (1–281474976710655) |
Yes |
Number of tokens required for the operation |
|
integer |
No |
Token disposition after payment: |
|
integer |
No |
Who pays gas fees for the operation: |
The following operation types can each have an independent cost configuration:
Operation |
Description |
|---|---|
|
Creating a new document |
|
Replacing an existing document |
|
Deleting a document |
|
Transferring document ownership |
|
Updating a document’s purchase price |
|
Purchasing a document |
List of all usable document properties
This list of properties is defined in the Rust DPP implementation and the document meta-schema.
Property Name |
Type |
Description |
|---|---|---|
|
string |
Specifies the type of the document, constrained to “object”. |
|
string |
Platform-injected during enrichment; not accepted in user submissions. |
|
object |
References the |
array |
Defines indices for the document with properties like |
|
|
integer |
Public key security level: |
|
boolean |
If true, documents keep a history of all changes. Default: false. |
|
boolean |
If true, documents are mutable. Default: true. |
|
boolean |
If true, documents can be deleted. Default: true. |
|
integer |
Transferable without a marketplace sell: |
|
integer |
Built-in marketplace system: |
|
integer |
Restriction of document creation: |
integer |
Key requirements for identity encryption: |
|
integer |
Key requirements for identity decryption: |
|
object |
Defines the properties of the document. |
|
array |
An array of strings specifying transient properties that are validated by Platform but not stored. |
|
|
object |
Defines token costs for document operations (create, replace, update_price, delete, transfer, purchase) |
boolean |
Doctype-wide count support. See Aggregate Query Flags. |
|
boolean |
Per-index range counts. See Aggregate Query Flags. |
|
string |
Doctype-wide sums of the named integer property. See Aggregate Query Flags. |
|
boolean |
Per-index range sums. See Aggregate Query Flags. |
|
string |
Doctype-wide averages of the named integer property. See Aggregate Query Flags. |
|
boolean |
Per-index range averages. See Aggregate Query Flags. |
|
boolean |
Records transfers in the document history contract. See Document History Flags. |
|
boolean |
Records purchases in the document history contract. See Document History Flags. |
|
boolean |
Records price updates in the document history contract. See Document History Flags. |
|
|
boolean |
If true, index entries are the only storage for this document type. See Document Configuration. |
|
array |
Standard JSON Schema keyword listing required property names. |
|
string |
Standard JSON Schema keyword describing the document type. |
|
string |
Standard JSON Schema keyword for a schema comment. |
|
integer |
Standard JSON Schema keyword bounding the minimum number of properties. |
|
integer |
Standard JSON Schema keyword bounding the maximum number of properties. |
|
object |
Standard JSON Schema keyword declaring conditionally required properties. |
boolean |
Specifies whether additional properties are allowed. Must be set to false, meaning no additional properties are allowed beyond those defined. |
Example
The following example (from the DPNS contract’s domain document) demonstrates the use of several configuration options:
{
"domain": {
"documentsMutable": false,
"canBeDeleted": true,
"transferable": 1,
"tradeMode": 1,
"keepsTransferHistory": true,
"keepsPurchaseHistory": true,
"keepsPricingHistory": true,
"..."
}
}
Aggregate Query Flags#
Added in version 4.0.0.
Document types can opt into aggregate query support (count / sum / average) through flags at the document-type root and on individual index objects. These flags control the underlying storage layout — once set on a published contract they cannot be changed by a contract update.
Document-type flags#
Document-type flags configure aggregates on the primary-key tree and are set at the document-type root alongside options such as documentsKeepHistory.
Flag |
Type |
Purpose |
|---|---|---|
|
Boolean |
Enables total document counts on the primary-key tree. |
|
Boolean |
Enables range counts on the primary-key tree and implies |
|
String |
Enables total sums of the named integer property. |
|
Boolean |
Enables range sums on the primary-key tree. Requires |
|
String |
Syntactic sugar for |
|
Boolean |
Syntactic sugar for root-level |
Index-level flags#
Index-level flags configure aggregates along a specific index path. Set them on the index object alongside name, properties, unique, and contested, not on an individual { "field": "asc" } property entry.
Flag |
Type |
Purpose |
|---|---|---|
|
Boolean or string |
Enables count fast paths for the index. String values are |
|
Boolean |
Enables range counts over the indexed property. Requires |
|
String |
Enables sums of the named integer document property through the index. |
|
Boolean |
Enables range sums over the indexed property. Requires |
|
String |
Syntactic sugar for index-level |
|
Boolean |
Syntactic sugar for index-level |
|
Boolean or object |
Added in 4.2.0. Ranks groups by document count for top or bottom K queries. |
|
Boolean |
Added in 4.2.0. Ranks groups by the sum of the |
|
Boolean |
Added in 4.2.0. Ranks groups by the average of the |
Properties named by documentsSummable, documentsAverageable, summable, or averageable must exist on the document type, be listed in required, and have an integer type.
The averageable flags desugar to the underlying count + sum flags during contract parsing — same on-disk layout — so authors who think in terms of averages get a single flag and downstream code paths (insert, query, estimation) stay unchanged. If both documentsAverageable and documentsSummable are set, they must name the same property.
These flags were introduced in the v1 document meta-schema and carry forward unchanged into v2 and v3. They are rejected when applied to pre-v12 contracts. The current v3 meta-schema, including these flags and the ranked keywords, is defined in rs-dpp.
See the getDocuments reference for the request/response shapes that consume these flags.
Document History Flags#
Added in version 4.1.0.
Document types can opt into recording ownership and pricing events in the document history system contract by setting flags at the document-type level. Each flag is a boolean defaulting to false, set at the document type root alongside other doctype options like documentsKeepHistory. These are distinct from the token-level token history properties, which share the keepsTransferHistory name but default to true and record into token history.
Flag |
Type |
Purpose |
|---|---|---|
|
Boolean |
Records each transfer of these documents. |
|
Boolean |
Records each purchase of these documents. |
|
Boolean |
Records each price update on these documents. |
Like the aggregate query flags, these cannot be changed by a contract update once set on a published contract.
The flags are read only when the contract validates against the v2 or later document meta-schema (protocol version 13 or later). Under earlier meta-schema versions they are treated as false. The current v3 meta-schema is defined in rs-dpp.
Keyword Constraints#
There are a variety of keyword constraints currently defined for performance and security reasons. The following constraints apply to document definitions. Unless otherwise noted, these constraints are defined in the platform’s JSON Schema rules (e.g., rs-dpp document meta schema).
Keyword |
Constraint |
|---|---|
|
Restricted - cannot be used (defined in DPP logic) |
|
Restricted - cannot be used (defined in DPP logic) |
|
|
|
|
|
Internal references only - the value must begin with |
|
Disabled for data contracts |
|
Not supported. Use |
|
Not supported. Schema-based dependencies are not available in document schemas; use |
|
Only byte arrays are supported. |
|
Not supported. Per-item array schemas ( |
|
Restricted - cannot be used for data contracts |
|
Patterns are compiled with the Rust |
Example Syntax#
This example syntax shows the structure of a documents object that defines two documents, an index, and a required field.
{
"<document name a>": {
"type": "object",
"properties": {
"<field name b>": {
"type": "<field data type>",
"position": "<number>"
},
"<field name c>": {
"type": "<field data type>",
"position": "<number>"
},
},
"indices": [
{
"name": "<index name>",
"properties": [
{
"<field name c>": "asc"
}
],
"unique": true|false
},
],
"required": [
"<field name c>"
],
"additionalProperties": false
},
"<document name x>": {
"type": "object",
"properties": {
"<property name y>": {
"type": "<property data type>",
"position": "<number>"
},
"<property name z>": {
"type": "<property data type>",
"position": "<number>"
},
},
"additionalProperties": false
},
}
Document Schema#
See full document schema details in the rs-dpp document meta schema. Protocol version 13 (Dash Platform 4.1) validates against the v2 meta-schema. Protocol version 14 (Dash Platform 4.2.0) validates against the v3 meta-schema, which adds the ranked index keywords, refersTo, requiredSince, timeRange, and the indexOnly keywords.