refactor: rename $contractId to $dataContractId (#158)

BREAKING CHANGE
dashevo · Apr 14, 2020 · 6984524 · 6984524
1 parent f6a1589
commit 6984524
Show file tree

Hide file tree

Showing 14 changed files with 44 additions and 44 deletions.
diff --git a/lib/document/Document.js b/lib/document/Document.js
@@ -23,9 +23,9 @@ class Document {
       delete data.$type;
     }
 
-    if (Object.prototype.hasOwnProperty.call(rawDocument, '$contractId')) {
-      this.contractId = rawDocument.$contractId;
-      delete data.$contractId;
+    if (Object.prototype.hasOwnProperty.call(rawDocument, '$dataContractId')) {
+      this.dataContractId = rawDocument.$dataContractId;
+      delete data.$dataContractId;
     }
 
     if (Object.prototype.hasOwnProperty.call(rawDocument, '$ownerId')) {
@@ -65,7 +65,7 @@ class Document {
    * @return {string}
    */
   getDataContractId() {
-    return this.contractId;
+    return this.dataContractId;
   }
 
   /**
@@ -172,7 +172,7 @@ class Document {
     return {
       $id: this.getId(),
       $type: this.getType(),
-      $contractId: this.getDataContractId(),
+      $dataContractId: this.getDataContractId(),
       $ownerId: this.getOwnerId(),
       $revision: this.getRevision(),
       ...this.getData(),
@@ -204,7 +204,7 @@ class Document {
  * @typedef {Object} RawDocument
  * @property {string} $id
  * @property {string} $type
- * @property {string} $contractId
+ * @property {string} $dataContractId
  * @property {string} $ownerId
  * @property {number} $revision
  */

diff --git a/lib/document/DocumentFactory.js b/lib/document/DocumentFactory.js
@@ -45,10 +45,10 @@ class DocumentFactory {
     }
 
     const documentEntropy = entropy.generate();
-    const contractId = dataContract.getId();
+    const dataContractId = dataContract.getId();
 
     const id = generateDocumentId(
-      contractId,
+      dataContractId,
       ownerId,
       type,
       documentEntropy,
@@ -57,7 +57,7 @@ class DocumentFactory {
     const rawDocument = {
       $id: id,
       $type: type,
-      $contractId: contractId,
+      $dataContractId: dataContractId,
       $ownerId: ownerId,
       $revision: DocumentCreateTransition.INITIAL_REVISION,
       ...data,

diff --git a/lib/document/fetchAndValidateDataContractFactory.js b/lib/document/fetchAndValidateDataContractFactory.js
@@ -20,7 +20,7 @@ function fetchAndValidateDataContractFactory(stateRepository) {
 
     const result = new ValidationResult();
 
-    if (!Object.prototype.hasOwnProperty.call(rawDocument, '$contractId')) {
+    if (!Object.prototype.hasOwnProperty.call(rawDocument, '$dataContractId')) {
       result.addError(
         new MissingDocumentContractIdError(rawDocument),
       );
@@ -30,7 +30,7 @@ function fetchAndValidateDataContractFactory(stateRepository) {
       return result;
     }
 
-    const dataContractId = rawDocument.$contractId;
+    const dataContractId = rawDocument.$dataContractId;
 
     const dataContract = await stateRepository.fetchDataContract(dataContractId);
 

diff --git a/lib/document/stateTransition/applyDocumentsBatchTransitionFactory.js b/lib/document/stateTransition/applyDocumentsBatchTransitionFactory.js
@@ -50,7 +50,7 @@ function applyDocumentsBatchTransitionFactory(
           const newDocument = new Document({
             $id: documentTransition.getId(),
             $type: documentTransition.getType(),
-            $contractId: stateTransition.getDataContractId(),
+            $dataContractId: stateTransition.getDataContractId(),
             $ownerId: stateTransition.getOwnerId(),
             ...documentTransition.getData(),
           });

diff --git a/lib/document/validateDocumentFactory.js b/lib/document/validateDocumentFactory.js
@@ -69,7 +69,7 @@ module.exports = function validateDocumentFactory(
       return result;
     }
 
-    if (rawDocument.$contractId !== dataContract.getId()) {
+    if (rawDocument.$dataContractId !== dataContract.getId()) {
       result.addError(
         new MismatchDocumentContractIdAndDataContractError(rawDocument, dataContract),
       );

diff --git a/lib/errors/MissingDocumentContractIdError.js b/lib/errors/MissingDocumentContractIdError.js
@@ -2,7 +2,7 @@ const ConsensusError = require('./ConsensusError');
 
 class MissingDocumentContractIdError extends ConsensusError {
   constructor(rawDocument) {
-    super('$contractId is not present');
+    super('$dataContractId is not present');
 
     this.rawDocument = rawDocument;
   }

diff --git a/schema/document/documentBase.json b/schema/document/documentBase.json
@@ -16,7 +16,7 @@
       "multipleOf": 1.0,
       "minimum": 1
     },
-    "$contractId": {
+    "$dataContractId": {
       "type": "string",
       "minLength": 42,
       "maxLength": 44,
@@ -33,7 +33,7 @@
     "$id",
     "$type",
     "$revision",
-    "$contractId",
+    "$dataContractId",
     "$ownerId"
   ],
   "additionalProperties": false

diff --git a/test/integration/document/stateTransition/validation/data/executeDataTriggersFactory.spec.js b/test/integration/document/stateTransition/validation/data/executeDataTriggersFactory.spec.js
@@ -209,7 +209,7 @@ describe('executeDataTriggersFactory', () => {
   });
 
   it("should call only one trigger if there's one document with a trigger and one without", async () => {
-    childDocument.contractId = getDocumentsFixture.dataContract.getId();
+    childDocument.dataContractId = getDocumentsFixture.dataContract.getId();
     childDocument.ownerId = getDocumentsFixture.ownerId;
 
     documentTransitions = getDocumentTransitionsFixture({

diff --git a/test/integration/document/validateDocumentFactory.spec.js b/test/integration/document/validateDocumentFactory.spec.js
@@ -217,9 +217,9 @@ describe('validateDocumentFactory', () => {
       });
     });
 
-    describe('$contractId', () => {
+    describe('$dataContractId', () => {
       it('should be present', () => {
-        delete rawDocument.$contractId;
+        delete rawDocument.$dataContractId;
 
         const result = validateDocument(rawDocument, dataContract);
 
@@ -229,50 +229,50 @@ describe('validateDocumentFactory', () => {
 
         expect(error.dataPath).to.equal('');
         expect(error.keyword).to.equal('required');
-        expect(error.params.missingProperty).to.equal('$contractId');
+        expect(error.params.missingProperty).to.equal('$dataContractId');
       });
 
       it('should be a string', () => {
-        rawDocument.$contractId = 1;
+        rawDocument.$dataContractId = 1;
 
         const result = validateDocument(rawDocument, dataContract);
 
         expectJsonSchemaError(result);
 
         const [error] = result.getErrors();
 
-        expect(error.dataPath).to.equal('.$contractId');
+        expect(error.dataPath).to.equal('.$dataContractId');
         expect(error.keyword).to.equal('type');
       });
 
       it('should be no less than 42 chars', () => {
-        rawDocument.$contractId = '1'.repeat(41);
+        rawDocument.$dataContractId = '1'.repeat(41);
 
         const result = validateDocument(rawDocument, dataContract);
 
         expectJsonSchemaError(result);
 
         const [error] = result.getErrors();
 
-        expect(error.dataPath).to.equal('.$contractId');
+        expect(error.dataPath).to.equal('.$dataContractId');
         expect(error.keyword).to.equal('minLength');
       });
 
       it('should be no longer than 44 chars', () => {
-        rawDocument.$contractId = '1'.repeat(45);
+        rawDocument.$dataContractId = '1'.repeat(45);
 
         const result = validateDocument(rawDocument, dataContract);
 
         expectJsonSchemaError(result);
 
         const [error] = result.getErrors();
 
-        expect(error.dataPath).to.equal('.$contractId');
+        expect(error.dataPath).to.equal('.$dataContractId');
         expect(error.keyword).to.equal('maxLength');
       });
 
       it('should be base58 encoded', () => {
-        rawDocument.$contractId = '&'.repeat(44);
+        rawDocument.$dataContractId = '&'.repeat(44);
 
         const result = validateDocument(rawDocument, dataContract);
 
@@ -281,7 +281,7 @@ describe('validateDocumentFactory', () => {
         const [error] = result.getErrors();
 
         expect(error.keyword).to.equal('pattern');
-        expect(error.dataPath).to.equal('.$contractId');
+        expect(error.dataPath).to.equal('.$dataContractId');
       });
     });
 
@@ -383,7 +383,7 @@ describe('validateDocumentFactory', () => {
   });
 
   it('should return invalid result if a document contractId is not equal to Data Contract ID', () => {
-    rawDocument.$contractId = generateRandomId();
+    rawDocument.$dataContractId = generateRandomId();
 
     const result = validateDocument(
       rawDocument,

diff --git a/test/unit/dataContract/DataContract.spec.js b/test/unit/dataContract/DataContract.spec.js
@@ -82,7 +82,7 @@ describe('DataContract', () => {
   });
 
   describe('#getJsonSchemaId', () => {
-    it('should return JSON Schema $contractId', () => {
+    it('should return JSON Schema ID', () => {
       const hashed = Buffer.from(ownerId + entropy);
       hashMock.returns(hashed);
 

diff --git a/test/unit/document/Document.spec.js b/test/unit/document/Document.spec.js
@@ -30,7 +30,7 @@ describe('Document', () => {
     rawDocument = {
       $id: 'D3AT6rBtyTqx3hXFckwtP81ncu49y5ndE7ot9JkuNSeB',
       $type: 'test',
-      $contractId: generateRandomId(),
+      $dataContractId: generateRandomId(),
       $ownerId: generateRandomId(),
       $revision: DocumentCreateTransition.INITIAL_REVISION,
     };
@@ -75,19 +75,19 @@ describe('Document', () => {
       expect(Document.prototype.setData).to.have.been.calledOnceWith(data);
     });
 
-    it('should create Document with $contractId and data if present', () => {
+    it('should create Document with $dataContractId and data if present', () => {
       const data = {
         test: 1,
       };
 
       rawDocument = {
-        $contractId: generateRandomId(),
+        $dataContractId: generateRandomId(),
         ...data,
       };
 
       document = new Document(rawDocument);
 
-      expect(document.contractId).to.equal(rawDocument.$contractId);
+      expect(document.dataContractId).to.equal(rawDocument.$dataContractId);
       expect(Document.prototype.setData).to.have.been.calledOnceWith(data);
     });
 
@@ -165,8 +165,8 @@ describe('Document', () => {
     });
   });
 
-  describe('#getContractId', () => {
-    it('should return $contractId', () => {
+  describe('#getDataContractId', () => {
+    it('should return $dataContractId', () => {
       expect(document.getOwnerId()).to.equal(rawDocument.$ownerId);
     });
   });

diff --git a/test/unit/document/DocumentFactory.spec.js b/test/unit/document/DocumentFactory.spec.js
@@ -90,11 +90,11 @@ describe('DocumentFactory', () => {
 
       expect(newDocument.get('name')).to.equal(name);
 
-      expect(newDocument.contractId).to.equal(contractId);
-      expect(newDocument.ownerId).to.equal(ownerId);
+      expect(newDocument.getDataContractId()).to.equal(contractId);
+      expect(newDocument.getOwnerId()).to.equal(ownerId);
 
       expect(generateMock).to.have.been.calledOnce();
-      expect(newDocument.entropy).to.equal(entropy);
+      expect(newDocument.getEntropy()).to.equal(entropy);
 
       expect(newDocument.getRevision()).to.equal(DocumentCreateTransition.INITIAL_REVISION);
 
@@ -262,7 +262,7 @@ describe('DocumentFactory', () => {
     });
 
     it('should throw and error if documents have mixed contract ids', () => {
-      documents[0].contractId = generateRandomId();
+      documents[0].dataContractId = generateRandomId();
       try {
         factory.createStateTransition({
           create: documents,

diff --git a/test/unit/document/fetchAndValidateDataContractFactory.spec.js b/test/unit/document/fetchAndValidateDataContractFactory.spec.js
@@ -31,10 +31,10 @@ describe('fetchAndValidateDataContractFactory', () => {
     );
   });
 
-  it('should return with invalid result if $contractId is not present', async () => {
+  it('should return with invalid result if $dataContractId is not present', async () => {
     const rawDocument = document.toJSON();
 
-    delete rawDocument.$contractId;
+    delete rawDocument.$dataContractId;
 
     const result = await fetchAndValidateDataContract(rawDocument);
 

diff --git a/test/unit/document/stateTransition/DocumentsBatchTransition.spec.js b/test/unit/document/stateTransition/DocumentsBatchTransition.spec.js
@@ -56,8 +56,8 @@ describe('DocumentsBatchTransition', () => {
       expect(stateTransition.toJSON()).to.deep.equal({
         protocolVersion: 0,
         type: stateTransitionTypes.DOCUMENTS_BATCH,
-        contractId: documents[0].contractId,
-        ownerId: documents[0].ownerId,
+        contractId: documents[0].getDataContractId(),
+        ownerId: documents[0].getOwnerId(),
         transitions: stateTransition.getTransitions().map((d) => d.toJSON()),
         signaturePublicKeyId: null,
         signature: null,