Skip to content

Commit 4c9fe56

Browse files
authored
docs(ref): more updates (#103)
* docs(ref): update state transition signing info, part 1 * docs(ref): clarify st signing process * docs(ref): heading rename * docs(ref): update st info tables * docs(ref): add start of identity credit transfer and withdrawal info * docs(ref): add partial masternode vote st info * refactor: update table * docs: refine st signing info - Divide up info per feedback from Ivan - Update intro info * docs(ref): re-order sts * docs: add missing st to explanation table
1 parent 4e45155 commit 4c9fe56

File tree

4 files changed

+147
-77
lines changed

4 files changed

+147
-77
lines changed

docs/explanations/platform-protocol-state-transition.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,13 @@ The following table contains a list of currently defined payload types:
3838
| - | - |
3939
| [Data Contract Create](../protocol-ref/data-contract.md#data-contract-creation) (`0`) | [Database schema](../explanations/platform-protocol-data-contract.md) for a single application |
4040
| [Batch](../protocol-ref/document.md#document-submission) (`1`) | An array of 1 or more [document](../explanations/platform-protocol-document.md) or token transition objects |
41-
| [Identity Create](../protocol-ref/identity.md#identity-creation) (`2`) | Information including the public keys required to create a new [Identity](../explanations/identity.md) |
41+
| [Identity Create](../protocol-ref/identity.md#identity-create) (`2`) | Information including the public keys required to create a new [Identity](../explanations/identity.md) |
4242
| [Identity Topup](../protocol-ref/identity.md#identity-topup) (`3`) | Information including proof of a transaction containing an amount to add to the provided identity's balance |
4343
| [Data Contract Update](../protocol-ref/data-contract.md#data-contract-update) (`4`) | An updated [database schema](../explanations/platform-protocol-data-contract.md) to modify an existing application |
4444
| [Identity Update](../protocol-ref/identity.md#identity-update) (`5`) | A set of one or more new public keys to add to the [identity](../explanations/identity.md) or a list of existing keys to disable |
4545
| [Identity Credit Withdrawal](../protocol-ref/identity.md) (`6`) | Information required to withdraw credits from Dash Platform |
4646
| [Identity Credit Transfer](../protocol-ref/identity.md) (`7`) | Information required to transfer credits |
47+
| Masternode Vote (`8`) | Contested resource vote details (e.g., [DPNS premium name vote](../explanations/dpns.md#conflict-resolution)) |
4748

4849
### Application Usage
4950

docs/protocol-ref/identity.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -133,9 +133,9 @@ Each identity has a balance of credits established by an [asset lock transaction
133133

134134
## Identity State Transition Details
135135

136-
There are five identity-related state transitions: [identity create](#identity-creation), [identity topup](#identity-topup), [identity update](#identity-update), [identity credit transfer](#identity-credit-transfer), and [identity credit withdrawal](#identity-credit-withdrawal). Details are provided in this section including information about [asset locking](#asset-lock) and [signing](#identity-state-transition-signing) required for these state transitions.
136+
There are five identity-related state transitions: [identity create](#identity-create), [identity topup](#identity-topup), [identity update](#identity-update), [identity credit transfer](#identity-credit-transfer), and [identity credit withdrawal](#identity-credit-withdrawal). Details are provided in this section including information about [asset locking](#asset-lock) and [signing](#identity-state-transition-signing) required for these state transitions.
137137

138-
### Identity Creation
138+
### Identity Create
139139

140140
Identities are created on the platform by submitting the identity information in an identity create state transition.
141141

@@ -225,7 +225,7 @@ See the [identity credit withdrawal implementation in rs-dpp](https://github.com
225225

226226
### Asset Lock
227227

228-
The [identity create](#identity-creation) and [identity topup](#identity-topup) state transitions both include an asset lock proof object. This object references the Core chain [asset lock transaction](inv:user:std#ref-txs-assetlocktx) and includes proof that the transaction is locked.
228+
The [identity create](#identity-create) and [identity topup](#identity-topup) state transitions both include an asset lock proof object. This object references the Core chain [asset lock transaction](inv:user:std#ref-txs-assetlocktx) and includes proof that the transaction is locked.
229229

230230
Currently there are two types of asset lock proofs [defined by rs-dpp](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/identity/state_transition/asset_lock_proof/mod.rs#L129-L132): InstantSend and ChainLock. Transactions almost always receive InstantSend locks, so the InstantSend asset lock proof is the predominate type. See rs-dpp for examples of using [InstantSend](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/identity/state_transition/asset_lock_proof/instant/instant_asset_lock_proof.rs) or [ChainLocks](https://github.com/dashpay/platform/blob/v2.0-dev/packages/rs-dpp/src/identity/state_transition/asset_lock_proof/chain/chain_asset_lock_proof.rs) as the asset lock proof.
231231

docs/protocol-ref/overview.md

Lines changed: 0 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -19,35 +19,3 @@ The current reference implementation is the (Rust) [rs-dpp](https://github.com/d
1919
## Release Notes
2020

2121
Release notes for past versions are located on the [dashpay/platform GitHub release page](https://github.com/dashpay/platform/releases). They provide information about breaking changes, features, and fixes.
22-
23-
## Topics
24-
25-
[Identities](../protocol-ref/identity.md)
26-
27-
- [Create](../protocol-ref/identity.md#identity-creation)
28-
- [TopUp](../protocol-ref/identity.md#identity-topup)
29-
30-
[Data Contracts](../protocol-ref/data-contract.md)
31-
32-
- [Documents](../protocol-ref/data-contract.md#data-contract-documents)
33-
- [Properties](../protocol-ref/data-contract.md#document-properties)
34-
- [Indices](../protocol-ref/data-contract.md#document-indices)
35-
- [Definitions](../protocol-ref/data-contract.md#data-contract-definitions)
36-
37-
[Document](../protocol-ref/document.md)
38-
39-
[State Transitions](../protocol-ref/state-transition.md)
40-
41-
- [Overview / general structure](../protocol-ref/state-transition.md)
42-
- Types
43-
- [Identity Create ST](../protocol-ref/identity.md#identity-creation)
44-
- [Data Contract ST](../protocol-ref/data-contract.md#data-contract-creation)
45-
- [Batch ST](../protocol-ref/document.md)
46-
- Document Transitions
47-
- [Document Transition Base](../protocol-ref/document.md#document-base-transition)
48-
- [Document Create Transition](../protocol-ref/document.md#document-create-transition)
49-
- [Document Replace Transition](../protocol-ref/document.md#document-replace-transition)
50-
- [Document Delete Transition](../protocol-ref/document.md#document-delete-transition)
51-
- [Signing](../protocol-ref/state-transition.md#state-transition-signing)
52-
53-
[Data Triggers](../protocol-ref/data-trigger.md)

0 commit comments

Comments
 (0)