v0.17.4 (#514)

* Created `network` folder for network models

* Fixed lint after files moved

* Applied openAPI 0.8.7 changes

* Added tests

* Use UInt64 in retalFees

* Fixed #455
Make namespace max depth configurable in idGenerator

* - Fixed parser bug
- Use rest json payload for unit testing

* restored removed tests to cover models

* Working on travis release process and ts-doc github deployments

* Simplfied BlockHttp
Added BlockHttp unit tests
Changed travis to just report coveralls from one job

* fixed travis

* Uploading multiple versions of ts-docs into git hub pages

* Improved ChainHttp, added unit tests

* Removed maxDepth. Let server run the validation

* Added unit tests

* FIxed #493

* Added tests

* useQuerystring on all https

* Fixed github token env variable name
Added escape skip flag to avoid republishing the same version
Added missing git commit . after version increase

* Update README links

* Update README.md

* Update release.sh

* Update README.md

* Installing typescript globally

* Improved MetadataHttp, added unit tests

* fixed #495

* Fixed #501

* fixed #503

* Refactored MosaicService unit test (#510)

* Fixed #509

* Added mosaicHttp unit tests

* Refactored mosaicHttp to use abstract caller

* Add error trapping unit test

* removed unused error catcher

* add SimpleWallet.toDTO, fixes #504 (#508)

* add SimpleWallet.toDTO, fixes #504

* add word2ua test

* Update README.md (#512)

* v0.17.4 release (#513)

* v0.17.4 release

* Updated md table header

Co-authored-by: Fernando Boucquez <fboucquez@gmail.com>
Co-authored-by: David Garcia <dgarcia360@outlook.com>
Co-authored-by: Decentraliser <me@decentraliser.dev>

Author: 4 people

.travis.yml

@@ -10,20 +10,27 @@ before_script:
   - npm run build
 script:
   - npm run test:cov
-  - npm run coveralls-report
-  - npm install --global typedoc
-  - typedoc --out ts-docs src
+  - npm install --global typedoc typescript
+  - CURRENT_VERSION=$(npm run version --silent)
+  - typedoc --out "ts-docs/$CURRENT_VERSION" src
   - touch ./ts-docs/.nojekyll
+  - if [ "$TRAVIS_NODE_VERSION" = "8" ]; then npm run coveralls-report; fi
 deploy:
-  - provider: pages
+  - provider: script
     skip_cleanup: true
-    local_dir: ts-docs
-    github_token: $GITHUB_TOKEN
+    script: /bin/sh travis/github-pages.sh
     on:
       branch: master
+      node_js: "9"
   - provider: script
     skip_cleanup: true
     script: /bin/sh travis/uploadArchives.sh
     on:
       branch: master
       node_js: "8"
+  - provider: script
+    skip_cleanup: true
+    script: /bin/sh travis/release.sh
+    on:
+      branch: $RELEASE_BRANCH
+      node_js: "8"

CHANGELOG.md

@@ -3,10 +3,28 @@ All notable changes to this project will be documented in this file.
 
 The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.17.4] - 07-Apr-2020
+
+**Milestone**: Fushicho.4(RC3 0.9.3.2)
+ Package  | Version  | Link
+---|---|---
+SDK Core| v0.17.4 | https://www.npmjs.com/package/symbol-sdk
+Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
+Client Library | v0.8.9  | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
+
+- Added `SimpleWallet.toDTO()` method which returns JSON serialized object.
+- Applied latest Symbol OpenAPI generated code (`v0.8.9`).
+- Added automated release scripts for Travis.
+- Added multiple version spport for TS-Doc.
+- Optimised unit tests and improved test coverage.
+- Changed internal method `getSigningByte` to public.
+- Removed constant of namespace `MaxDepth (default: 3)` which can be retrieved from network properties endpoint.
+- Fixed Github security alert on `minimist` package.
+
 ## [0.17.3] - 04-Mar-2020
 
 **Milestone**: Fushicho.4(RC3 0.9.3.1)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.17.3 | https://www.npmjs.com/package/symbol-sdk
 Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
@@ -18,7 +36,7 @@ Client Library | v0.8.5  | https://www.npmjs.com/package/symbol-openapi-typescri
 ## [0.17.2] - 02-Mar-2020
 
 **Milestone**: Fushicho.4(RC3 0.9.3.1)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.17.2 | https://www.npmjs.com/package/symbol-sdk
 Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
@@ -33,7 +51,7 @@ Client Library | v0.8.5  | https://www.npmjs.com/package/symbol-openapi-typescri
 ## [0.17.1] - 24-Feb-2020
 
 **Milestone**: Fushicho.4(RC3 0.9.3.1)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.17.1 | https://www.npmjs.com/package/symbol-sdk
 Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
@@ -47,7 +65,7 @@ Client Library | v0.8.5  | https://www.npmjs.com/package/symbol-openapi-typescri
 ## [0.17.0] - 17-Feb-2020
 
 **Milestone**: Fushicho.4(RC3 0.9.3.1)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core | v0.17.0 | https://www.npmjs.com/package/nem2-sdk
 catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer
@@ -67,7 +85,7 @@ Client Library | v0.8.4  | https://www.npmjs.com/package/nem2-sdk-openapi-typesc
 ## [0.16.5] - 30-Jan-2020
 
 **Milestone**: Fushicho.4(RC3)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.16.5 | https://www.npmjs.com/package/nem2-sdk
 catbuffer Library| v0.0.11 | https://www.npmjs.com/package/catbuffer
@@ -78,7 +96,7 @@ Client Library | v0.7.20-beta.7  | https://www.npmjs.com/package/nem2-sdk-openap
 ## [0.16.4] - 30-Jan-2020
 
 **Milestone**: Fushicho.4(RC3)
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.16.4 | https://www.npmjs.com/package/nem2-sdk
 catbuffer Library| v0.0.11 | https://www.npmjs.com/package/catbuffer
@@ -96,7 +114,7 @@ Client Library | v0.7.20-beta.7  | https://www.npmjs.com/package/nem2-sdk-openap
 ## [0.16.3] - 09-Jan-2020
 
 **Milestone**: Fushicho.3
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.16.3 | https://www.npmjs.com/package/nem2-sdk
 catbuffer Library| v0.0.7 | https://www.npmjs.com/package/catbuffer
@@ -107,7 +125,7 @@ Client Library | v0.7.20-beta.6  | https://www.npmjs.com/package/nem2-sdk-openap
 ## [0.16.2] - 06-Jan-2020
 
 **Milestone**: Fushicho.3
- Versions  |   |
+ Package  | Version  | Link
 ---|---|---
 SDK Core| v0.16.2 | https://www.npmjs.com/package/nem2-sdk
 catbuffer Library| v0.0.7 | https://www.npmjs.com/package/catbuffer
@@ -419,6 +437,7 @@ Client Library | v0.7.20-alpha.6  | https://www.npmjs.com/package/nem2-sdk-opena
 
 - Initial code release.
 
+[0.17.4]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.17.3...v0.17.4
 [0.17.3]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.17.2...v0.17.3
 [0.17.2]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.17.1...v0.17.2
 [0.17.1]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.17.0...v0.17.1

README.md

@@ -1,23 +1,23 @@
 # Symbol SDK for TypeScript and JavaScript
 
 [![npm version](https://badge.fury.io/js/symbol-sdk.svg)](https://badge.fury.io/js/symbol-sdk)
-[![Build Status](https://api.travis-ci.org/nemtech/symbol-sdk-typescript-javascript.svg?branch=master)](https://travis-ci.org/nemtech/symbol-sdk-typescript-javascript)
+[![Build Status](https://api.travis-ci.com/nemtech/symbol-sdk-typescript-javascript.svg?branch=master)](https://travis-ci.com/nemtech/symbol-sdk-typescript-javascript)
 [![Coverage Status](https://coveralls.io/repos/github/nemtech/symbol-sdk-typescript-javascript/badge.svg)](https://coveralls.io/github/nemtech/symbol-sdk-typescript-javascript?branch=travis-ci)
 [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 The Symbol SDK for TypeScript / JavaScript allows you to develop web, mobile, and Node.js applications.
 
 ## Important Notes
 
-### _Fushicho_ Network Compatibility (catapult-server@0.9.3.1)
+### _Fushicho_ Network Compatibility (catapult-server@0.9.3.2)
 
 **!!! Please be noted that the NEM2-SDK is rebranded to SYMBOL-SDK now**.
 
-Due to a network upgrade with [catapult-server@Fushicho](https://github.com/nemtech/catapult-server/releases/tag/v0.9.3.1) version, **it is recommended to use this package's 0.17.3 version and upwards to use this package with Fushicho versioned networks**.
+Due to a network upgrade with [catapult-server@Fushicho](https://github.com/nemtech/catapult-server/releases/tag/v0.9.3.2) version, **it is recommended to use this package's 0.17.4 version and upwards to use this package with Fushicho versioned networks**.
 
-The upgrade to this package's [version v0.17.3](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.17.3) is mandatory for **fushicho compatibility**.
+The upgrade to this package's [version v0.17.4](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.17.4) is mandatory for **fushicho compatibility**.
 
-You can find the complete changelog [here](CHANGELOG.md).
+Find the complete release notes [here](CHANGELOG.md).
 
 ## Requirements
 
@@ -35,32 +35,37 @@ npm install symbol-sdk rxjs
 
 ## Usage
 
-Surf the [NEM Developer Center][docs] to get started into NEM development. You will find self-paced guides and useful code snippets using the TypeScript/Javascript SDK.
+Surf the [documentation][docs] to get started into Symbol development.
+You will find self-paced guides and useful code snippets using the TypeScript/Javascript SDK.
 
 To get the full description of the available classes and their functions, check the [SDK reference][sdk-ref].
 
 ## Getting help
 
 Use the following available resources to get help:
 
-- [Symbol SDK Typescript/Javascript Reference][docs]
+- [Symbol Documentation][docs]
+- [Symbol SDK Typescript/Javascript Reference][sdk-ref]
+- Join the community [slack group (#sig-api)][slack] 
 - If you found a bug, [open a new issue][issues]
 
 ## Contributing
 
-This project is developed and maintained by NEM Foundation. Contributions are welcome and appreciated. You can find [symbol-sdk on GitHub][self].
+This project is developed and maintained by NEM Foundation.
 
-Feel free to start an issue or create a pull request. Check [CONTRIBUTING](CONTRIBUTING.md) before start.
+Contributions are welcome and appreciated. 
+Check [CONTRIBUTING](CONTRIBUTING.md) for information on how to contribute.
 
 You can also find useful notes for developers under our documentation [guidelines][guidelines] section.
 
 ## License
 
-Copyright (c) 2018-2019 NEM
+Copyright (c) 2018-present NEM
 Licensed under the [Apache License 2.0](LICENSE)
 
 [self]: https://github.com/nemtech/symbol-sdk-typescript-javascript
 [docs]: http://nemtech.github.io/getting-started/setup-workstation.html
 [issues]: https://github.com/nemtech/symbol-sdk-typescript-javascript/issues
-[sdk-ref]: http://nemtech.github.io/symbol-sdk-typescript-javascript
+[sdk-ref]: https://nemtech.github.io/references/typescript-sdk.html
 [guidelines]: https://nemtech.github.io/contribute/contributing.html#sdk
+[slack]: https://join.slack.com/t/nem2/shared_invite/enQtMzY4MDc2NTg0ODgyLWZmZWRiMjViYTVhZjEzOTA0MzUyMTA1NTA5OWQ0MWUzNTA4NjM5OTJhOGViOTBhNjkxYWVhMWRiZDRkOTE0YmU

e2e/infrastructure/AccountHttp.spec.ts

@@ -23,11 +23,11 @@ import { QueryParams } from '../../src/infrastructure/QueryParams';
 import { Account } from '../../src/model/account/Account';
 import { Address } from '../../src/model/account/Address';
 import { PublicAccount } from '../../src/model/account/PublicAccount';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
 import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { NetworkCurrencyLocal } from '../../src/model/mosaic/NetworkCurrencyLocal';
 import { AliasAction } from '../../src/model/namespace/AliasAction';
 import { NamespaceId } from '../../src/model/namespace/NamespaceId';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { AddressAliasTransaction } from '../../src/model/transaction/AddressAliasTransaction';
 import { AggregateTransaction } from '../../src/model/transaction/AggregateTransaction';
 import { Deadline } from '../../src/model/transaction/Deadline';

e2e/infrastructure/BlockHttp.spec.ts

@@ -21,9 +21,9 @@ import { BlockRepository } from '../../src/infrastructure/BlockRepository';
 import { QueryParams } from '../../src/infrastructure/QueryParams';
 import { ReceiptRepository } from '../../src/infrastructure/ReceiptRepository';
 import { Account } from '../../src/model/account/Account';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
 import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { NetworkCurrencyLocal } from '../../src/model/mosaic/NetworkCurrencyLocal';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { Deadline } from '../../src/model/transaction/Deadline';
 import { TransactionInfo } from '../../src/model/transaction/TransactionInfo';
 import { TransferTransaction } from '../../src/model/transaction/TransferTransaction';

e2e/infrastructure/IntegrationTestHelper.ts

@@ -19,7 +19,7 @@ import { IListener } from '../../src/infrastructure/IListener';
 import { RepositoryFactory } from '../../src/infrastructure/RepositoryFactory';
 import { RepositoryFactoryHttp } from '../../src/infrastructure/RepositoryFactoryHttp';
 import { Account } from '../../src/model/account/Account';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { SignedTransaction } from '../../src/model/transaction/SignedTransaction';
 import { Transaction } from '../../src/model/transaction/Transaction';
 import { UInt64 } from '../../src/model/UInt64';
@@ -57,7 +57,8 @@ export class IntegrationTestHelper {
                     console.log(`Running tests against: ${json.apiUrl}`);
                     this.apiUrl = json.apiUrl;
                     this.repositoryFactory = new RepositoryFactoryHttp(json.apiUrl);
-                    this.transactionService = new TransactionService(this.repositoryFactory.createTransactionRepository(), this.repositoryFactory.createReceiptRepository());
+                    this.transactionService = new TransactionService(
+                        this.repositoryFactory.createTransactionRepository(), this.repositoryFactory.createReceiptRepository());
                     combineLatest(this.repositoryFactory.getGenerationHash(),
                         this.repositoryFactory.getNetworkType()).subscribe(([generationHash, networkType]) => {
                         this.networkType = networkType;

e2e/infrastructure/Listener.spec.ts

@@ -20,12 +20,12 @@ import { AccountRepository } from '../../src/infrastructure/AccountRepository';
 import { NamespaceRepository } from '../../src/infrastructure/NamespaceRepository';
 import { TransactionRepository } from '../../src/infrastructure/TransactionRepository';
 import { Account } from '../../src/model/account/Account';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
 import { PlainMessage } from '../../src/model/message/PlainMessage';
 import { Address, CosignatureTransaction, LockFundsTransaction, Mosaic, SignedTransaction, UInt64 } from '../../src/model/model';
 import { MosaicId } from '../../src/model/mosaic/MosaicId';
 import { NetworkCurrencyLocal } from '../../src/model/mosaic/NetworkCurrencyLocal';
 import { NamespaceId } from '../../src/model/namespace/NamespaceId';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { AggregateTransaction } from '../../src/model/transaction/AggregateTransaction';
 import { Deadline } from '../../src/model/transaction/Deadline';
 import { MultisigAccountModificationTransaction } from '../../src/model/transaction/MultisigAccountModificationTransaction';

e2e/infrastructure/MetadataHttp.spec.ts

@@ -18,11 +18,11 @@ import { expect } from 'chai';
 import { MetadataRepository } from '../../src/infrastructure/MetadataRepository';
 import { Account } from '../../src/model/account/Account';
 import { Address } from '../../src/model/account/Address';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
 import { MosaicFlags } from '../../src/model/mosaic/MosaicFlags';
 import { MosaicId } from '../../src/model/mosaic/MosaicId';
 import { MosaicNonce } from '../../src/model/mosaic/MosaicNonce';
 import { NamespaceId } from '../../src/model/namespace/NamespaceId';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { AccountMetadataTransaction } from '../../src/model/transaction/AccountMetadataTransaction';
 import { AggregateTransaction } from '../../src/model/transaction/AggregateTransaction';
 import { Deadline } from '../../src/model/transaction/Deadline';

e2e/infrastructure/MosaicHttp.spec.ts

@@ -17,12 +17,12 @@ import { expect } from 'chai';
 import { MosaicRepository } from '../../src/infrastructure/MosaicRepository';
 import { NamespaceRepository } from '../../src/infrastructure/NamespaceRepository';
 import { Account } from '../../src/model/account/Account';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
 import { MosaicFlags } from '../../src/model/mosaic/MosaicFlags';
 import { MosaicId } from '../../src/model/mosaic/MosaicId';
 import { MosaicNonce } from '../../src/model/mosaic/MosaicNonce';
 import { AliasAction } from '../../src/model/namespace/AliasAction';
 import { NamespaceId } from '../../src/model/namespace/NamespaceId';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { Deadline } from '../../src/model/transaction/Deadline';
 import { MosaicAliasTransaction } from '../../src/model/transaction/MosaicAliasTransaction';
 import { MosaicDefinitionTransaction } from '../../src/model/transaction/MosaicDefinitionTransaction';
@@ -87,7 +87,8 @@ describe('MosaicHttp', () => {
             expect(mosaicDefinitionTransaction.nonce).to.deep.equal(listenedTransaction.nonce);
             expect(mosaicDefinitionTransaction.getMosaicNonceIntValue()).to.be.equal(listenedTransaction.getMosaicNonceIntValue());
 
-            const savedTransaction = await helper.repositoryFactory.createTransactionRepository().getTransaction(signedTransaction.hash).toPromise() as MosaicDefinitionTransaction;
+            const savedTransaction = await helper.repositoryFactory.createTransactionRepository()
+                .getTransaction(signedTransaction.hash).toPromise() as MosaicDefinitionTransaction;
             expect(mosaicDefinitionTransaction.nonce.toHex()).to.be.equal(savedTransaction.nonce.toHex());
             expect(mosaicDefinitionTransaction.nonce).to.deep.equal(savedTransaction.nonce);
             expect(mosaicDefinitionTransaction.getMosaicNonceIntValue()).to.be.equal(savedTransaction.getMosaicNonceIntValue());

e2e/infrastructure/NetworkHttp.spec.ts

@@ -15,7 +15,7 @@
  */
 import { expect } from 'chai';
 import { NetworkRepository } from '../../src/infrastructure/NetworkRepository';
-import { NetworkType } from '../../src/model/blockchain/NetworkType';
+import { NetworkType } from '../../src/model/network/NetworkType';
 import { IntegrationTestHelper } from './IntegrationTestHelper';
 
 describe('NetworkHttp', () => {
@@ -45,13 +45,30 @@ describe('NetworkHttp', () => {
         });
     });
 
-    describe('getNetworkFees', () => {
-        it('should return network fees', async () => {
-            const fees = await networkRepository.getNetworkFees().toPromise();
+    describe('getTransactionFees', () => {
+        it('should return transaction fees', async () => {
+            const fees = await networkRepository.getTransactionFees().toPromise();
             expect(fees.averageFeeMultiplier).to.be.not.null;
             expect(fees.highestFeeMultiplier).to.be.not.null;
             expect(fees.lowestFeeMultiplier).to.be.not.null;
             expect(fees.medianFeeMultiplier).to.be.not.null;
         });
     });
+    describe('getRentalFees', () => {
+        it('should return rental fees', async () => {
+            const fees = await networkRepository.getRentalFees().toPromise();
+            expect(fees.effectiveChildNamespaceRentalFee).to.be.not.null;
+            expect(fees.effectiveMosaicRentalFee).to.be.not.null;
+            expect(fees.effectiveRootNamespaceRentalFeePerBlock).to.be.not.null;
+        });
+    });
+
+    describe('getNetworkProperties', () => {
+        it('should return network configuration', async () => {
+            const config = await networkRepository.getNetworkProperties().toPromise();
+            expect(config.network).to.be.not.null;
+            expect(config.chain).to.be.not.null;
+            expect(config.plugins).to.be.not.null;
+        });
+    });
 });