State Transition
New site!
All content has been migrated to docs.dash.org. You will be automatically redirected momentarily.
State Transition Overview
State transitions are the means for submitting data that creates, updates, or deletes platform data and results in a change to a new state. Each one must contain:
- Common fields present in all state transitions
- Additional fields specific to the type of action the state transition provides (e.g. creating an identity)
Fees
State transition fees are paid via the credits established when an identity is created. Credits are created at a rate of 1000 credits/satoshi. Fees for actions vary based on parameters related to storage and computational effort that are defined in rs-dpp.
Size
All serialized data (including state transitions) is limited to a maximum size of 16 KB.
Common Fields
All state transitions include the following fields:
Field | Type | Description |
---|---|---|
protocolVersion | integer | The platform protocol version (currently 1 ) |
type | integer | State transition type:0 - data contract create1 - documents batch2 - identity create3 - identity topup4 - data contract update5 - identity update |
signature | array of bytes | Signature of state transition data (65 bytes) |
Additionally, all state transitions except the identity create and topup state transitions include:
Field | Type | Description |
---|---|---|
signaturePublicKeyId | integer | The id of the identity public key that signed the state transition (=> 0 ) |
State Transition Types
Data Contract Create
Field | Type | Description |
---|---|---|
dataContract | data contract object | Object containing valid data contract details |
entropy | array of bytes | Entropy used to generate the data contract ID (32 bytes) |
More detailed information about the dataContract
object can be found in the data contract section.
Entropy Generation
Entropy is included in Data Contracts and Documents.
// From the Rust reference implementation (rs-dpp)
// entropyGenerator.js
fn generate(&self) -> anyhow::Result<[u8; 32]> {
let mut buffer = [0u8; 32];
getrandom(&mut buffer).context("generating entropy failed")?;
Ok(buffer)
}
Data Contract Update
Field | Type | Description |
---|---|---|
dataContract | data contract object | Object containing valid data contract details |
More detailed information about the dataContract
object can be found in the data contract section.
Documents Batch
Field | Type | Description |
---|---|---|
ownerId | array of bytes | Identity submitting the document(s) (32 bytes) |
transitions | array of transition objects | Document create , replace , or delete transitions (up to 10 objects) |
More detailed information about the transitions
array can be found in the document section.
Identity Create
Field | Type | Description |
---|---|---|
assetLockProof | array of bytes | Lock outpoint from the layer 1 locking transaction (36 bytes) |
publicKeys | array of keys | Public key(s) associated with the identity (maximum number of keys: 10 ) |
More detailed information about the publicKeys
object can be found in the identity section.
Identity TopUp
Field | Type | Description |
---|---|---|
assetLockProof | array of bytes | Lock outpoint from the layer 1 locking transaction (36 bytes) |
identityId | array of bytes | An Identity ID for the identity receiving the topup (can be any identity) (32 bytes) |
Identity Update
Field | Type | Description |
---|---|---|
identityId | array of bytes | The Identity ID for the identity being updated (32 bytes) |
revision | integer | 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. |
addPublicKeys | array of public keys | (Optional) Array of up to 10 new public keys to add to the identity. Required if adding keys. |
disablePublicKeys | array of integers | (Optional) Array of up to 10 existing identity public key ID(s) to disable for the identity. Required if disabling keys. |
publicKeysDisabledAt | integer | (Optional) Timestamp when keys were disabled. Required if disablePublicKeys is present. |
State Transition Signing
State transitions must be signed by a private key associated with the identity creating the state transition. Since v0.23, each identity must have at least two keys: a primary key (security level 0
) that is only used when signing identity update state transitions and an additional key (security level 2
) that is used to sign all other state transitions.
The process to sign a state transition consists of the following steps:
- Canonical CBOR encode the state transition data - this include all ST fields except the
signature
andsignaturePublicKeyId
- Sign the encoded data with a private key associated with the identity creating the state transition
- Set the state transition
signature
to the value of the signature created in the previous step - For all state transitions other than identity create or topup, set the state transition
signaturePublicKeyId
to the public keyid
corresponding to the key used to sign
Signature Validation
The signature
validation (see js-dpp) verifies that:
- The identity exists
- The identity has a public key
- The identity's public key is of type
ECDSA
- The state transition signature is valid
The example test output below shows the necessary criteria:
validateStateTransitionIdentitySignatureFactory
β should pass properly signed state transition
β should return invalid result if owner id doesn't exist
β should return MissingPublicKeyError if the identity doesn't have a matching public key
β should return InvalidIdentityPublicKeyTypeError if type is not exist
β should return InvalidStateTransitionSignatureError if signature is invalid
Consensus errors
β should return InvalidSignaturePublicKeySecurityLevelConsensusError if InvalidSignaturePublicKeySecurityLevelError was thrown
β should return PublicKeySecurityLevelNotMetConsensusError if PublicKeySecurityLevelNotMetError was thrown
β should return WrongPublicKeyPurposeConsensusError if WrongPublicKeyPurposeError was thrown
β should return PublicKeyIsDisabledConsensusError if PublicKeyIsDisabledError was thrown
β should return InvalidStateTransitionSignatureError if DPPError was thrown
β should throw unknown error
β should not verify signature on dry run
Updated about 1 year ago