You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* docs(protocol-ref): dedup state transition page and drop deprecated DAPI entries
Replace the cramped one-cell type discriminator with a proper catalog table,
remove the 7 type-0–8 detail sections that duplicate the canonical identity
and data-contract pages, and drop the long-deprecated getIdentities and
getIdentitiesByPublicKeyHashes endpoints (removed from the platform proto in
v1.0.0).
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: minor formatting update
* docs: fix broken cross-references to clean up build warnings
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* docs: silence Pygments warnings on placeholder JSON blocks
Convert affected fences to code-block directives with :force: so JSON
highlighting is preserved without lexer errors on schema-style
placeholders and JS-literal query examples.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Copy file name to clipboardExpand all lines: docs/protocol-ref/data-contract-document.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -144,7 +144,9 @@ The `indices` array consists of one or more objects that each contain:
144
144
* An optional `nullSearchable` element that indicates whether the index allows searching for NULL values. If nullSearchable is false (default: true) and all properties of the index are null then no reference is added.
145
145
* An optional `contested` element that determines if duplicate values are allowed for the document
146
146
147
-
```json
147
+
:::{code-block} json
148
+
:force:
149
+
148
150
"indices": [
149
151
{
150
152
"name": "<indexnamea>",
@@ -171,7 +173,7 @@ The `indices` array consists of one or more objects that each contain:
| $version | unsigned integer | 16 bits | The state transition format version (FeatureVersion). Currently `0` for most transitions, `1` for Batch. This is not the global platform protocol version, which is negotiated separately. |
29
-
| type | unsigned integer | 8 bits | State transition type (defined in [rs-dpp](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transition_types.rs#L21)):<br>`0` - [data contract create](../protocol-ref/data-contract.md#data-contract-create)<br>`1` - [batch](#batch)<br>`2` - [identity create](../protocol-ref/identity.md#identity-create)<br>`3` - [identity topup](identity.md#identity-topup)<br>`4` - [data contract update](data-contract.md#data-contract-update)<br>`5` - [identity update](identity.md#identity-update)<br>`6` - [identity credit withdrawal](identity.md#identity-credit-withdrawal)<br>`7` - [identity credit transfer](identity.md#identity-credit-transfer)<br>`8` - [masternode vote](#masternode-vote)<br>`9` - [identity credit transfer to addresses](address-system.md#identity-credit-transfer-to-addresses)<br>`10` - [identity create from addresses](address-system.md#identity-create-from-addresses)<br>`11` - [identity topup from addresses](address-system.md#identity-topup-from-addresses)<br>`12` - [address funds transfer](address-system.md#address-funds-transfer)<br>`13` - [address funding from asset lock](address-system.md#address-funding-from-asset-lock)<br>`14` - [address credit withdrawal](address-system.md#address-credit-withdrawal)<br>`15` - [shield](shielded-pool.md#shield)<br>`16` - [shielded transfer](shielded-pool.md#shielded-transfer)<br>`17` - [unshield](shielded-pool.md#unshield)<br>`18` - [shield from asset lock](shielded-pool.md#shield-from-asset-lock)<br>`19` - [shielded withdrawal](shielded-pool.md#shielded-withdrawal) |
29
+
| type | unsigned integer | 8 bits | State transition type discriminator (defined in [rs-dpp](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transition_types.rs#L21)). See [State Transition Types](#state-transition-types) for the full list. |
30
30
| userFeeIncrease | unsigned integer | 16 bits | Extra fee to prioritize processing if the mempool is full. Typically set to zero. |
31
31
| signature | array of bytes | 65 bytes |Signature of state transition data |
32
32
@@ -42,85 +42,40 @@ Additionally, all state transitions except the identity create and topup state t
42
42
43
43
## State Transition Types
44
44
45
-
Dash Platform Protocol defines the [state transition types](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transition_types.rs#L21-L43) that perform identity, contract, document, and token operations. See the subsections below for details on each state transition type.
45
+
Dash Platform Protocol defines the following [state transition types](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transition_types.rs#L21-L43). Most are documented in detail on the protocol reference page for the feature they operate on. Batch and Masternode Vote do not have a dedicated feature page; their formats are documented inline below.
46
+
47
+
| Type | Name | Documented in |
48
+
| --- | --- | --- |
49
+
| 0 | Data Contract Create |[Data Contract Create](data-contract.md#data-contract-create)|
| ownerId | array of bytes | 32 bytes |[Identity](../protocol-ref/identity.md) submitting the document(s) |
74
+
| ownerId | array of bytes | 32 bytes |[Identity](../protocol-ref/identity.md) submitting the document(s) or token action(s) |
52
75
| transitions | array of transition objects | Varies | A batch of [document](../protocol-ref/document.md#document-overview) or token actions (currently limited to [1 object per batch](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-platform-version/src/version/system_limits/v1.rs#L7)) |
53
76
54
77
More detailed information about the `transitions` array can be found in the [document section](../protocol-ref/document.md). See the implementation in [rs-dpp](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transitions/document/batch_transition/v1/mod.rs#L31-L39).
| assetLockProof | array of bytes | 36 bytes | Lock [outpoint](https://docs.dash.org/en/stable/docs/core/resources/glossary.html#outpoint) from the layer 1 locking transaction (36 bytes) |
79
-
| publicKeys | array of keys | Varies |[Public key(s)](../protocol-ref/identity.md#identity-publickeys) associated with the identity (maximum number of keys: `6`) |
80
-
81
-
More detailed information about the `publicKeys` object can be found in the [identity section](../protocol-ref/identity.md).
| assetLockProof | array of bytes | 36 bytes | Lock [outpoint](https://docs.dash.org/en/stable/docs/core/resources/glossary.html#outpoint) from the layer 1 locking transaction (36 bytes) |
88
-
| identityId | array of bytes | 32 bytes | An [Identity ID](../protocol-ref/identity.md#identity-id) for the identity receiving the topup (can be any identity) (32 bytes) |
| identityId | array of bytes | 32 bytes | The [Identity ID](../protocol-ref/identity.md#identity-id) for the identity being updated |
95
-
| revision | unsigned integer | 64 bits | Identity update revision. Used for optimistic concurrency control. Incremented by one with each new update so that the update will fail if the underlying data is modified between reading and writing. |
96
-
| nonce | unsigned integer | 64 bits | Identity nonce for this transition to prevent replay attacks |
97
-
| addPublicKeys | array of public keys | Varies | (Optional) Array of up to 6 new public keys to add to the identity. Required if adding keys. |
98
-
| disablePublicKeys | array of integers | Varies | (Optional) Array of up to 10 existing identity public key ID(s) to disable for the identity. Required if disabling keys. |
| identityId | array of bytes | 32 bytes | An [Identity ID](../protocol-ref/identity.md#identity-id) for the identity sending the credits |
105
-
| recipientId | array of bytes | 32 bytes | An [Identity ID](../protocol-ref/identity.md#identity-id) for the identity receiving the credits |
106
-
| amount | unsigned integer | 64 bits | Number of credits being transferred |
107
-
| nonce | unsigned integer | 64 bits | Identity nonce for this transition to prevent replay attacks |
108
-
109
-
See the implementation in [rs-dpp](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transitions/identity/identity_credit_transfer_transition/v0/mod.rs#L42-L53).
| identityId | array of bytes | 32 bytes | An [Identity ID](../protocol-ref/identity.md#identity-id) for the identity sending the credits |
116
-
| amount | unsigned integer | 64 bits | Number of credits being transferred |
117
-
| coreFeePerByte | unsigned integer | 32 bits ||
118
-
| pooling | unsigned integer | 8 bits | 0 = Never, 1 = If Available, 2 = Standard |
119
-
| outputScript | script | Varies | If None, the withdrawal is sent to the address set by Core |
120
-
| nonce | unsigned integer | 64 bits | Identity nonce for this transition to prevent replay attacks |
121
-
122
-
See the implementation in [rs-dpp](https://github.com/dashpay/platform/blob/v3.1-dev/packages/rs-dpp/src/state_transition/state_transitions/identity/identity_credit_withdrawal_transition/v1/mod.rs#L35-L48).
Copy file name to clipboardExpand all lines: docs/reference/dapi-endpoints-platform-endpoints.md
-33Lines changed: 0 additions & 33 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4627,39 +4627,6 @@ Returns compacted nullifier additions from a specified block height. Compacted c
4627
4627
|`start_block_height`| String (uint64) | Yes | Block height to start from (as a string due to uint64 size) |
4628
4628
|`prove`| Boolean | No | Set to `true` to receive a proof that contains the requested changes |
4629
4629
4630
-
## Deprecated Endpoints
4631
-
4632
-
The following endpoints were recently deprecated. See the [previous version of documentation](https://docs.dash.org/projects/platform/en/2.0.0/docs/reference/dapi-endpoints-platform-endpoints.html) for additional information on these endpoints.
4633
-
4634
-
### getIdentities
4635
-
4636
-
:::{attention}
4637
-
Deprecated in Dash Platform v1.0.0
4638
-
:::
4639
-
4640
-
**Returns**: [Identity](../explanations/identity.md) information for the requested identities
4641
-
4642
-
**Parameters**:
4643
-
4644
-
| Name | Type | Required | Description |
4645
-
| ------- | ------- | -------- | ------------ |
4646
-
| `ids` | Array | Yes | An array of identity IDs
4647
-
| `prove` | Boolean | No | Set to `true` to receive a proof that contains the requested identity
4648
-
4649
-
### getIdentitiesByPublicKeyHashes
4650
-
4651
-
:::{attention}
4652
-
Deprecated in Dash Platform v1.0.0
4653
-
:::
4654
-
4655
-
**Returns**: An array of [identities](../explanations/identity.md) associated with the provided public key hashes
Copy file name to clipboardExpand all lines: docs/reference/dapi-endpoints.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -43,7 +43,7 @@ without introducing issues for endpoint consumers.
43
43
|[`getIdentity`](../reference/dapi-endpoints-platform-endpoints.md#getidentity)| Returns the requested identity |
44
44
|[`getIdentityBalance`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybalance)| Returns the requested identity's balance |
45
45
|[`getIdentityBalanceAndRevision`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybalanceandrevision)| Returns the requested identity's balance and revision |
46
-
|[`getIdentityByNonUniquePublicKeyHash`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybynonuniquepublickeyhash)|**Added in Dash Platform v2.0.0**<br>Returns one or more identities associated with a public key hash, including for non-unique masternode keys. |
46
+
|[`getIdentityByNonUniquePublicKeyHash`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybynonuniquepublickeyhash)|*Added in Dash Platform v2.0.0*<br>Returns one or more identities associated with a public key hash, including for non-unique masternode keys. |
47
47
|[`getIdentityByPublicKeyHash`](../reference/dapi-endpoints-platform-endpoints.md#getidentitybypublickeyhash)| Returns the identity associated with the provided public key hash |
48
48
|[`getIdentityContractNonce`](../reference/dapi-endpoints-platform-endpoints.md#getidentitycontractnonce)| Returns the identity contract nonce |
49
49
|[`getIdentityKeys`](../reference/dapi-endpoints-platform-endpoints.md#getidentitykeys)| Returns the requested identity keys |
@@ -80,7 +80,7 @@ Security groups provide a way to distribute token configuration and update autho
80
80
|[`getEvonodesProposedEpochBlocksByIds`](../reference/dapi-endpoints-platform-endpoints.md#getevonodesproposedepochblocksbyids)|*Added in Dash Platform v1.3.0*<br>Retrieves the number of blocks proposed by the specified evonodes in a certain epoch, based on their IDs |
81
81
|[`getEvonodesProposedEpochBlocksByRange`](../reference/dapi-endpoints-platform-endpoints.md#getevonodesproposedepochblocksbyrange)|*Added in Dash Platform v1.3.0*<br>Retrieves the number of blocks proposed by evonodes for a specified epoch |
82
82
|[`getEpochsInfo`](../reference/dapi-endpoints-platform-endpoints.md#getepochsinfo)| Returns information about the requested epoch(s) |
83
-
|[`getFinalizedEpochInfos`](../reference/dapi-endpoints-platform-endpoints.md#getfinalizedepochinfos)|**Added in Dash Platform v2.0.0**<br>Retrieves finalized epoch information within a specified index range |
83
+
|[`getFinalizedEpochInfos`](../reference/dapi-endpoints-platform-endpoints.md#getfinalizedepochinfos)|*Added in Dash Platform v2.0.0*<br>Retrieves finalized epoch information within a specified index range |
84
84
|[`getPathElements`](../reference/dapi-endpoints-platform-endpoints.md#getpathelements)|*Added in Dash Platform v1.0.0*<br>Returns elements for a specified path in the Platform |
85
85
|[`getPrefundedSpecializedBalance`](../reference/dapi-endpoints-platform-endpoints.md#getprefundedspecializedbalance)|*Added in Dash Platform v1.0.0*<br>Returns the pre-funded specialized balance for a specific identity |
86
86
|[`getProtocolVersionUpgradeState`](../reference/dapi-endpoints-platform-endpoints.md#getprotocolversionupgradestate)| Returns the number of votes cast for each protocol version |
Copy file name to clipboardExpand all lines: docs/reference/data-contracts.md
+13-9Lines changed: 13 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -249,14 +249,16 @@ The `indices` array consists of one or more objects that each contain:
249
249
* An optional `nullSearchable` element that indicates whether the index allows searching for NULL values. If nullSearchable is false (default: true) and all properties of the index are null then no reference is added.
250
250
* An optional `contested` element that determines if duplicate values are allowed for the document
251
251
252
-
```json
253
-
"indices": [
252
+
:::{code-block} json
253
+
:force:
254
+
255
+
"indices": [
254
256
{
255
257
"name": "<indexnamea>",
256
258
"properties": [
257
259
{ "<fieldnamea>": "<asc"|"desc>" },
258
260
{ "<fieldnameb>": "<asc"|"desc>" }
259
-
],
261
+
],
260
262
"unique": true|false,
261
263
"nullSearchable": true|false,
262
264
"contested": {
@@ -273,10 +275,10 @@ The `indices` array consists of one or more objects that each contain:
273
275
"name": "<indexnameb>",
274
276
"properties": [
275
277
{ "<fieldnamec>": "<asc"|"desc>" },
276
-
],
277
-
}
278
+
],
279
+
}
278
280
]
279
-
```
281
+
:::
280
282
281
283
#### Contested indices
282
284
@@ -343,10 +345,12 @@ The following example (excerpt from the DPNS contract's `preorder` document) cre
343
345
344
346
This example syntax shows the structure of a document object including all optional properties.
345
347
346
-
:::{dropdown} Document schema
348
+
::::{dropdown} Document schema
347
349
:open:
348
350
349
-
```json
351
+
:::{code-block} json
352
+
:force:
353
+
350
354
{
351
355
"<documentnamea>": {
352
356
"documentsKeepHistory": true|false,
@@ -411,8 +415,8 @@ This example syntax shows the structure of a document object including all optio
0 commit comments