feat(platform)!: token payment info (#2517)

Author: QuantumExplorer

packages/rs-dpp/schema/meta_schemas/document/v0/document-meta.json

@@ -287,6 +287,50 @@
           }
         }
       ]
+    },
+    "documentActionTokenCost": {
+      "type": "object",
+      "properties": {
+        "contractId": {
+          "type": "array",
+          "contentMediaType": "application/x.dash.dpp.identifier",
+          "byteArray": true,
+          "minItems": 32,
+          "maxItems": 32
+        },
+        "tokenPosition": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 65535
+        },
+        "amount": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 281474976710655
+        },
+        "effect": {
+          "type": "integer",
+          "enum": [
+            0,
+            1
+          ],
+          "description": "0 - TransferTokenToContractOwner (default), 1 - Burn"
+        },
+        "gasFeesPaidBy": {
+          "type": "integer",
+          "enum": [
+            0,
+            1,
+            2
+          ],
+          "description": "0 - DocumentOwner (default), 1 - ContractOwner, 2 - PreferContractOwner"
+        }
+      },
+      "required": [
+        "tokenPosition",
+        "amount"
+      ],
+      "additionalProperties": false
     }
   },
   "properties": {
@@ -453,6 +497,30 @@
       ],
       "description": "Key requirements. 0 - Unique Non Replaceable, 1 - Multiple, 2 - Multiple with reference to latest key."
     },
+    "tokenCost": {
+      "type": "object",
+      "properties": {
+        "create": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        },
+        "replace": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        },
+        "delete": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        },
+        "transfer": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        },
+        "update_price": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        },
+        "purchase": {
+          "$ref": "#/$defs/documentActionTokenCost"
+        }
+      },
+      "additionalProperties": false
+    },
     "properties": {
       "type": "object",
       "additionalProperties": {

packages/rs-dpp/src/core_types/validator_set/v0/mod.rs

@@ -9,6 +9,7 @@ use bincode::error::EncodeError;
 #[cfg(feature = "core-types-serialization")]
 use bincode::{BorrowDecode, Decode, Encode};
 use dashcore::blsful::Bls12381G2Impl;
+#[cfg(feature = "core-types-serialization")]
 use dashcore::hashes::Hash;
 use dashcore::{ProTxHash, QuorumHash};
 use itertools::Itertools;
@@ -18,7 +19,7 @@ use std::collections::BTreeMap;
 use std::fmt;
 use std::fmt::{Debug, Display, Formatter};
 
-/// The validator set is only slightly different from a quorum as it does not contain non valid
+/// The validator set is only slightly different from a quorum as it does not contain non-valid
 /// members
 #[derive(Clone, Eq, PartialEq)]
 #[cfg_attr(

packages/rs-dpp/src/data_contract/document_type/accessors/mod.rs

@@ -8,20 +8,28 @@ use crate::data_contract::document_type::{DocumentType, DocumentTypeMutRef, Docu
 
 use platform_value::{Identifier, Value};
 
-use crate::balances::credits::TokenAmount;
 use crate::data_contract::document_type::restricted_creation::CreationRestrictionMode;
 #[cfg(feature = "validation")]
 use crate::data_contract::document_type::validator::StatelessJsonSchemaLazyValidator;
 use crate::data_contract::storage_requirements::keys_for_document_type::StorageKeyRequirements;
-use crate::data_contract::TokenContractPosition;
 use crate::document::transfer::Transferable;
 use crate::identity::SecurityLevel;
 use crate::nft::TradeMode;
+use crate::tokens::token_amount_on_contract_token::DocumentActionTokenCost;
 use indexmap::IndexMap;
 use std::collections::{BTreeMap, BTreeSet};
 pub use v0::*;
 pub use v1::*;
 
+impl DocumentTypeV0MutGetters for DocumentType {
+    fn schema_mut(&mut self) -> &mut Value {
+        match self {
+            DocumentType::V0(v0) => v0.schema_mut(),
+            DocumentType::V1(v1) => v1.schema_mut(),
+        }
+    }
+}
+
 impl DocumentTypeV0Getters for DocumentType {
     fn name(&self) -> &String {
         match self {
@@ -195,6 +203,50 @@ impl DocumentTypeV0Setters for DocumentType {
     }
 }
 
+impl DocumentTypeV1Setters for DocumentType {
+    fn set_document_creation_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_creation_token_cost(cost),
+        }
+    }
+
+    fn set_document_replacement_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_replacement_token_cost(cost),
+        }
+    }
+
+    fn set_document_deletion_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_deletion_token_cost(cost),
+        }
+    }
+
+    fn set_document_transfer_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_transfer_token_cost(cost),
+        }
+    }
+
+    fn set_document_price_update_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_price_update_token_cost(cost),
+        }
+    }
+
+    fn set_document_purchase_token_cost(&mut self, cost: Option<DocumentActionTokenCost>) {
+        match self {
+            DocumentType::V0(_) => { /* no-op */ }
+            DocumentType::V1(v1) => v1.set_document_purchase_token_cost(cost),
+        }
+    }
+}
+
 impl DocumentTypeV0Getters for DocumentTypeRef<'_> {
     fn name(&self) -> &String {
         match self {
@@ -532,42 +584,42 @@ impl DocumentTypeV0Setters for DocumentTypeMutRef<'_> {
 }
 
 impl DocumentTypeV1Getters for DocumentType {
-    fn document_creation_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_creation_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_creation_token_cost(),
         }
     }
 
-    fn document_replacement_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_replacement_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_replacement_token_cost(),
         }
     }
 
-    fn document_deletion_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_deletion_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_deletion_token_cost(),
         }
     }
 
-    fn document_transfer_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_transfer_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_transfer_token_cost(),
         }
     }
 
-    fn document_update_price_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_update_price_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_update_price_token_cost(),
         }
     }
 
-    fn document_purchase_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_purchase_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentType::V0(_) => None,
             DocumentType::V1(v1) => v1.document_purchase_token_cost(),
@@ -576,42 +628,42 @@ impl DocumentTypeV1Getters for DocumentType {
 }
 
 impl DocumentTypeV1Getters for DocumentTypeRef<'_> {
-    fn document_creation_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_creation_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_creation_token_cost(),
         }
     }
 
-    fn document_replacement_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_replacement_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_replacement_token_cost(),
         }
     }
 
-    fn document_deletion_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_deletion_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_deletion_token_cost(),
         }
     }
 
-    fn document_transfer_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_transfer_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_transfer_token_cost(),
         }
     }
 
-    fn document_update_price_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_update_price_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_update_price_token_cost(),
         }
     }
 
-    fn document_purchase_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_purchase_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeRef::V0(_) => None,
             DocumentTypeRef::V1(v1) => v1.document_purchase_token_cost(),
@@ -620,42 +672,42 @@ impl DocumentTypeV1Getters for DocumentTypeRef<'_> {
 }
 
 impl DocumentTypeV1Getters for DocumentTypeMutRef<'_> {
-    fn document_creation_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_creation_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_creation_token_cost(),
         }
     }
 
-    fn document_replacement_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_replacement_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_replacement_token_cost(),
         }
     }
 
-    fn document_deletion_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_deletion_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_deletion_token_cost(),
         }
     }
 
-    fn document_transfer_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_transfer_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_transfer_token_cost(),
         }
     }
 
-    fn document_update_price_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_update_price_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_update_price_token_cost(),
         }
     }
 
-    fn document_purchase_token_cost(&self) -> Option<(TokenContractPosition, TokenAmount)> {
+    fn document_purchase_token_cost(&self) -> Option<DocumentActionTokenCost> {
         match self {
             DocumentTypeMutRef::V0(_) => None,
             DocumentTypeMutRef::V1(v1) => v1.document_purchase_token_cost(),

packages/rs-dpp/src/data_contract/document_type/accessors/v0/mod.rs

@@ -14,6 +14,11 @@ use crate::nft::TradeMode;
 use indexmap::IndexMap;
 use std::collections::{BTreeMap, BTreeSet};
 
+pub trait DocumentTypeV0MutGetters {
+    /// Gets the schema as mut
+    fn schema_mut(&mut self) -> &mut Value;
+}
+
 pub trait DocumentTypeV0Getters {
     /// Returns the name of the document type.
     fn name(&self) -> &String;