feat!: change protocol version encoding from big-endian to little-endian (#337)

BREAKING CHANGES: old binary data is not compatible due to change in endianness

Author: jawid-h

lib/dataContract/DataContract.js

@@ -282,7 +282,7 @@ class DataContract {
     delete serializedData.protocolVersion;
 
     const protocolVersionUInt32 = Buffer.alloc(4);
-    protocolVersionUInt32.writeUInt32BE(this.getProtocolVersion(), 0);
+    protocolVersionUInt32.writeUInt32LE(this.getProtocolVersion(), 0);
 
     return Buffer.concat([protocolVersionUInt32, encode(serializedData)]);
   }

lib/decodeProtocolEntityFactory.js

@@ -17,7 +17,7 @@ function decodeProtocolEntityFactory(versionCompatibilityMap) {
     // Parse protocol version from the first 4 bytes
     let protocolVersion;
     try {
-      protocolVersion = buffer.slice(0, 4).readUInt32BE(0);
+      protocolVersion = buffer.slice(0, 4).readUInt32LE(0);
     } catch (error) {
       throw new ProtocolVersionParsingError(
         buffer,

lib/document/Document.js

@@ -369,7 +369,7 @@ class Document {
     delete serializedData.$protocolVersion;
 
     const protocolVersionUInt32 = Buffer.alloc(4);
-    protocolVersionUInt32.writeUInt32BE(this.getProtocolVersion(), 0);
+    protocolVersionUInt32.writeUInt32LE(this.getProtocolVersion(), 0);
 
     return Buffer.concat([protocolVersionUInt32, encode(serializedData)]);
   }

lib/identity/Identity.js

@@ -112,7 +112,7 @@ class Identity {
     delete serializedData.protocolVersion;
 
     const protocolVersionUInt32 = Buffer.alloc(4);
-    protocolVersionUInt32.writeUInt32BE(this.getProtocolVersion(), 0);
+    protocolVersionUInt32.writeUInt32LE(this.getProtocolVersion(), 0);
 
     return Buffer.concat([protocolVersionUInt32, encode(serializedData)]);
   }

lib/stateTransition/AbstractStateTransition.js

@@ -133,7 +133,7 @@ class AbstractStateTransition {
     delete serializedData.protocolVersion;
 
     const protocolVersionUInt32 = Buffer.alloc(4);
-    protocolVersionUInt32.writeUInt32BE(this.getProtocolVersion(), 0);
+    protocolVersionUInt32.writeUInt32LE(this.getProtocolVersion(), 0);
 
     return Buffer.concat([protocolVersionUInt32, encode(serializedData)]);
   }

test/unit/dataContract/DataContract.spec.js

@@ -294,7 +294,7 @@ describe('DataContract', () => {
       delete dataContractToEncode.protocolVersion;
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(dataContract.getProtocolVersion(), 0);
+      protocolVersionUInt32.writeUInt32LE(dataContract.getProtocolVersion(), 0);
 
       expect(encodeMock).to.have.been.calledOnceWith(dataContractToEncode);
       expect(result).to.deep.equal(Buffer.concat([protocolVersionUInt32, serializedDataContract]));

test/unit/dataContract/stateTransition/DataContractCreateTransition/DataContractCreateTransition.spec.js

@@ -74,7 +74,7 @@ describe('DataContractCreateTransition', () => {
       encodeMock.returns(serializedStateTransition);
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(stateTransition.protocolVersion, 0);
+      protocolVersionUInt32.writeUInt32LE(stateTransition.protocolVersion, 0);
 
       const result = stateTransition.toBuffer();
 
@@ -111,7 +111,7 @@ describe('DataContractCreateTransition', () => {
       ]);
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(stateTransition.protocolVersion, 0);
+      protocolVersionUInt32.writeUInt32LE(stateTransition.protocolVersion, 0);
 
       expect(hashMock).to.have.been.calledOnceWith(
         Buffer.concat([protocolVersionUInt32, serializedDocument]),

test/unit/decodeProtocolEntityFactory.spec.js

@@ -22,7 +22,7 @@ describe('decodeProtocolEntityFactory', () => {
     parsedProtocolVersion = 0;
 
     protocolVersionBuffer = Buffer.alloc(4);
-    protocolVersionBuffer.writeUInt32BE(parsedProtocolVersion, 0);
+    protocolVersionBuffer.writeUInt32LE(parsedProtocolVersion, 0);
 
     rawEntity = { test: 'successful' };
     entityBuffer = encode(rawEntity);
@@ -56,7 +56,7 @@ describe('decodeProtocolEntityFactory', () => {
     parsedProtocolVersion = 2;
 
     protocolVersionBuffer = Buffer.alloc(4);
-    protocolVersionBuffer.writeUInt32BE(parsedProtocolVersion, 0);
+    protocolVersionBuffer.writeUInt32LE(parsedProtocolVersion, 0);
 
     buffer = Buffer.concat([protocolVersionBuffer, entityBuffer]);
 
@@ -91,7 +91,7 @@ describe('decodeProtocolEntityFactory', () => {
     versionCompatibilityMap[currentProtocolVersion.toString()] = minimalProtocolVersion;
 
     protocolVersionBuffer = Buffer.alloc(4);
-    protocolVersionBuffer.writeUInt32BE(parsedProtocolVersion, 0);
+    protocolVersionBuffer.writeUInt32LE(parsedProtocolVersion, 0);
 
     buffer = Buffer.concat([protocolVersionBuffer, entityBuffer]);
 

test/unit/document/Document.spec.js

@@ -411,7 +411,7 @@ describe('Document', () => {
       const result = document.toBuffer();
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(rawDocument.$protocolVersion, 0);
+      protocolVersionUInt32.writeUInt32LE(rawDocument.$protocolVersion, 0);
 
       expect(result).to.deep.equal(Buffer.concat([protocolVersionUInt32, serializedDocument]));
 

test/unit/document/stateTransition/DocumetsBatchTransition/DocumentsBatchTransition.spec.js

@@ -90,7 +90,7 @@ describe('DocumentsBatchTransition', () => {
       const result = stateTransition.toBuffer();
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(stateTransition.protocolVersion, 0);
+      protocolVersionUInt32.writeUInt32LE(stateTransition.protocolVersion, 0);
 
       expect(result).to.deep.equal(
         Buffer.concat([protocolVersionUInt32, serializedStateTransition]),
@@ -121,7 +121,7 @@ describe('DocumentsBatchTransition', () => {
       expect(encodeMock).to.have.been.calledOnceWith(dataToEncode);
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(stateTransition.protocolVersion, 0);
+      protocolVersionUInt32.writeUInt32LE(stateTransition.protocolVersion, 0);
 
       expect(hashMock).to.have.been.calledOnceWith(
         Buffer.concat([protocolVersionUInt32, serializedDocument]),

test/unit/identity/Identity.spec.js

@@ -106,7 +106,7 @@ describe('Identity', () => {
       delete identityDataToEncode.protocolVersion;
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(identity.getProtocolVersion(), 0);
+      protocolVersionUInt32.writeUInt32LE(identity.getProtocolVersion(), 0);
 
       expect(encodeMock).to.have.been.calledOnceWith(identityDataToEncode);
       expect(result).to.deep.equal(Buffer.concat([protocolVersionUInt32, encodeMockData]));
@@ -126,7 +126,7 @@ describe('Identity', () => {
       delete identityDataToEncode.protocolVersion;
 
       const protocolVersionUInt32 = Buffer.alloc(4);
-      protocolVersionUInt32.writeUInt32BE(identity.getProtocolVersion(), 0);
+      protocolVersionUInt32.writeUInt32LE(identity.getProtocolVersion(), 0);
 
       expect(encodeMock).to.have.been.calledOnceWith(identityDataToEncode);
       expect(hashMock).to.have.been.calledOnceWith(Buffer.concat([protocolVersionUInt32, buffer]));