PR #101: fixed block DTOs with beneficiary field DTO problem

Author: Greg S

src/infrastructure/BlockchainHttp.ts

@@ -26,7 +26,7 @@ import {UInt64} from '../model/UInt64';
 import {BlockchainRepository} from './BlockchainRepository';
 import {Http} from './Http';
 import {QueryParams} from './QueryParams';
-import {CreateTransactionFromDTO} from './transaction/CreateTransactionFromDTO';
+import {CreateTransactionFromDTO, extractBeneficiary} from './transaction/CreateTransactionFromDTO';
 
 /**
  * Blockchain http repository.
@@ -75,7 +75,7 @@ export class BlockchainHttp extends Http implements BlockchainRepository {
                 blockDTO.block.blockTransactionsHash,
                 blockDTO.block.blockReceiptsHash,
                 blockDTO.block.stateHash,
-                PublicAccount.createFromPublicKey(blockDTO.block.beneficiaryPublicKey, networkType),
+                extractBeneficiary(blockDTO, networkType),
             );
         }));
     }
@@ -125,7 +125,7 @@ export class BlockchainHttp extends Http implements BlockchainRepository {
                     blockDTO.block.blockTransactionsHash,
                     blockDTO.block.blockReceiptsHash,
                     blockDTO.block.stateHash,
-                    PublicAccount.createFromPublicKey(blockDTO.block.beneficiaryPublicKey, networkType),
+                    extractBeneficiary(blockDTO, networkType),
                 );
             });
         }));

src/infrastructure/Listener.ts

@@ -20,6 +20,7 @@ import * as WebSocket from 'ws';
 import {Address} from '../model/account/Address';
 import {PublicAccount} from '../model/account/PublicAccount';
 import {BlockInfo} from '../model/blockchain/BlockInfo';
+import {NetworkType} from '../model/blockchain/NetworkType';
 import {NamespaceId} from '../model/namespace/NamespaceId';
 import {AggregateTransaction} from '../model/transaction/AggregateTransaction';
 import {AggregateTransactionCosignature} from '../model/transaction/AggregateTransactionCosignature';
@@ -33,7 +34,7 @@ import {Transaction} from '../model/transaction/Transaction';
 import {TransactionStatusError} from '../model/transaction/TransactionStatusError';
 import {TransferTransaction} from '../model/transaction/TransferTransaction';
 import {UInt64} from '../model/UInt64';
-import {CreateTransactionFromDTO} from './transaction/CreateTransactionFromDTO';
+import {CreateTransactionFromDTO, extractBeneficiary} from './transaction/CreateTransactionFromDTO';
 
 enum ListenerChannelName {
     block = 'block',
@@ -140,7 +141,7 @@ export class Listener {
                                 message.block.blockTransactionsHash,
                                 message.block.blockReceiptsHash,
                                 message.block.stateHash,
-                                PublicAccount.createFromPublicKey(message.block.beneficiaryPublicKey, networkType),
+                                extractBeneficiary(message, networkType), // passing `message` as `blockDTO`
                             ),
                         });
                     } else if (message.status) {

src/infrastructure/transaction/CreateTransactionFromDTO.ts

@@ -322,7 +322,7 @@ const CreateStandaloneTransactionFromDTO = (transactionDTO, transactionInfo): Tr
     throw new Error('Unimplemented transaction with type ' + transactionDTO.type);
 };
 
-const extractNetworkType = (version: number): NetworkType => {
+export const extractNetworkType = (version: number): NetworkType => {
     const networkType = parseInt(version.toString(16).substr(0, 2), 16);
     if (networkType === NetworkType.MAIN_NET) {
         return NetworkType.MAIN_NET;
@@ -336,7 +336,7 @@ const extractNetworkType = (version: number): NetworkType => {
     throw new Error('Unimplemented network type');
 };
 
-const extractTransactionVersion = (version: number): number => {
+export const extractTransactionVersion = (version: number): number => {
     return parseInt(version.toString(16).substr(2, 2), 16);
 };
 
@@ -349,7 +349,7 @@ const extractTransactionVersion = (version: number): number => {
  * @param recipient {string} Encoded hexadecimal recipient notation
  * @return {Address | NamespaceId}
  */
-const extractRecipient = (recipient: string): Address | NamespaceId => {
+export const extractRecipient = (recipient: string): Address | NamespaceId => {
     // If bit 0 of byte 0 is not set (like in 0x90), then it is a regular address.
     // Else (e.g. 0x91) it represents a namespace id which starts at byte 1.
     const bit0 = convert.hexToUint8(recipient.substr(1, 2))[0];
@@ -374,7 +374,7 @@ const extractRecipient = (recipient: string): Address | NamespaceId => {
  * @param mosaics {Array | undefined} The DTO array of mosaics (with UInt64 Id notation)
  * @return {Mosaic[]}
  */
-const extractMosaics = (mosaics: any): Mosaic[] => {
+export const extractMosaics = (mosaics: any): Mosaic[] => {
 
     if (mosaics === undefined) {
         return [];
@@ -396,3 +396,44 @@ const extractMosaics = (mosaics: any): Mosaic[] => {
         return new Mosaic(new MosaicId(mosaicDTO.id), new UInt64(mosaicDTO.amount));
     });
 };
+
+/**
+ * Extract beneficiary public key from DTO.
+ *
+ * @todo Upgrade of catapult-rest WITH catapult-service-bootstrap versioning.
+ *
+ * With `cow` upgrade (nemtech/catapult-server@0.3.0.2), `catapult-rest` block DTO
+ * was updated and latest catapult-service-bootstrap uses the wrong block DTO.
+ * This will be fixed with next catapult-server upgrade to `dragon`.
+ *
+ * :warning It is currently not possible to read the block's beneficiary public key
+ * except when working with a local instance of `catapult-rest`.
+ *
+ * @param beneficiary {string | undefined} The beneficiary public key if set
+ * @return {Mosaic[]}
+ */
+export const extractBeneficiary = (
+    blockDTO: any,
+    networkType: NetworkType
+): PublicAccount | undefined => {
+
+    let dtoPublicAccount: PublicAccount | undefined;
+    let dtoFieldValue: string | undefined;
+    if (blockDTO.beneficiaryPublicKey) {
+        dtoFieldValue = blockDTO.beneficiaryPublicKey;
+    } else if (blockDTO.beneficiary) {
+        dtoFieldValue = blockDTO.beneficiary;
+    }
+
+    if (! dtoFieldValue) {
+        return undefined;
+    }
+
+    try {
+        // @FIX with latest catapult-service-bootstrap version, catapult-rest still returns
+        //      a `string` formatted copy of the public *when it is set at all*.
+        dtoPublicAccount = PublicAccount.createFromPublicKey(dtoFieldValue, networkType);
+    } catch (e) { dtoPublicAccount =  undefined; }
+
+    return dtoPublicAccount;
+};

src/model/blockchain/BlockInfo.ts

@@ -117,7 +117,7 @@ export class BlockInfo {
                 /**
                  * The beneficiary public key.
                  */
-                public readonly beneficiaryPublicKey: PublicAccount,) {
+                public readonly beneficiaryPublicKey?: PublicAccount | undefined) {
 
     }
 }

test/model/blockchain/BlockInfo.spec.ts

@@ -87,7 +87,7 @@ describe('BlockInfo', () => {
         expect(blockInfo.blockTransactionsHash).to.be.equal(blockDTO.block.blockTransactionsHash);
         expect(blockInfo.blockReceiptsHash).to.be.equal(blockDTO.block.blockReceiptsHash);
         expect(blockInfo.stateHash).to.be.equal(blockDTO.block.stateHash);
-        expect(blockInfo.beneficiaryPublicKey.publicKey).to.be.equal(blockDTO.block.beneficiaryPublicKey);
+        expect((blockInfo.beneficiaryPublicKey as PublicAccount).publicKey).to.be.equal(blockDTO.block.beneficiaryPublicKey);
 
     });
 });