issue #100: fix BlockInfo fields & #53: add TransactionHttp.getTransactionEffectiveFee()

Author: Greg S

e2e/infrastructure/TransactionHttp.spec.ts

@@ -874,4 +874,15 @@ describe('TransactionHttp', () => {
                 });
         });
     });
+
+    describe('getTransactionEffectiveFee', () => {
+        it('should return effective paid fee given transactionHash', (done) => {
+            transactionHttp.getTransactionEffectiveFee(transactionHash)
+                .subscribe((effectiveFee) => {
+                    expect(effectiveFee).to.not.be.undefined;
+                    expect(effectiveFee).to.be.equal(0);
+                    done();
+                });
+        });
+    });
 });

src/infrastructure/BlockchainHttp.ts

@@ -70,8 +70,12 @@ export class BlockchainHttp extends Http implements BlockchainRepository {
                 new UInt64(blockDTO.block.height),
                 new UInt64(blockDTO.block.timestamp),
                 new UInt64(blockDTO.block.difficulty),
+                blockDTO.block.feeMultiplier,
                 blockDTO.block.previousBlockHash,
                 blockDTO.block.blockTransactionsHash,
+                blockDTO.block.blockReceiptsHash,
+                blockDTO.block.stateHash,
+                PublicAccount.createFromPublicKey(blockDTO.block.beneficiaryPublicKey, networkType),
             );
         }));
     }
@@ -116,8 +120,12 @@ export class BlockchainHttp extends Http implements BlockchainRepository {
                     new UInt64(blockDTO.block.height),
                     new UInt64(blockDTO.block.timestamp),
                     new UInt64(blockDTO.block.difficulty),
+                    blockDTO.block.feeMultiplier,
                     blockDTO.block.previousBlockHash,
                     blockDTO.block.blockTransactionsHash,
+                    blockDTO.block.blockReceiptsHash,
+                    blockDTO.block.stateHash,
+                    PublicAccount.createFromPublicKey(blockDTO.block.beneficiaryPublicKey, networkType),
                 );
             });
         }));

src/infrastructure/Listener.ts

@@ -135,8 +135,12 @@ export class Listener {
                                 new UInt64(message.block.height),
                                 new UInt64(message.block.timestamp),
                                 new UInt64(message.block.difficulty),
+                                message.block.feeMultiplier,
                                 message.block.previousBlockHash,
                                 message.block.blockTransactionsHash,
+                                message.block.blockReceiptsHash,
+                                message.block.stateHash,
+                                PublicAccount.createFromPublicKey(message.block.beneficiaryPublicKey, networkType),
                             ),
                         });
                     } else if (message.status) {

src/infrastructure/TransactionHttp.ts

@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-import {TransactionRoutesApi} from 'nem2-library';
+import {BlockchainRoutesApi, TransactionRoutesApi} from 'nem2-library';
 import * as requestPromise from 'request-promise-native';
 import {from as observableFrom, Observable, throwError as observableThrowError} from 'rxjs';
-import {catchError, map} from 'rxjs/operators';
+import {catchError, map, mergeMap} from 'rxjs/operators';
 import {PublicAccount} from '../model/account/PublicAccount';
 import {CosignatureSignedTransaction} from '../model/transaction/CosignatureSignedTransaction';
 import {Deadline} from '../model/transaction/Deadline';
@@ -44,13 +44,20 @@ export class TransactionHttp extends Http implements TransactionRepository {
      */
     private transactionRoutesApi: TransactionRoutesApi;
 
+    /**
+     * @internal
+     * Nem2 Library blockchain routes api
+     */
+    private blockchainRoutesApi: BlockchainRoutesApi;
+
     /**
      * Constructor
      * @param url
      */
     constructor(private readonly url: string) {
         super(url);
         this.transactionRoutesApi = new TransactionRoutesApi(this.apiClient);
+        this.blockchainRoutesApi = new BlockchainRoutesApi(this.apiClient);
     }
 
     /**
@@ -190,4 +197,23 @@ export class TransactionHttp extends Http implements TransactionRepository {
             return observableThrowError(err);
         }));
     }
+
+    /**
+     * Gets a transaction's effective paid fee
+     * @param transactionId - Transaction id or hash.
+     * @returns Observable<number>
+     */
+    public getTransactionEffectiveFee(transactionId: string): Observable<number> {
+        return observableFrom(this.transactionRoutesApi.getTransaction(transactionId)).pipe(
+            mergeMap((transactionDTO) => observableFrom(
+                this.blockchainRoutesApi.getBlockByHeight(transactionDTO.meta.height)).pipe(
+                map((blockDTO) => {
+                    // parse transaction for call to `size` overload
+                    const transaction = CreateTransactionFromDTO(transactionDTO);
+
+                    // @see https://nemtech.github.io/concepts/transaction.html#fees
+                    // effective_fee = feeMultiplier x transaction::size
+                    return blockDTO.block.feeMultiplier * transaction.size;
+                }))));
+    }
 }

src/infrastructure/TransactionRepository.ts

@@ -56,6 +56,13 @@ export interface TransactionRepository {
      */
     getTransactionsStatuses(transactionHashes: string[]): Observable<TransactionStatus[]>;
 
+    /**
+     * Gets a transaction's effective paid fee
+     * @param transactionId - Transaction id or hash.
+     * @returns Observable<number>
+     */
+    getTransactionEffectiveFee(transactionId: string): Observable<number>;
+
     /**
      * Send a signed transaction
      * @param signedTransaction - Signed transaction

src/model/blockchain/BlockInfo.ts

@@ -36,8 +36,12 @@ export class BlockInfo {
      * @param height
      * @param timestamp
      * @param difficulty
+     * @param feeMultiplier
      * @param previousBlockHash
      * @param blockTransactionsHash
+     * @param blockReceiptsHash
+     * @param blockStateHash
+     * @param beneficiaryPublicKey
      */
     constructor(/**
                  * The block hash.
@@ -90,14 +94,30 @@ export class BlockInfo {
                  * The POI difficulty to harvest a block.
                  */
                 public readonly difficulty: UInt64,
+                /**
+                 * The feeMultiplier defined by the harvester.
+                 */
+                public readonly feeMultiplier: number,
                 /**
                  * The last block hash.
                  */
                 public readonly previousBlockHash: string,
                 /**
                  * The block transaction hash.
                  */
-                public readonly blockTransactionsHash: string,) {
+                public readonly blockTransactionsHash: string,
+                /**
+                 * The block receipt hash.
+                 */
+                public readonly blockReceiptsHash: string,
+                /**
+                 * The state hash.
+                 */
+                public readonly stateHash: string,
+                /**
+                 * The beneficiary public key.
+                 */
+                public readonly beneficiaryPublicKey: PublicAccount,) {
 
     }
 }

test/model/blockchain/BlockInfo.spec.ts

@@ -26,12 +26,16 @@ describe('BlockInfo', () => {
         const blockDTO = {
             block:  {
                 blockTransactionsHash: '702090BA31CEF9E90C62BBDECC0CCCC0F88192B6625839382850357F70DD68A0',
+                blockReceiptsHash: '702090BA31CEF9E90C62BBDECC0CCCC0F88192B6625839382850357F70DD68A0',
+                stateHash: '702090BA31CEF9E90C62BBDECC0CCCC0F88192B6625839382850357F70DD68A0',
                 difficulty: new UInt64([ 276447232, 23283 ]),
+                feeMultiplier: 1,
                 height: new UInt64([ 1, 0 ]),
                 previousBlockHash: '0000000000000000000000000000000000000000000000000000000000000000',
                 signature: '37351C8244AC166BE6664E3FA954E99A3239AC46E51E2B32CEA1C72DD0851100A7731868' +
                 'E932E1A9BEF8A27D48E1FFEE401E933EB801824373E7537E51733E0F',
                 signer: 'B4F12E7C9F6946091E2CB8B6D3A12B50D17CCBBF646386EA27CE2946A7423DCF',
+                beneficiaryPublicKey: 'B4F12E7C9F6946091E2CB8B6D3A12B50D17CCBBF646386EA27CE2946A7423DCF',
                 timestamp: new UInt64([ 0, 0 ]),
                 type: 32768,
                 version: 36867,
@@ -58,8 +62,12 @@ describe('BlockInfo', () => {
             blockDTO.block.height,
             blockDTO.block.timestamp,
             blockDTO.block.difficulty,
+            blockDTO.block.feeMultiplier,
             blockDTO.block.previousBlockHash,
             blockDTO.block.blockTransactionsHash,
+            blockDTO.block.blockReceiptsHash,
+            blockDTO.block.stateHash,
+            PublicAccount.createFromPublicKey(blockDTO.block.beneficiaryPublicKey, network),
         );
 
         expect(blockInfo.hash).to.be.equal(blockDTO.meta.hash);
@@ -74,8 +82,12 @@ describe('BlockInfo', () => {
         deepEqual(blockInfo.height, blockDTO.block.height);
         deepEqual(blockInfo.timestamp, blockDTO.block.timestamp);
         deepEqual(blockInfo.difficulty, blockDTO.block.difficulty);
+        expect(blockInfo.feeMultiplier).to.be.equal(blockDTO.block.feeMultiplier);
         expect(blockInfo.previousBlockHash).to.be.equal(blockDTO.block.previousBlockHash);
         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);
 
     });
 });