@dashevo/dpns-contract 4.0.0 → 4.1.0-beta.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dashevo/dpns-contract",
-  "version": "4.0.0",
+  "version": "4.1.0-beta.1",
   "description": "A contract and helper scripts for DPNS DApp",
   "scripts": {
     "lint": "eslint .",
@@ -31,7 +31,7 @@
   ],
   "license": "MIT",
   "devDependencies": {
-    "@dashevo/wasm-dpp": "4.0.0",
+    "@dashevo/wasm-dpp": "4.1.0-beta.1",
     "chai": "^4.3.10",
     "dirty-chai": "^2.0.1",
     "eslint": "^9.18.0",

package/schema/v2/dpns-contract-documents.json

@@ -0,0 +1,169 @@
+{
+  "domain": {
+    "documentsMutable": false,
+    "canBeDeleted": true,
+    "transferable": 1,
+    "tradeMode": 1,
+    "keepsTransferHistory": true,
+    "keepsPurchaseHistory": true,
+    "keepsPricingHistory": true,
+    "type": "object",
+    "indices": [
+      {
+        "name": "parentNameAndLabel",
+        "properties": [
+          {
+            "normalizedParentDomainName": "asc"
+          },
+          {
+            "normalizedLabel": "asc"
+          }
+        ],
+        "unique": true,
+        "contested": {
+          "fieldMatches": [
+            {
+              "field": "normalizedLabel",
+              "regexPattern": "^[a-zA-Z01-]{3,19}$"
+            }
+          ],
+          "resolution": 0,
+          "description": "If the normalized label part of this index is less than 20 characters (all alphabet a-z, A-Z, 0, 1, and -) then a masternode vote contest takes place to give out the name"
+        }
+      },
+      {
+        "name": "identityId",
+        "nullSearchable": false,
+        "properties": [
+          {
+            "records.identity": "asc"
+          }
+        ]
+      }
+    ],
+    "properties": {
+      "label": {
+        "type": "string",
+        "pattern": "^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$",
+        "minLength": 3,
+        "maxLength": 63,
+        "position": 0,
+        "description": "Domain label. e.g. 'Bob'."
+      },
+      "normalizedLabel": {
+        "type": "string",
+        "pattern": "^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-]{0,61}[a-hj-km-np-z0-9]$",
+        "maxLength": 63,
+        "position": 1,
+        "description": "Domain label converted to lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'b0b'",
+        "$comment": "Must be equal to the label in lowercase. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\"."
+      },
+      "parentDomainName": {
+        "type": "string",
+        "pattern": "^$|^[a-zA-Z0-9][a-zA-Z0-9-]{0,61}[a-zA-Z0-9]$",
+        "minLength": 0,
+        "maxLength": 63,
+        "position": 2,
+        "description": "A full parent domain name. e.g. 'dash'."
+      },
+      "normalizedParentDomainName": {
+        "type": "string",
+        "pattern": "^$|^[a-hj-km-np-z0-9][a-hj-km-np-z0-9-\\.]{0,61}[a-hj-km-np-z0-9]$",
+        "minLength": 0,
+        "maxLength": 63,
+        "position": 3,
+        "description": "A parent domain name in lowercase for case-insensitive uniqueness validation. \"o\", \"i\" and \"l\" replaced with \"0\" and \"1\" to mitigate homograph attack. e.g. 'dash'",
+        "$comment": "Must either be equal to an existing domain or empty to create a top level domain. \"o\", \"i\" and \"l\" must be replaced with \"0\" and \"1\". Only the data contract owner can create top level domains."
+      },
+      "preorderSalt": {
+        "type": "array",
+        "byteArray": true,
+        "minItems": 32,
+        "maxItems": 32,
+        "position": 4,
+        "description": "Salt used in the preorder document"
+      },
+      "records": {
+        "type": "object",
+        "properties": {
+          "identity": {
+            "type": "array",
+            "byteArray": true,
+            "minItems": 32,
+            "maxItems": 32,
+            "position": 1,
+            "contentMediaType": "application/x.dash.dpp.identifier",
+            "description": "Identifier name record that refers to an Identity"
+          }
+        },
+        "minProperties": 1,
+        "position": 5,
+        "additionalProperties": false
+      },
+      "subdomainRules": {
+        "type": "object",
+        "properties": {
+          "allowSubdomains": {
+            "type": "boolean",
+            "description": "This option defines who can create subdomains: true - anyone; false - only the domain owner",
+            "$comment": "Only the domain owner is allowed to create subdomains for non top-level domains",
+            "position": 0
+          }
+        },
+        "position": 6,
+        "description": "Subdomain rules allow domain owners to define rules for subdomains",
+        "additionalProperties": false,
+        "required": [
+          "allowSubdomains"
+        ]
+      }
+    },
+    "required": [
+      "$createdAt",
+      "$updatedAt",
+      "$transferredAt",
+      "label",
+      "normalizedLabel",
+      "normalizedParentDomainName",
+      "preorderSalt",
+      "records",
+      "subdomainRules"
+    ],
+    "transient": [
+      "preorderSalt"
+    ],
+    "additionalProperties": false,
+    "$comment": "In order to register a domain you need to create a preorder. The preorder step is needed to prevent man-in-the-middle attacks. normalizedLabel + '.' + normalizedParentDomain must not be longer than 253 chars length as defined by RFC 1035. Domain documents are immutable: modification and deletion are restricted"
+  },
+  "preorder": {
+    "documentsMutable": false,
+    "canBeDeleted": true,
+    "type": "object",
+    "indices": [
+      {
+        "name": "saltedHash",
+        "properties": [
+          {
+            "saltedDomainHash": "asc"
+          }
+        ],
+        "unique": true
+      }
+    ],
+    "properties": {
+      "saltedDomainHash": {
+        "type": "array",
+        "byteArray": true,
+        "minItems": 32,
+        "maxItems": 32,
+        "position": 0,
+        "description": "Double sha-256 of the concatenation of a 32 byte random salt and a normalized domain name"
+      }
+    },
+    "required": [
+      "saltedDomainHash"
+    ],
+    "additionalProperties": false,
+    "$comment": "Preorder documents are immutable: modification and deletion are restricted"
+  }
+}

package/src/lib.rs

@@ -1,5 +1,6 @@
 mod error;
 pub mod v1;
+pub mod v2;
 
 pub use crate::error::Error;
 use platform_value::{Identifier, IdentifierBytes32};
@@ -26,21 +27,22 @@ pub const DPNS_DASH_TLD_PREORDER_SALT: [u8; 32] = [
 pub const ID: Identifier = Identifier(IdentifierBytes32(ID_BYTES));
 pub const OWNER_ID: Identifier = Identifier(IdentifierBytes32(OWNER_ID_BYTES));
 pub fn load_definitions(platform_version: &PlatformVersion) -> Result<Option<Value>, Error> {
-    match platform_version.system_data_contracts.withdrawals {
-        1 => Ok(None),
+    match platform_version.system_data_contracts.dpns {
+        1 | 2 => Ok(None),
         version => Err(Error::UnknownVersionMismatch {
             method: "dpns_contract::load_definitions".to_string(),
-            known_versions: vec![1],
+            known_versions: vec![1, 2],
             received: version,
         }),
     }
 }
 pub fn load_documents_schemas(platform_version: &PlatformVersion) -> Result<Value, Error> {
-    match platform_version.system_data_contracts.withdrawals {
+    match platform_version.system_data_contracts.dpns {
         1 => v1::load_documents_schemas(),
+        2 => v2::load_documents_schemas(),
         version => Err(Error::UnknownVersionMismatch {
             method: "dpns_contract::load_documents_schemas".to_string(),
-            known_versions: vec![1],
+            known_versions: vec![1, 2],
             received: version,
         }),
     }

package/src/v1/mod.rs

@@ -13,6 +13,7 @@ pub mod document_types {
             pub const PREORDER_SALT: &str = "preorderSalt";
             pub const ALLOW_SUBDOMAINS: &str = "subdomainRules.allowSubdomains";
             pub const RECORDS: &str = "records";
+            pub const IDENTITY: &str = "identity";
             pub const DASH_UNIQUE_IDENTITY_ID: &str = "dashUniqueIdentityId";
             pub const DASH_ALIAS_IDENTITY_ID: &str = "dashAliasIdentityId";
         }

package/src/v2/mod.rs

@@ -0,0 +1,12 @@
+use crate::Error;
+use serde_json::Value;
+
+/// The document type names and property names are unchanged from v1 — see
+/// [`crate::v1::document_types`]. v2 only subscribes the `domain` document
+/// type to the document history system contract via the
+/// `keepsTransferHistory`, `keepsPurchaseHistory` and `keepsPricingHistory`
+/// configuration flags.
+pub fn load_documents_schemas() -> Result<Value, Error> {
+    serde_json::from_str(include_str!("../../schema/v2/dpns-contract-documents.json"))
+        .map_err(Error::InvalidSchemaJson)
+}