feat: integrate wallet contract

Cargo.toml

@@ -28,6 +28,7 @@ members = [
     "packages/simple-signer",
     "packages/rs-json-schema-compatibility-validator",
     "packages/check-features",
+    "packages/wallet-contract"
 ]
 [workspace.package]
 
@@ -37,3 +38,4 @@ rust-version = "1.80"
 tower-service = { git = "https://github.com/QuantumExplorer/tower", branch = "fix/indexMap2OnV0413" }
 tower-layer = { git = "https://github.com/QuantumExplorer/tower", branch = "fix/indexMap2OnV0413" }
 tower = { git = "https://github.com/QuantumExplorer/tower", branch = "fix/indexMap2OnV0413" }
+

Dockerfile

@@ -306,6 +306,7 @@ COPY --parents \
     packages/masternode-reward-shares-contract \
     packages/feature-flags-contract \
     packages/dpns-contract \
+    packages/wallet-contract \
     packages/data-contracts \
     packages/strategy-tests \
     packages/simple-signer \
@@ -374,6 +375,7 @@ COPY --parents \
     packages/rs-platform-value-convertible \
     packages/rs-drive-abci \
     packages/dashpay-contract \
+    packages/wallet-contract \
     packages/withdrawals-contract \
     packages/masternode-reward-shares-contract \
     packages/feature-flags-contract \
@@ -462,6 +464,7 @@ COPY --parents \
     packages/wasm-dpp \
     packages/dashpay-contract \
     packages/withdrawals-contract \
+    packages/wallet-contract \
     packages/masternode-reward-shares-contract \
     packages/feature-flags-contract \
     packages/dpns-contract \
@@ -569,6 +572,7 @@ LABEL description="Dashmate Helper Node.JS"
 
 WORKDIR /platform
 
+# TODO: Do one COPY with --parents
 COPY --from=build-dashmate-helper /platform/.yarn /platform/.yarn
 COPY --from=build-dashmate-helper /platform/package.json /platform/yarn.lock /platform/.yarnrc.yml /platform/.pnp* /platform/
 
@@ -580,6 +584,7 @@ COPY --from=build-dashmate-helper /platform/packages/js-dapi-client packages/js-
 COPY --from=build-dashmate-helper /platform/packages/js-grpc-common packages/js-grpc-common
 COPY --from=build-dashmate-helper /platform/packages/dapi-grpc packages/dapi-grpc
 COPY --from=build-dashmate-helper /platform/packages/dash-spv packages/dash-spv
+COPY --from=build-dashmate-helper /platform/packages/wallet-contract packages/wallet-contract
 COPY --from=build-dashmate-helper /platform/packages/withdrawals-contract packages/withdrawals-contract
 COPY --from=build-dashmate-helper /platform/packages/masternode-reward-shares-contract packages/masternode-reward-shares-contract
 COPY --from=build-dashmate-helper /platform/packages/feature-flags-contract packages/feature-flags-contract
@@ -646,6 +651,7 @@ RUN apk add --no-cache zeromq-dev
 
 WORKDIR /platform/packages/dapi
 
+# TODO: Do one COPY with --parents
 COPY --from=build-dapi /platform/.yarn /platform/.yarn
 COPY --from=build-dapi /platform/package.json /platform/yarn.lock /platform/.yarnrc.yml /platform/.pnp* /platform/
 # List of required dependencies. Based on:

packages/data-contracts/Cargo.toml

@@ -16,3 +16,4 @@ dpns-contract = { path = "../dpns-contract" }
 dashpay-contract = { path = "../dashpay-contract" }
 feature-flags-contract = { path = "../feature-flags-contract" }
 platform-value = { path = "../rs-platform-value" }
+wallet-contract = { path = "../wallet-contract" }

packages/data-contracts/src/error.rs

@@ -102,3 +102,20 @@ impl From<feature_flags_contract::Error> for Error {
         }
     }
 }
+
+impl From<wallet_contract::Error> for Error {
+    fn from(e: wallet_contract::Error) -> Self {
+        match e {
+            wallet_contract::Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            } => Error::UnknownVersionMismatch {
+                method,
+                known_versions,
+                received,
+            },
+            wallet_contract::Error::InvalidSchemaJson(e) => Error::InvalidSchemaJson(e),
+        }
+    }
+}

packages/data-contracts/src/lib.rs

@@ -9,6 +9,7 @@ pub use feature_flags_contract;
 pub use masternode_reward_shares_contract;
 use platform_value::Identifier;
 use platform_version::version::PlatformVersion;
+pub use wallet_contract;
 pub use withdrawals_contract;
 
 #[repr(u8)]
@@ -19,6 +20,7 @@ pub enum SystemDataContract {
     FeatureFlags = 2,
     DPNS = 3,
     Dashpay = 4,
+    Wallet = 5,
 }
 
 pub struct DataContractSource {
@@ -37,6 +39,7 @@ impl SystemDataContract {
             SystemDataContract::FeatureFlags => feature_flags_contract::ID_BYTES,
             SystemDataContract::DPNS => dpns_contract::ID_BYTES,
             SystemDataContract::Dashpay => dashpay_contract::ID_BYTES,
+            SystemDataContract::Wallet => wallet_contract::ID_BYTES,
         };
         Identifier::new(bytes)
     }
@@ -82,6 +85,13 @@ impl SystemDataContract {
                 definitions: dashpay_contract::load_definitions(platform_version)?,
                 document_schemas: dashpay_contract::load_documents_schemas(platform_version)?,
             },
+            SystemDataContract::Wallet => DataContractSource {
+                id_bytes: wallet_contract::ID_BYTES,
+                owner_id_bytes: wallet_contract::OWNER_ID_BYTES,
+                version: platform_version.system_data_contracts.wallet as u32,
+                definitions: wallet_contract::load_definitions(platform_version)?,
+                document_schemas: wallet_contract::load_documents_schemas(platform_version)?,
+            },
         };
 
         Ok(data)

packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/mod.rs

@@ -61,7 +61,7 @@ impl<C> Platform<C> {
                 previous_protocol_version,
                 platform_version,
             ),
-            None => return Ok(()),
+            None => Ok(()),
             Some(version) => Err(Error::Execution(ExecutionError::UnknownVersionMismatch {
                 method: "perform_events_on_first_block_of_protocol_change".to_string(),
                 known_versions: vec![0],

packages/rs-drive-abci/src/execution/platform_events/protocol_upgrade/perform_events_on_first_block_of_protocol_change/v0/mod.rs

@@ -4,6 +4,8 @@ use crate::platform_types::platform_state::v0::PlatformStateV0Methods;
 use crate::platform_types::platform_state::PlatformState;
 use dpp::block::block_info::BlockInfo;
 use dpp::dashcore::hashes::Hash;
+use dpp::data_contracts::SystemDataContract;
+use dpp::system_data_contracts::load_system_data_contract;
 use dpp::version::PlatformVersion;
 use dpp::version::ProtocolVersion;
 use drive::drive::identity::key::fetch::{
@@ -52,6 +54,34 @@ impl<C> Platform<C> {
             )?;
         }
 
+        if previous_protocol_version < 6 && platform_version.protocol_version >= 6 {
+            self.transition_to_version_6(block_info, transaction, platform_version)?;
+        }
+
+        Ok(())
+    }
+
+    /// Initializes the wallet contract that supports mobile wallets with additional
+    /// functionality
+    ///
+    /// This function is called during the transition from protocol version 5 to protocol version 6
+    /// and higher to set up the wallet contract in the platform.
+    fn transition_to_version_6(
+        &self,
+        block_info: &BlockInfo,
+        transaction: &Transaction,
+        platform_version: &PlatformVersion,
+    ) -> Result<(), Error> {
+        let contract = load_system_data_contract(SystemDataContract::Wallet, platform_version)?;
+
+        self.drive.insert_contract(
+            &contract,
+            *block_info,
+            true,
+            Some(transaction),
+            platform_version,
+        )?;
+
         Ok(())
     }
 

packages/rs-platform-version/src/version/system_data_contract_versions/mod.rs

@@ -9,4 +9,5 @@ pub struct SystemDataContractVersions {
     pub dashpay: FeatureVersion,
     pub masternode_reward_shares: FeatureVersion,
     pub feature_flags: FeatureVersion,
+    pub wallet: FeatureVersion,
 }

packages/rs-platform-version/src/version/system_data_contract_versions/v1.rs

@@ -7,4 +7,5 @@ pub const SYSTEM_DATA_CONTRACT_VERSIONS_V1: SystemDataContractVersions =
         dashpay: 1,
         masternode_reward_shares: 1,
         feature_flags: 1,
+        wallet: 1,
     };

packages/wallet-contract/.eslintrc

@@ -0,0 +1,18 @@
+{
+  "extends": "airbnb-base",
+  "rules": {
+    "no-plusplus": 0,
+    "eol-last": [
+      "error",
+      "always"
+    ],
+    "class-methods-use-this": "off",
+    "curly": [
+      "error",
+      "all"
+    ]
+  },
+  "globals": {
+    "BigInt": true
+  }
+}

packages/wallet-contract/.mocharc.yml

@@ -0,0 +1,2 @@
+require: test/bootstrap.js
+recursive: true

packages/wallet-contract/Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "wallet-contract"
+description = "Wallet data contract schema and tools"
+version = "1.5.0"
+edition = "2021"
+rust-version.workspace = true
+license = "MIT"
+
+[dependencies]
+thiserror = "1.0.64"
+platform-version = { path = "../rs-platform-version" }
+serde_json = { version = "1.0" }
+platform-value = { path = "../rs-platform-value" }

packages/wallet-contract/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Dash Core Group, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

packages/wallet-contract/README.md

@@ -0,0 +1,27 @@
+# Wallet Contract
+
+[![Build Status](https://github.com/dashpay/platform/actions/workflows/release.yml/badge.svg)](https://github.com/dashpay/platform/actions/workflows/release.yml)
+[![NPM version](https://img.shields.io/npm/v/@dashevo/wallet-contract.svg?style=flat-square)](https://npmjs.org/package/@dashevo/wallet-contract)
+
+JSON Contracts for Dash Wallet apps
+
+## Table of Contents
+
+- [Install](#install)
+- [Usage](#usage)
+- [Contributing](#contributing)
+- [License](#license)
+
+## Install
+
+```sh
+npm install @dashevo/wallet-contract
+```
+
+## Contributing
+
+Feel free to dive in! [Open an issue](https://github.com/dashpay/platform/issues/new/choose) or submit PRs.
+
+## License
+
+[MIT](LICENSE) © Dash Core Group, Inc.

packages/wallet-contract/lib/systemIds.js

@@ -0,0 +1,4 @@
+module.exports = {
+  ownerId: '11111111111111111111111111111111',
+  contractId: '7CSFGeF4WNzgDmx94zwvHkYaG3Dx4XEe5LFsFgJswLbm'
+};

packages/wallet-contract/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@dashevo/wallet-contract",
+  "version": "1.5.0",
+  "description": "A contract and helper scripts for Wallet DApp",
+  "scripts": {
+    "lint": "eslint .",
+    "test": "yarn run test:unit",
+    "test:unit": "mocha 'test/unit/**/*.spec.js'"
+  },
+  "contributors": [
+    {
+      "name": "Eric Britten",
+      "email": "[email protected]",
+      "url": "https://github.com/hashengineering"
+    }
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "@dashevo/wasm-dpp": "workspace:*",
+    "chai": "^4.3.10",
+    "dirty-chai": "^2.0.1",
+    "eslint": "^8.53.0",
+    "eslint-config-airbnb-base": "^15.0.0",
+    "eslint-plugin-import": "^2.29.0",
+    "mocha": "^10.2.0",
+    "sinon": "^17.0.1",
+    "sinon-chai": "^3.7.0"
+  }
+}

packages/wallet-contract/schema/v1/wallet-contract-documents.json

@@ -0,0 +1,55 @@
+{
+  "txMetadata": {
+    "type": "object",
+    "indices": [
+      {
+        "name": "ownerId",
+        "properties": [
+          {
+            "$ownerId": "asc"
+          }
+        ]
+      },
+      {
+        "name": "ownerIdAndCreatedAt",
+        "properties": [
+          {
+            "$ownerId": "asc"
+          },
+          {
+            "$createdAt": "asc"
+          }
+        ]
+      }
+    ],
+    "properties": {
+      "keyIndex": {
+        "type": "integer",
+        "minimum": 0,
+        "description": "The index of the owners identity public key used to derive the encryption key.",
+        "position": 0
+      },
+      "encryptionKeyIndex": {
+        "type": "integer",
+        "minimum": 0,
+        "description": "The secondary index used to derive the encryption key that is used to encrypt and decrypt encryptedData.",
+        "position": 1
+      },
+      "encryptedMetadata": {
+        "type": "array",
+        "byteArray": true,
+        "minItems": 32,
+        "maxItems": 4096,
+        "description": "encrypted metadata using AES-CBC-256",
+        "position": 2
+      }
+    },
+    "required": [
+      "keyIndex",
+      "encryptionKeyIndex",
+      "encryptedMetadata",
+      "$createdAt"
+    ],
+    "additionalProperties": false
+  }
+}

packages/wallet-contract/src/error.rs

@@ -0,0 +1,17 @@
+use platform_version::version::FeatureVersion;
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    /// Platform expected some specific versions
+    #[error("platform unknown version on {method}, received: {received}")]
+    UnknownVersionMismatch {
+        /// method
+        method: String,
+        /// the allowed versions for this method
+        known_versions: Vec<FeatureVersion>,
+        /// requested core height
+        received: FeatureVersion,
+    },
+    #[error("schema deserialize error: {0}")]
+    InvalidSchemaJson(#[from] serde_json::Error),
+}