Applied openAPI 0.8.7 changes

Author: rg911

e2e/infrastructure/IntegrationTestHelper.ts

@@ -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/MosaicHttp.spec.ts

@@ -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

@@ -47,7 +47,7 @@ describe('NetworkHttp', () => {
 
     describe('getNetworkFees', () => {
         it('should return network fees', async () => {
-            const fees = await networkRepository.getNetworkFees().toPromise();
+            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;

package-lock.json

@@ -45,20 +45,20 @@
     "@types/ws": "^3.2.0",
     "assert": "^1.4.1",
     "chai": "^4.1.2",
-    "coveralls": "^3.0.6",
+    "coveralls": "^3.0.9",
     "gulp": "^4.0.2",
     "gulp-typescript": "^5.0.1",
     "mocha": "^4.0.1",
-    "nyc": "^14.1.1",
+    "nyc": "^15.0.0",
     "secure-random": "^1.1.1",
     "ts-mockito": "^2.4.0",
-    "ts-node": "^5.0.1",
-    "tslint": "^5.20.1",
-    "typescript": "^2.9.2",
+    "ts-node": "^8.6.2",
+    "tslint": "^6.0.0",
+    "typescript": "^3.7.5",
     "typescript-require": "^0.2.10"
   },
   "dependencies": {
-    "bluebird": "^3.5.5",
+    "bluebird": "^3.7.2",
     "catbuffer-typescript": "0.0.11",
     "crypto-js": "^3.1.9-1",
     "diff": "^4.0.2",
@@ -74,10 +74,10 @@
     "ripemd160": "^2.0.2",
     "rxjs": "^6.5.3",
     "rxjs-compat": "^6.5.3",
-    "symbol-openapi-typescript-node-client": "0.8.5",
+    "symbol-openapi-typescript-node-client": "0.8.7",
     "tweetnacl": "^1.0.3",
-    "utf8": "^2.1.2",
-    "ws": "^5.2.0"
+    "utf8": "^3.0.0",
+    "ws": "^7.2.3"
   },
   "peerDependencies": {
     "js-joda": "^1.6.2",

package.json

@@ -16,10 +16,26 @@
 
 import { Observable } from 'rxjs';
 import { map } from 'rxjs/operators';
-import { NetworkRoutesApi } from 'symbol-openapi-typescript-node-client';
-import { NetworkFees } from '../model/network/NetworkFees';
+import { NetworkConfigurationDTO, NetworkRoutesApi } from 'symbol-openapi-typescript-node-client';
+import { AccountLinkNetworkProperties } from '../model/network/AccountLinkNetworkProperties';
+import { AccountRestrictionNetworkProperties } from '../model/network/AccountRestrictionNetworkProperties';
+import { AggregateNetworkProperties } from '../model/network/AggregateNetworkProperties';
+import { ChainProperties } from '../model/network/ChainProperties';
+import { HashLockNetworkProperties } from '../model/network/HashLockNetworkProperties';
+import { MetadataNetworkProperties } from '../model/network/MetadataNetworkProperties';
+import { MosaicNetworkProperties } from '../model/network/MosaicNetworkProperties';
+import { MosaicRestrictionNetworkProperties } from '../model/network/MosaicRestrictionNetworkProperties';
+import { MultisigNetworkProperties } from '../model/network/MultisigNetworkProperties';
+import { NamespaceNetworkProperties } from '../model/network/NamespaceNetworkProperties';
+import { NetworkConfiguration } from '../model/network/NetworkConfiguration';
 import { NetworkName } from '../model/network/NetworkName';
+import { NetworkProperties } from '../model/network/NetworkProperties';
 import { NetworkType } from '../model/network/NetworkType';
+import { PluginProperties } from '../model/network/PluginProperties';
+import { RentalFees } from '../model/network/RentalFees';
+import { SecretLockNetworkProperties } from '../model/network/SecretLockNetworkProperties';
+import { TransactionFees } from '../model/network/TransactionFees';
+import { TransferNetworkProperties } from '../model/network/TransferNetworkProperties';
 import { NodeInfo } from '../model/node/NodeInfo';
 import { Http } from './Http';
 import { NetworkRepository } from './NetworkRepository';
@@ -67,14 +83,81 @@ export class NetworkHttp extends Http implements NetworkRepository {
         return this.call(this.networkRoutesApi.getNetworkType(), (body) => new NetworkName(body.name, body.description));
     }
 
+    /**
+     * Returns the content from a catapult-server network configuration file (resources/config-network.properties).
+     * To enable this feature, the REST setting \"network.propertiesFilePath\" must define where the file is located.
+     * This is adjustable via the configuration file (rest/resources/rest.json) per REST instance.
+     * @summary Get the network properties
+     */
+    public getNetworkProperties(): Observable<NetworkConfiguration> {
+        return this.call(this.networkRoutesApi.getNetworkProperties(), (body) =>
+            this.mapNetworkConfigurationDto(body),
+        );
+    }
+
+    /**
+     * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available
+     * if the REST instance has access to catapult-server ``resources/config-network.properties`` file.
+     * To activate this feature, add the setting \"network.propertiesFilePath\" in the configuration file (rest/resources/rest.json).
+     * @summary Get rental fees information
+     */
+    public getRentalFees(): Observable<RentalFees> {
+        return this.call(this.networkRoutesApi.getRentalFees(), (body) =>
+            new RentalFees(body.effectiveRootNamespaceRentalFeePerBlock,
+                body.effectiveChildNamespaceRentalFee,
+                body.effectiveMosaicRentalFee));
+    }
+
     /**
      * Returns information about the average, median, highest and lower fee multiplier over the last
      * \"numBlocksTransactionFeeStats\". The setting \"numBlocksTransactionFeeStats\" is adjustable
      * via a configuration file (rest/resources/rest.json) per REST instance.
      * @summary Get transaction fees information
      */
-    public getNetworkFees(): Observable<NetworkFees> {
-        return this.call(this.networkRoutesApi.getNetworkFees(), (body) =>
-            new NetworkFees(body.averageFeeMultiplier, body.medianFeeMultiplier, body.highestFeeMultiplier, body.lowestFeeMultiplier));
+    public getTransactionFees(): Observable<TransactionFees> {
+        return this.call(this.networkRoutesApi.getTransactionFees(), (body) =>
+            new TransactionFees(body.averageFeeMultiplier, body.medianFeeMultiplier, body.highestFeeMultiplier, body.lowestFeeMultiplier));
+    }
+
+    /**
+     * Map dto to sdk models
+     * @param dto dto object returned from rest
+     */
+    private mapNetworkConfigurationDto(dto: NetworkConfigurationDTO): NetworkConfiguration {
+        return new NetworkConfiguration(
+            new NetworkProperties(dto.network.identifier, dto.network.nodeEqualityStrategy,
+                dto.network.publicKey, dto.network.generationHash, dto.network.epochAdjustment),
+            new ChainProperties(dto.chain.enableVerifiableState, dto.chain.enableVerifiableReceipts,
+                dto.chain.currencyMosaicId, dto.chain.harvestingMosaicId, dto.chain.blockGenerationTargetTime,
+                dto.chain.blockTimeSmoothingFactor, dto.chain.importanceGrouping, dto.chain.importanceActivityPercentage,
+                dto.chain.maxDifficultyBlocks, dto.chain.maxDifficultyBlocks, dto.chain.defaultDynamicFeeMultiplier,
+                dto.chain.maxTransactionLifetime, dto.chain.maxBlockFutureTime, dto.chain.initialCurrencyAtomicUnits,
+                dto.chain.maxMosaicAtomicUnits, dto.chain.totalChainImportance, dto.chain.minHarvesterBalance,
+                dto.chain.maxHarvesterBalance, dto.chain.harvestBeneficiaryPercentage, dto.chain.blockPruneInterval,
+                dto.chain.maxTransactionsPerBlock),
+            new PluginProperties(
+                new AccountLinkNetworkProperties(dto.plugins.accountlink?.dummy),
+                new AggregateNetworkProperties(dto.plugins.aggregate?.maxTransactionsPerAggregate,
+                    dto.plugins.aggregate?.maxCosignaturesPerAggregate, dto.plugins.aggregate?.enableStrictCosignatureCheck,
+                    dto.plugins.aggregate?.enableBondedAggregateSupport, dto.plugins.aggregate?.maxBondedTransactionLifetime),
+                new HashLockNetworkProperties(dto.plugins.lockhash?.lockedFundsPerAggregate, dto.plugins.lockhash?.maxHashLockDuration),
+                new SecretLockNetworkProperties(dto.plugins.locksecret?.maxSecretLockDuration, dto.plugins.locksecret?.maxProofSize,
+                    dto.plugins.locksecret?.maxProofSize),
+                new MetadataNetworkProperties(dto.plugins.metadata?.maxValueSize),
+                new MosaicNetworkProperties(dto.plugins.mosaic?.maxMosaicsPerAccount, dto.plugins.mosaic?.maxMosaicDuration,
+                    dto.plugins.mosaic?.maxMosaicDivisibility, dto.plugins.mosaic?.mosaicRentalFeeSinkPublicKey,
+                    dto.plugins.mosaic?.mosaicRentalFee),
+                new MultisigNetworkProperties(dto.plugins.multisig?.maxMultisigDepth, dto.plugins.multisig?.maxCosignatoriesPerAccount,
+                    dto.plugins.multisig?.maxCosignedAccountsPerAccount),
+                new NamespaceNetworkProperties(dto.plugins.namespace?.maxNameSize, dto.plugins.namespace?.maxChildNamespaces,
+                    dto.plugins.namespace?.maxNamespaceDepth, dto.plugins.namespace?.minNamespaceDuration,
+                    dto.plugins.namespace?.maxNamespaceDuration, dto.plugins.namespace?.namespaceGracePeriodDuration,
+                    dto.plugins.namespace?.reservedRootNamespaceNames, dto.plugins.namespace?.namespaceRentalFeeSinkPublicKey,
+                    dto.plugins.namespace?.rootNamespaceRentalFeePerBlock, dto.plugins.namespace?.childNamespaceRentalFee),
+                new AccountRestrictionNetworkProperties(dto.plugins.restrictionaccount?.maxAccountRestrictionValues),
+                new MosaicRestrictionNetworkProperties(dto.plugins.restrictionmosaic?.maxMosaicRestrictionValues),
+                new TransferNetworkProperties(dto.plugins.transfer?.maxMessageSize),
+            ),
+        );
     }
 }

src/infrastructure/NetworkHttp.ts

@@ -15,9 +15,11 @@
  */
 
 import {Observable} from 'rxjs';
-import { NetworkFees } from '../model/network/NetworkFees';
+import { NetworkConfiguration } from '../model/network/NetworkConfiguration';
 import { NetworkName } from '../model/network/NetworkName';
 import {NetworkType} from '../model/network/NetworkType';
+import { RentalFees } from '../model/network/RentalFees';
+import { TransactionFees } from '../model/network/TransactionFees';
 
 /**
  * Network interface repository.
@@ -26,23 +28,39 @@ import {NetworkType} from '../model/network/NetworkType';
  */
 export interface NetworkRepository {
 
+    /**
+     * Get current network type name and description
+     *
+     * @return current network type name and description
+     */
+    getNetworkName(): Observable<NetworkName>;
+
+    /**
+     * Returns the content from a catapult-server network configuration file (resources/config-network.properties).
+     * To enable this feature, the REST setting \"network.propertiesFilePath\" must define where the file is located.
+     * This is adjustable via the configuration file (rest/resources/rest.json) per REST instance.
+     * @summary Get the network properties
+     */
+    getNetworkProperties(): Observable<NetworkConfiguration>;
+
     /**
      * Get current network type.
      * @return network type enum.
      */
     getNetworkType(): Observable<NetworkType>;
 
     /**
-     * Get current network type name and description
-     *
-     * @return current network type name and description
+     * Returns the estimated effective rental fees for namespaces and mosaics. This endpoint is only available
+     * if the REST instance has access to catapult-server ``resources/config-network.properties`` file.
+     * To activate this feature, add the setting \"network.propertiesFilePath\" in the configuration file (rest/resources/rest.json).
+     * @summary Get rental fees information
      */
-    getNetworkName(): Observable<NetworkName>;
+    getRentalFees(): Observable<RentalFees>;
 
     /**
-     * Returns information about the average, median, highest and lower fee multiplier over the last "numBlocksTransactionFeeStats".
-     * @return the NetworkFees
+     * Returns the average, median, highest and lower fee multiplier over the last \"numBlocksTransactionFeeStats\".
+     * The setting \"numBlocksTransactionFeeStats\" is adjustable via the configuration file (rest/resources/rest.json) per REST instance.
+     * @summary Get transaction fees information
      */
-    getNetworkFees(): Observable<NetworkFees> ;
-
+    getTransactionFees(): Observable<TransactionFees>;
 }

src/infrastructure/NetworkRepository.ts

@@ -32,10 +32,8 @@ export * from './account/AccountNames';
 export * from './blockchain/BlockchainScore';
 export * from './blockchain/StorageInfo';
 export * from './blockchain/BlockInfo';
-export * from './network/NetworkType';
 export * from './blockchain/MerklePathItem';
 export * from './blockchain/MerkleProofInfo';
-export * from './network/NetworkName';
 
 // Diagnostic
 export * from './node/ServerInfo';
@@ -72,6 +70,28 @@ export * from './namespace/NamespaceRegistrationType';
 export * from './namespace/AliasAction';
 export * from './namespace/EmptyAlias';
 
+// Network
+
+export * from './network/AccountLinkNetworkProperties';
+export * from './network/AccountRestrictionNetworkProperties';
+export * from './network/AggregateNetworkProperties';
+export * from './network/ChainProperties';
+export * from './network/HashLockNetworkProperties';
+export * from './network/MetadataNetworkProperties';
+export * from './network/MosaicNetworkProperties';
+export * from './network/MosaicRestrictionNetworkProperties';
+export * from './network/MultisigNetworkProperties';
+export * from './network/NamespaceNetworkProperties';
+export * from './network/NetworkConfiguration';
+export * from './network/NetworkName';
+export * from './network/NetworkProperties';
+export * from './network/NetworkType';
+export * from './network/PluginProperties';
+export * from './network/RentalFees';
+export * from './network/SecretLockNetworkProperties';
+export * from './network/TransactionFees';
+export * from './network/TransferNetworkProperties';
+
 // Node
 export * from './node/NodeInfo';
 export * from './node/NodeTime';

src/model/model.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2020 NEM
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class AccountLinkNetworkProperties {
+
+    /**
+     * @param dummy - to trigger plugin load.
+     */
+    constructor(public readonly dummy?: string) {
+    }
+}

src/model/network/AccountLinkNetworkProperties.ts

@@ -0,0 +1,24 @@
+/*
+ * Copyright 2020 NEM
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+export class AccountRestrictionNetworkProperties {
+
+    /**
+     * @param maxAccountRestrictionValues - Maximum number of account restriction values.
+     */
+    constructor(public readonly maxAccountRestrictionValues?: string) {
+    }
+}