feat: add protocolVersion option to DPP class

lib/DashPlatformProtocol.js

@@ -1,6 +1,8 @@
 const { default: getRE2Class } = require('@dashevo/re2-wasm');
 const createAjv = require('./ajv/createAjv');
 
+const { protocolVersion } = require('./protocolVersion');
+
 const JsonSchemaValidator = require('./validation/JsonSchemaValidator');
 
 const DataContractFacade = require('./dataContract/DataContractFacade');
@@ -17,10 +19,15 @@ class DashPlatformProtocol {
    * @param {Object} options
    * @param {StateRepository} [options.stateRepository]
    * @param {JsonSchemaValidator} [options.jsonSchemaValidator]
+   * @param {number} [options.protocolVersion]
    */
   constructor(options = {}) {
     this.options = options;
 
+    this.protocolVersion = this.options.protocolVersion !== undefined
+      ? this.options.protocolVersion
+      : protocolVersion;
+
     this.stateRepository = undefined;
     this.jsonSchemaValidator = undefined;
     this.initialized = undefined;
@@ -47,23 +54,21 @@ class DashPlatformProtocol {
       }
 
       this.dataContract = new DataContractFacade(
-        this.jsonSchemaValidator,
+        this,
         RE2,
       );
 
       this.document = new DocumentFacade(
-        this.stateRepository,
-        this.jsonSchemaValidator,
+        this,
       );
 
       this.stateTransition = new StateTransitionFacade(
-        this.stateRepository,
-        this.jsonSchemaValidator,
+        this,
         RE2,
       );
 
       this.identity = new IdentityFacade(
-        this.jsonSchemaValidator,
+        this,
       );
 
       return true;
@@ -87,6 +92,24 @@ class DashPlatformProtocol {
   getStateRepository() {
     return this.stateRepository;
   }
+
+  /**
+   * Get protocol version
+   *
+   * @return {number}
+   */
+  getProtocolVersion() {
+    return this.protocolVersion;
+  }
+
+  /**
+   * Set protocol version
+   *
+   * @param {number} version
+   */
+  setProtocolVersion(version) {
+    this.protocolVersion = version;
+  }
 }
 
 module.exports = DashPlatformProtocol;

lib/dataContract/DataContractFacade.js

@@ -9,23 +9,24 @@ const validateDataContractPatternsFactory = require('./validateDataContractPatte
 
 class DataContractFacade {
   /**
-   * @param {JsonSchemaValidator} jsonSchemaValidator
+   * @param {DashPlatformProtocol} dpp
    * @param {RE2} RE2
    */
-  constructor(jsonSchemaValidator, RE2) {
+  constructor(dpp, RE2) {
     const validateDataContractMaxDepth = validateDataContractMaxDepthFactory($RefParser);
 
     const validateDataContractPatterns = validateDataContractPatternsFactory(RE2);
 
     this.validateDataContract = validateDataContractFactory(
-      jsonSchemaValidator,
+      dpp.getJsonSchemaValidator(),
       validateDataContractMaxDepth,
       enrichDataContractWithBaseSchema,
       validateDataContractPatterns,
       RE2,
     );
 
     this.factory = new DataContractFactory(
+      dpp,
       this.validateDataContract,
     );
   }

lib/dataContract/DataContractFactory.js

@@ -10,13 +10,14 @@ const SerializedObjectParsingError = require('../errors/SerializedObjectParsingE
 const generateEntropy = require('../util/generateEntropy');
 
 const { decode } = require('../util/serializer');
-const { protocolVersion } = require('../protocolVersion');
 
 class DataContractFactory {
   /**
+   * @param {DashPlatformProtocol} dpp
    * @param {validateDataContract} validateDataContract
    */
-  constructor(validateDataContract) {
+  constructor(dpp, validateDataContract) {
+    this.dpp = dpp;
     this.validateDataContract = validateDataContract;
   }
 
@@ -33,7 +34,7 @@ class DataContractFactory {
     const dataContractId = generateDataContractId(ownerId, dataContractEntropy);
 
     const dataContract = new DataContract({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       $schema: DataContract.DEFAULTS.SCHEMA,
       $id: dataContractId,
       ownerId,
@@ -100,7 +101,7 @@ class DataContractFactory {
    */
   createStateTransition(dataContract) {
     return new DataContractCreateTransition({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       dataContract: dataContract.toObject(),
       entropy: dataContract.getEntropy(),
     });

lib/document/DocumentFacade.js

@@ -9,22 +9,22 @@ const MissingOptionError = require('../errors/MissingOptionError');
 
 class DocumentFacade {
   /**
-   * @param {StateRepository} stateRepository
-   * @param {JsonSchemaValidator} validator
+   * @param {DashPlatformProtocol} dpp
    */
-  constructor(stateRepository, validator) {
-    this.stateRepository = stateRepository;
+  constructor(dpp) {
+    this.stateRepository = dpp.getStateRepository();
 
     this.validateDocument = validateDocumentFactory(
-      validator,
+      dpp.getJsonSchemaValidator(),
       enrichDataContractWithBaseSchema,
     );
 
     this.fetchAndValidateDataContract = fetchAndValidateDataContractFactory(
-      stateRepository,
+      this.stateRepository,
     );
 
     this.factory = new DocumentFactory(
+      dpp,
       this.validateDocument,
       this.fetchAndValidateDataContract,
     );

lib/document/DocumentFactory.js

@@ -19,14 +19,14 @@ const SerializedObjectParsingError = require('../errors/SerializedObjectParsingE
 
 const generateDocumentId = require('./generateDocumentId');
 
-const { protocolVersion } = require('../protocolVersion');
-
 class DocumentFactory {
   /**
+   * @param {DashPlatformProtocol} dpp
    * @param {validateDocument} validateDocument
    * @param {fetchAndValidateDataContract} fetchAndValidateDataContract
    */
-  constructor(validateDocument, fetchAndValidateDataContract) {
+  constructor(dpp, validateDocument, fetchAndValidateDataContract) {
+    this.dpp = dpp;
     this.validateDocument = validateDocument;
     this.fetchAndValidateDataContract = fetchAndValidateDataContract;
   }
@@ -56,7 +56,7 @@ class DocumentFactory {
     );
 
     const rawDocument = {
-      $protocolVersion: protocolVersion,
+      $protocolVersion: this.dpp.getProtocolVersion(),
       $id: id,
       $type: type,
       $dataContractId: dataContractId,
@@ -309,7 +309,7 @@ class DocumentFactory {
       .map((document) => document.getDataContract());
 
     return new DocumentsBatchTransition({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       ownerId,
       transitions: rawDocumentTransitions,
     }, dataContracts);

lib/identity/IdentityFacade.js

@@ -10,17 +10,17 @@ const validatePublicKeysFactory = require('./validation/validatePublicKeysFactor
  */
 class IdentityFacade {
   /**
-   * @param {JsonSchemaValidator} validator
+   * @param {DashPlatformProtocol} dpp
    */
-  constructor(validator) {
+  constructor(dpp) {
     const validatePublicKeys = validatePublicKeysFactory(
-      validator,
+      dpp.getJsonSchemaValidator(),
     );
     this.validateIdentity = validateIdentityFactory(
-      validator,
+      dpp.getJsonSchemaValidator(),
       validatePublicKeys,
     );
-    this.factory = new IdentityFactory(this.validateIdentity);
+    this.factory = new IdentityFactory(dpp, this.validateIdentity);
   }
 
   /**

lib/identity/IdentityFactory.js

@@ -11,13 +11,13 @@ const SerializedObjectParsingError = require('../errors/SerializedObjectParsingE
 const InstantAssetLockProof = require('./stateTransitions/assetLockProof/instant/InstantAssetLockProof');
 const ChainAssetLockProof = require('./stateTransitions/assetLockProof/chain/ChainAssetLockProof');
 
-const { protocolVersion } = require('../protocolVersion');
-
 class IdentityFactory {
   /**
+   * @param {DashPlatformProtocol} dpp
    * @param {validateIdentity} validateIdentity
    */
-  constructor(validateIdentity) {
+  constructor(dpp, validateIdentity) {
+    this.dpp = dpp;
     this.validateIdentity = validateIdentity;
   }
 
@@ -30,7 +30,7 @@ class IdentityFactory {
    */
   create(assetLockProof, publicKeys) {
     const identity = new Identity({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       id: assetLockProof.createIdentifier(),
       balance: 0,
       publicKeys: publicKeys.map((publicKey, i) => ({
@@ -132,7 +132,7 @@ class IdentityFactory {
    */
   createIdentityCreateTransition(identity) {
     const stateTransition = new IdentityCreateTransition({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       assetLockProof: identity.getAssetLockProof().toObject(),
     });
 
@@ -150,7 +150,7 @@ class IdentityFactory {
    */
   createIdentityTopUpTransition(identityId, assetLockProof) {
     return new IdentityTopUpTransition({
-      protocolVersion,
+      protocolVersion: this.dpp.getProtocolVersion(),
       identityId,
       assetLockProof: assetLockProof.toObject(),
     });