feat(sdk)!: make document state transition entropy optional, will do a replace if revision is not 1. (#2658)

Author: QuantumExplorer

packages/rs-sdk/src/platform/transition/put_document.rs

@@ -2,9 +2,11 @@ use super::broadcast::BroadcastStateTransition;
 use super::waitable::Waitable;
 use crate::platform::transition::put_settings::PutSettings;
 use crate::{Error, Sdk};
+use dpp::dashcore::secp256k1::rand::rngs::StdRng;
+use dpp::dashcore::secp256k1::rand::{Rng, SeedableRng};
 use dpp::data_contract::document_type::accessors::DocumentTypeV0Getters;
 use dpp::data_contract::document_type::DocumentType;
-use dpp::document::{Document, DocumentV0Getters};
+use dpp::document::{Document, DocumentV0Getters, DocumentV0Setters, INITIAL_REVISION};
 use dpp::identity::signer::Signer;
 use dpp::identity::IdentityPublicKey;
 use dpp::state_transition::batch_transition::methods::v0::DocumentsBatchTransitionMethodsV0;
@@ -22,7 +24,7 @@ pub trait PutDocument<S: Signer>: Waitable {
         &self,
         sdk: &Sdk,
         document_type: DocumentType,
-        document_state_transition_entropy: [u8; 32],
+        document_state_transition_entropy: Option<[u8; 32]>,
         identity_public_key: IdentityPublicKey,
         token_payment_info: Option<TokenPaymentInfo>,
         signer: &S,
@@ -35,7 +37,7 @@ pub trait PutDocument<S: Signer>: Waitable {
         &self,
         sdk: &Sdk,
         document_type: DocumentType,
-        document_state_transition_entropy: [u8; 32],
+        document_state_transition_entropy: Option<[u8; 32]>,
         identity_public_key: IdentityPublicKey,
         token_payment_info: Option<TokenPaymentInfo>,
         signer: &S,
@@ -49,7 +51,7 @@ impl<S: Signer> PutDocument<S> for Document {
         &self,
         sdk: &Sdk,
         document_type: DocumentType,
-        document_state_transition_entropy: [u8; 32],
+        document_state_transition_entropy: Option<[u8; 32]>,
         identity_public_key: IdentityPublicKey,
         token_payment_info: Option<TokenPaymentInfo>,
         signer: &S,
@@ -65,19 +67,48 @@ impl<S: Signer> PutDocument<S> for Document {
             .await?;
 
         let settings = settings.unwrap_or_default();
-
-        let transition = BatchTransition::new_document_creation_transition_from_document(
-            self.clone(),
-            document_type.as_ref(),
-            document_state_transition_entropy,
-            &identity_public_key,
-            new_identity_contract_nonce,
-            settings.user_fee_increase.unwrap_or_default(),
-            token_payment_info,
-            signer,
-            sdk.version(),
-            settings.state_transition_creation_options,
-        )?;
+        let transition = if self.revision().is_some()
+            && self.revision().unwrap() != INITIAL_REVISION
+        {
+            BatchTransition::new_document_replacement_transition_from_document(
+                self.clone(),
+                document_type.as_ref(),
+                &identity_public_key,
+                new_identity_contract_nonce,
+                settings.user_fee_increase.unwrap_or_default(),
+                token_payment_info,
+                signer,
+                sdk.version(),
+                settings.state_transition_creation_options,
+            )
+        } else {
+            let (document, document_state_transition_entropy) = document_state_transition_entropy
+                .map(|entropy| (self.clone(), entropy))
+                .unwrap_or_else(|| {
+                    let mut rng = StdRng::from_entropy();
+                    let mut document = self.clone();
+                    let entropy = rng.gen::<[u8; 32]>();
+                    document.set_id(Document::generate_document_id_v0(
+                        &document_type.data_contract_id(),
+                        &document.owner_id(),
+                        document_type.name(),
+                        entropy.as_slice(),
+                    ));
+                    (document, entropy)
+                });
+            BatchTransition::new_document_creation_transition_from_document(
+                document,
+                document_type.as_ref(),
+                document_state_transition_entropy,
+                &identity_public_key,
+                new_identity_contract_nonce,
+                settings.user_fee_increase.unwrap_or_default(),
+                token_payment_info,
+                signer,
+                sdk.version(),
+                settings.state_transition_creation_options,
+            )
+        }?;
 
         // response is empty for a broadcast, result comes from the stream wait for state transition result
         transition.broadcast(sdk, Some(settings)).await?;
@@ -88,7 +119,7 @@ impl<S: Signer> PutDocument<S> for Document {
         &self,
         sdk: &Sdk,
         document_type: DocumentType,
-        document_state_transition_entropy: [u8; 32],
+        document_state_transition_entropy: Option<[u8; 32]>,
         identity_public_key: IdentityPublicKey,
         token_payment_info: Option<TokenPaymentInfo>,
         signer: &S,