Task/g109 optional duration for mosaic transaction

CHANGELOG.md

@@ -1,32 +1,54 @@
-# CHANGELOG
+# Changelog
+All notable changes to this project will be documented in this file.
 
-# v0.11
+The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
-- Fixed NetworkCurrencyMosaic, NetworkHarvestMosaic
-- Added exposed UInt64.fromHex and UInt64.toHex
-- Added MosaicId.createFromNonce
-- Added MosaicNonce, MosaicNonce.createRandom
-- Fixed AliasDTO.mosaicId to be UInt64
-- Added nem2-library@v0.9.8 version update (cow compatibility)
-- Added cow network update *base* compatibility
-- Added AliasTransaction, AddressAliasTransaction, MosaicAliasTransaction
-- Changed MosaicDefinition to hold MosaicNonce
-- Changed SecretLock transaction to work with Sha3_256 instead of Sha3_512
-- Added delegated harvesting
-- Fixed #38: error message for aggregate as inner tx
-- Added TransferTransaction.recipient NamespaceId argument type
+## [0.11.2] - 1-Apr-2019
+- Todo.
 
-# v0.10.1-beta
+## [0.11.1] - 18-Mar-2019
+- Todo.
+## [0.11] - 14-Mar-2019
 
-- added replyGiven in Transaction model
-- several linter fixes
+## Added
+- UInt64.fromHex and UInt64.toHex functions have been exposed.
+- Error message when a developer tries to add an aggregate as an inner transaction.
+- AccountLink Transaction to enable delegated harvesting.
+- Support for AliasTransaction.
+- TransferTransactions can be sent to an alias instead of an address.
 
-# v0.10.0-beta
+## Changed
+- Mosaics were splited from namespaces. MosaicDefinition does not have a related namespaceId, but instead a MosaicNonce.
+- SecretLockTransaction to work with Sha3_256 instead of Sha3_512
+- Network and nem2-library (0.9.8) required update to be compatible with catpault-server 0.3.
+- XEM class splited into NetworkCurrencyMosaic and NetworkHarvestMosaic.
 
-- update rxjs to v6
-- use observableFrom
+## [0.10.1-beta] - 27-Jun-2018
 
-# v0.9.5
+## Added
+- Transaction deadline has been exposed to the public.
 
-- data signatures
-- nodejs version 10 updates
+## Changed
+- Compatibility with rxjs v6.
+
+## Fixed
+- Several linter errors.
+
+## [0.9.5] - 27-Jun-2018
+
+## Added
+- An account can sign strings with its private key, and verify the signature later.
+
+## Changed
+- Compatibility with Node.js 10.
+
+## [0.9.0] - 30-Mar-2018
+### Added
+- Initial code release.
+
+[0.11.2]: https://github.com/nemtech/nem2-sdk-typescript-javascript/compare/v0.11.1...v0.11.2
+[0.11.1]: https://github.com/nemtech/nem2-sdk-typescript-javascript/compare/v0.11.0...v0.11.1
+[0.11]: https://github.com/nemtech/nem2-sdk-typescript-javascript/compare/v0.10.1-beta...v0.11.0
+[0.10.1-beta]: https://github.com/nemtech/nem2-sdk-typescript-javascript/compare/v0.9.5...v0.10.1-beta
+[0.9.5]: https://github.com/nemtech/nem2-sdk-typescript-javascript/compare/v0.9.0...v0.9.5
+[0.9.0]: https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.9.0

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();
+                });
+        });
+    });
 });

e2e/infrastructure/TransactionUtils.ts

@@ -28,6 +28,7 @@ import { MultisigCosignatoryModification } from '../../src/model/transaction/Mul
 import { MultisigCosignatoryModificationType } from '../../src/model/transaction/MultisigCosignatoryModificationType';
 import {PlainMessage} from '../../src/model/transaction/PlainMessage';
 import {TransferTransaction} from '../../src/model/transaction/TransferTransaction';
+import {UInt64} from '../../src/model/UInt64';
 import {CosignatoryAccount, MultisigAccount, NIS2_URL, TestingAccount} from '../../test/conf/conf.spec';
 
 export class TransactionUtils {

package.json

@@ -53,7 +53,7 @@
     "@types/crypto-js": "^3.1.43",
     "crypto-js": "^3.1.9-1",
     "js-joda": "^1.6.2",
-    "nem2-library": "^0.9.13",
+    "nem2-library": "^0.9.14",
     "request": "^2.83.0",
     "request-promise-native": "^1.0.5",
     "rxjs": "^6.2.1",

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.
@@ -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,
+                extractBeneficiary(blockDTO, 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,
+                    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',
@@ -135,8 +136,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,
+                                extractBeneficiary(message, networkType), // passing `message` as `blockDTO`
                             ),
                         });
                     } else if (message.status) {

src/infrastructure/TransactionHttp.ts

@@ -14,17 +14,18 @@
  * 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';
 import {SignedTransaction} from '../model/transaction/SignedTransaction';
 import { SyncAnnounce } from '../model/transaction/SyncAnnounce';
 import {Transaction} from '../model/transaction/Transaction';
 import {TransactionAnnounceResponse} from '../model/transaction/TransactionAnnounceResponse';
+import {TransactionInfo} from '../model/transaction/TransactionInfo';
 import {TransactionStatus} from '../model/transaction/TransactionStatus';
 import {TransactionType} from '../model/transaction/TransactionType';
 import {UInt64} from '../model/UInt64';
@@ -44,13 +45,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 +198,29 @@ 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) => {
+                // parse transaction to take advantage of `size` getter overload
+                const transaction = CreateTransactionFromDTO(transactionDTO);
+                const uintHeight = (transaction.transactionInfo as TransactionInfo).height;
+
+                // now read block details
+                return observableFrom(this.blockchainRoutesApi.getBlockByHeight(uintHeight.compact())).pipe(
+                map((blockDTO) => {
+
+                    // @see https://nemtech.github.io/concepts/transaction.html#fees
+                    // effective_fee = feeMultiplier x transaction::size
+                    return blockDTO.block.feeMultiplier * transaction.size;
+                }));
+            }), catchError((err) => {
+                return observableThrowError(err);
+            }));
+    }
 }

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