diff --git a/CHANGELOG.md b/CHANGELOG.md index f4e2eef843..e55dc08c60 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -3,6 +3,29 @@ 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.18.0] - 20-Apr-2020 + +**Milestone**: Fushicho.4(RC3 0.9.3.2) + Package | Version | Link +---|---|--- +SDK Core| v0.18.0 | 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 + +- **[BREAKING CHANGE]** Stopped NodeJS v8 and v9 support. From this version (`v0.18.0`) onwards, Symbol-SDK will target on Node v10+. +- **[BREAKING CHANGE]** Removed `Keccac_256` from `LockHashAlgorithm` (enum index changed). +- **[BREAKING CHANGE]** Updated enum name `HashType` to `LockHashAlgorithm`. +- **[BREAKING CHANGE]** Updated property name `hashType` to `hashAlgorithm` in `SecretLockTransaction` and `SecretProofTransaction`. +- **[BREAKING CHANGE]** Removed redundant argument `NetworkType` from `Transaction.createTransactionHash()` and `Address.isValidRawAddress()`. +- **[BREAKING CHANGE]** Added `setMaxFeeForAggregate()` for `AggregateTransaction`. `Transaction.setMaxFee()` can only be used by standalone transaction objects. +- **[BREAKING CHANGE]** Refactored `SimpleWallet` model and wallet private key `Encryption / Decryption` methods to patch potential security risk. +- Added `AccountService` to resolve mosaic alias and return namespace name. +- Migrated from `TSLint` to `ESLint`. Added `Prettier` support. +- Removed metadata value size validation (1024 bytes). +- Fixed `PublicAccount.verifySignature` bug when verify string in hexadecimal format. +- Added check on `UInt64.compact()` which throw exception on over flow. +- Added `Network currency resolver` for e2e tests. + ## [0.17.4] - 07-Apr-2020 **Milestone**: Fushicho.4(RC3 0.9.3.2) @@ -437,6 +460,7 @@ Client Library | v0.7.20-alpha.6 | https://www.npmjs.com/package/nem2-sdk-opena - Initial code release. +[0.18.0]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.17.4...v0.18.0 [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 diff --git a/README.md b/README.md index a892167259..4ad5425a09 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,9 @@ The Symbol SDK for TypeScript / JavaScript allows you to develop web, mobile, an ### _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.2) version, **it is recommended to use this package's 0.18.0 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.4](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.17.4) is mandatory for **fushicho compatibility**. +The upgrade to this package's [version v0.18.0](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.18.0) is mandatory for **fushicho compatibility**. Find the complete release notes [here](CHANGELOG.md). @@ -23,9 +21,7 @@ Find the complete release notes [here](CHANGELOG.md). ### NodeJS -- NodeJS 8.9.X -- NodeJS 9.X.X -- NodeJS 10.X.X +- NodeJS 10.X.X and above (from v0.18.0) ## Installation @@ -46,14 +42,14 @@ Use the following available resources to get help: - [Symbol Documentation][docs] - [Symbol SDK Typescript/Javascript Reference][sdk-ref] -- Join the community [slack group (#sig-api)][slack] +- 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. +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. diff --git a/package-lock.json b/package-lock.json index 6286f3c703..4c987b5ae1 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "symbol-sdk", - "version": "0.18.0", + "version": "0.18.1", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 80c2f5dbb2..aa01f1254a 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "symbol-sdk", - "version": "0.18.0", + "version": "0.18.1", "description": "Reactive symbol sdk for typescript and javascript", "scripts": { "pretest": "npm run build",