Data Contracts
Overview
Data contracts define the schema (structure) of data an application will store on Dash Platform. Contracts are described using JSON Schema which allows the platform to validate the contract-related data submitted to it.
The following sections provide details that developers need to construct valid contracts: documents and definitions. All data contracts must define one or more documents, whereas definitions are optional and may not be used for simple contracts.
General Constraints
Constraints
There are a variety of constraints currently defined for performance and security reasons. The following constraints are applicable to all aspects of data contracts. Unless otherwise noted, these constraints are defined in the platform's JSON Schema rules (e.g. js-dpp data contract meta schema).
Keyword
Dash Platform Protocol 0.20
Updating to the JSON Schema 2012-12 specification replaced the
definitionskeyword with the$defskeyword.
| Keyword | Constraint |
|---|---|
default | Restricted - cannot be used (defined in DPP logic) |
propertyNames | Restricted - cannot be used (defined in DPP logic) |
uniqueItems: true | maxItems must be defined (maximum: 100000) |
pattern: <something> | maxLength must be defined (maximum: 50000) |
format: <something> | maxLength must be defined (maximum: 50000) |
$ref: <something> | $ref can only reference $defs - remote references not supported |
if, then, else, allOf, anyOf, oneOf, not | Disabled for data contracts |
Note on
maxLengthThe
maxLengthvalue limits the maximum number of characters in the string. This is particularly important to remember when using content encoding schemes where the encoded data is larger than the unencoded data (e.g. base64 where the encoded data is ~33% larger).
Data Size
Note: These constraints are defined in the Dash Platform Protocol logic (not in JSON Schema).
All serialized data (including state transitions) is limited to a maximum size of 16 KB.
Additional Properties
Although JSON Schema allows additional, undefined properties by default, they are not allowed in Dash Platform data contracts. Data contract validation will fail if they are not explicitly forbidden using the additionalProperties keyword anywhere properties are defined (including within document properties of type object).
Include the following at the same level as the properties keyword to ensure proper validation:
"additionalProperties": false
Documents
The documents object defines each type of document required by the data contract. At a minimum, a document must consist of 1 or more properties. Documents may also define indices and a list of required properties.
The following example shows a minimal documents object defining a single document (note) that has one property (message).
{
"note": {
"properties": {
"message": {
"type": "string"
}
},
"additionalProperties": false
}
}
Document Properties
The properties object defines each field that will be used by a document. 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.
Property type:
objectThe
objecttype is required to have properties defined either directly or via the data contract's $defs. For example, thebodyproperty shown below is an object containing a single string property (objectProperty):const contractDocuments = { message: { properties: { body: { type: "object", properties: { objectProperty: { type: "string" }, }, additionalProperties: false, }, header: { type: "string" } }, additionalProperties: false } };
JSON Schema
A full explanation of the capabilities of JSON Schema 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.
Property Constraints
There are a variety of constraints currently defined for performance and security reasons.
Required Properties (Optional)
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. The required object should be excluded for documents without any required properties.
"required": [
"<field name a>",
"<field name b>"
]
Example
The following example (excerpt from the DPNS contract's domain document) demonstrates a document that has 6 required fields:
"required": [
"nameHash",
"label",
"normalizedLabel",
"normalizedParentDomainName",
"preorderSalt",
"records"
],
Document Indices
The
indicesobject should be excluded for documents that do not require indices.
Document indices may be defined if indexing on document fields is required.
The indices array consists of:
- One or more objects that each contain:
- A
propertiesarray composed of a<field name: sort order>object for each document field that is part of the index (sort order:ascordesc) - An (optional)
uniqueelement that determines if duplicate values are allowed for the document
Compound Indices
When defining an index with multiple properties (i.e a compound index), the order in which the properties are listed is important. Refer to the mongoDB documentation for details regarding the significance of the order as it relates to querying capabilities.
"indices": [
{
"properties": [
{ "<field name a>": "<asc"|"desc>" },
{ "<field name b>": "<asc"|"desc>" }
],
"unique": true|false
},
{
"properties": [
{ "<field name c>": "<asc"|"desc>" },
],
}
]
Index Constraints
For performance and security reasons, Evonet places the following constraints on indices. These constraints are subject to change over time.
Example
The following example (excerpt from the DPNS contract's preorder document) creates an index on saltedDomainHash that also enforces uniqueness across all documents of that type:
"indices": [
{
"properties": [
{ "saltedDomainHash": "asc" }
],
"unique": true
}
],
Full Document Syntax
This example syntax shows the structure of a documents object that defines two documents, an index, and a required field.
{
"<document name a>": {
"properties": {
"<field name b>": {
"type": "<field data type>"
},
"<field name c>": {
"type": "<field data type>"
},
},
"indices": [
{
"properties": [
{
"<field name c>": "<asc|desc>"
}
],
"unique": true|false
},
],
"required": [
"<field name c>"
]
"additionalProperties": false
},
"<document name x>": {
"properties": {
"<property name y>": {
"type": "<property data type>"
},
"<property name z>": {
"type": "<property data type>"
},
},
"additionalProperties": false
},
}
Definitions
The optional $defs object enables definition of aspects of a schema that are used in multiple places. This is done using the JSON Schema support for reuse. Items defined in $defs may then be referenced when defining documents through use of the $ref keyword.
Properties defined in the
$defsobject must meet the same criteria as those defined in thedocumentsobject.
Remote references blocked
Data contracts can only use the
$refkeyword to reference their own$defs. Referencing external definitions is not supported by the platform protocol.
Example
The following example shows a definition for a message object consisting of two properties:
{
// Preceeding content truncated ...
"$defs": {
"message": {
"type": "object",
"properties": {
"timestamp": {
"type": "number"
},
"description": {
"type": "string"
}
},
"additionalProperties": false
}
}
}
Toplevel definitions blocked by issue #185
Currently using definitions at the document toplevel throws an error. See https://github.com/dashevo/js-dpp/issues/185
Adding $defs with js-dpp
In the
js-dppreference implementation, definitions are added to a data contract via the.setDefinitions()method (e.g.myContract.setDefinitions({"message": { ... }}). This must be done prior to broadcasting the contract for registration.For a code example for setting definitions using
js-dppsee this gist
Updated over 3 years ago