Skip to content

Commit 0cf51c0

Browse files
rg911rg911
committed
9.6.1 change note
1 parent 4165200 commit 0cf51c0

File tree

2 files changed

+91
-44
lines changed

2 files changed

+91
-44
lines changed

‎CHANGELOG.md‎

Lines changed: 88 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,67 @@
11
# CHANGELOG
2+
23
All notable changes to this project will be documented in this file.
34

45
The changelog format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
56

7+
## [0.20.0] - 18-Jun-2020
8+
9+
**Milestone**: Gorilla.1(0.9.6.1)
10+
Package | Version | Link
11+
---|---|---
12+
SDK Core| v0.20.0 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
13+
Catbuffer | v0.0.20 | [catbuffer-typescript](]-typescript)
14+
Client Library | v0.9.2 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
15+
16+
- **[BREAKING CHANGE]** Model property name changes:
17+
1. **MetadataEntry**: senderPublicKey: string => sourceAddress: Address; targetPublicKey: string => targetAddress: Address
18+
2. **MultisigAccountGraphInfo**: multisigAccounts => multisigEntries
19+
3. **MultisigAccountInfo**: account: PublicAccount => accountAddress: Address; cosignatories: PublicAccount[] => cosignatoryAddresses: Address; multisigAccounts: PublicAccount[] => multisigAddresses: Address[]
20+
4. **BlockInfo / NewBlock**: beneficiaryPublicKey: PublicAccount | undefined => beneficiaryAddress: Address | undefined
21+
5. **MosaicId**: owner: PublicAccount => ownerAddress: Address
22+
6. **MosaicInfo**: owner: PublicAccount => ownerAddress: Address; height => startHeight.
23+
7. **NamespaceInfo**: owner: PublicAccount => ownerAddress: Address
24+
8. **ChainProperties**: harvestNetworkFeeSinkPublicKey => harvestNetworkFeeSinkAddress
25+
9. **MosaicNetworkProperties**: mosaicRentalFeeSinkPublicKey => mosaicRentalFeeSinkAddress
26+
10. **NamespaceNetworkProperties**: namespaceRentalFeeSinkPublicKey => namespaceRentalFeeSinkAddress
27+
11. **NetworkProperties**: publicKey => nemesisSignerPublicKey
28+
12. **BalanceChangeReceipt**: targetPublicAccount: PublicAccount => targetAddress: Address
29+
13. **BalanceTransferReceipt**: sender: PublicAccount => senderAddress: Address
30+
- **[BREAKING CHANGE]** Transaction property name changes:
31+
1. **AccountMetadataTransaction**: targetPublicKey: string => targetAddress: UnresolvedAddress
32+
2. **MosaicMetadataTransaction**: targetPublicKey: string => targetAddress: UnresolvedAddress
33+
3. **NamespaceMetadataTransaction**: targetPublicKey: string => targetAddress: UnresolvedAddress
34+
4. **MultisigAccountModificationTransaction**: publicKeyAdditions: PublicAccount[] => addressAdditions: UnresolvedAddress[]; publicKeyDeletions: PublicAccount[] => addressDeletions: UnresolvedAddress[]
35+
5. **AggregateTransactionService**: cosignatories: string[] => cosignatories: Address[]
36+
- **[BREAKING CHANGE]** **Address** format changed from 25 bytes to 24 bytes. See new address test vector [here](https://github.com/nemtech/test-vectors/blob/master/1.test-address.json).
37+
- **[BREAKING CHANGE]** MosaicId creation (from Nonce) changed from using **PublicKey** to **Address**. See new mosaicId test vector [here](https://github.com/nemtech/test-vectors/blob/master/5.test-mosaic-id.json).
38+
- **[BREAKING CHANGE]** Added 8 bytes (uint64) **version** field in `CosignatureSignedTransaction` and `AggregateTransactionCosignature` with default value `0`.
39+
- **[BREAKING CHANGE]** Removed all transaction get endpoints from **AccountHttp** and **BlockHttp**.
40+
- **[BREAKING CHANGE]** Added `TransactionGroup (required)` parameter in `getTransaction` endpoint in `TransactionHttp`.
41+
- Added `Search` endpoints to TransactionHttp, BlockHttp, and MosaicHttp.
42+
43+
**Note:**
44+
45+
1. Search endpoints returns pagination payload (`Page<t>`) rather than raw arraes.
46+
2. For **AggregateTransaction**, transaction search endpoint only returns the aggregate wrapper transaction **WITHOUT** embedded transactions. `complete` aggregate payload can be get from `getTransaction` or `getTransactionByIds` endpoints.
47+
- Added SearchCriteria interfaces for the new search endpoints.
48+
- **group** filter in in `TransactionSearchCriteria` to be mandatory due to rest endpoint changes.
49+
- Added **streamer** for the 3 new search endpoints (block, mosaic, transaction) to improve pagination querying.
50+
- Added `size` in `BlockInfo` model.
51+
652
## [0.19.2] - 26-May-2020
753

854
**Milestone**: Gorilla.1(0.9.5.1)
955
Package | Version | Link
1056
---|---|---
11-
SDK Core| v0.19.2 | https://www.npmjs.com/package/symbol-sdk
12-
Catbuffer | v0.0.19 | https://www.npmjs.com/package/catbuffer-typescript
13-
Client Library | v0.8.11 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
57+
SDK Core| v0.19.2 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
58+
Catbuffer | v0.0.19 | [catbuffer-typescript](]-typescript)
59+
Client Library | v0.8.11 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
1460

15-
- **[BREAKING CHANGE]** Replaced constructor parameter `config` with `url` in `Listener` class. The constructor is now **only using a complete websocket url (e.g. http://localhost:3000/ws or ws://localhost:3000/ws) but not rest-gateway url anymore (It will NOT append `/ws` suffix to the input url)**.
61+
- **[BREAKING CHANGE]** Replaced constructor parameter `config` with `url` in `Listener` class. The constructor is now **only using a complete websocket url (e.g. [http://localhost:3000/ws](http://localhost:3000/ws) or ws://localhost:3000/ws) but not rest-gateway url anymore (It will NOT append `/ws` suffix to the input url)**.
1662
- **[BREAKING CHANGE]** `RepositoryFactory`: Optional constructor parameters has been moved into `RepositoryFactoryConfig` interface (optional).
1763
- **[BREAKING CHANGE]** Added `websocketInjected` (optional) parameter to the `RepositoryFactoryConfig` interface. `RepositoryFactory.createListener()` can now take injected websocket instance to create `Listener` object.
18-
- **[BREAKING CHANGE]** Added `websocketUrl` (optional) parameter to the `RepositoryFactoryConfig` interface. it allows custom websocket url to be used to create the `Listener` object. By default (not provided), the factory will use rest-gateway url with '/ws' suffix appended (e.g. http://localhost:3000/ws)
64+
- **[BREAKING CHANGE]** Added `websocketUrl` (optional) parameter to the `RepositoryFactoryConfig` interface. it allows custom websocket url to be used to create the `Listener` object. By default (not provided), the factory will use rest-gateway url with '/ws' suffix appended (e.g. [http://localhost:3000/ws](http://localhost:3000/ws)
1965
- **[BREAKING CHANGE]** `Listener.newBlock` channel is now returning new object `NewBlock` rather than sharing with `BlockInfo` used by rest-gateway payload.
2066
- Added `stateHashSubCacheMerkleRoots` to `BlockInfo`.
2167

@@ -24,9 +70,9 @@ Client Library | v0.8.11 | https://www.npmjs.com/package/symbol-openapi-typescr
2470
**Milestone**: Gorilla.1(0.9.5.1)
2571
Package | Version | Link
2672
---|---|---
27-
SDK Core| v0.19.1 | https://www.npmjs.com/package/symbol-sdk
28-
Catbuffer | v0.0.19 | https://www.npmjs.com/package/catbuffer-typescript
29-
Client Library | v0.8.11 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
73+
SDK Core| v0.19.1 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
74+
Catbuffer | v0.0.19 | [catbuffer-typescript](]-typescript)
75+
Client Library | v0.8.11 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
3076

3177
- **[BREAKING CHANGE]** `RemotePublicKey` has been renamed to `LinkedPublicKey` in `AccountKeyLinkTransaction`.
3278
- **[BREAKING CHANGE]** `AccountRestrictionFlags` has been split into 3 separate flags: `AddressRestrictionFlag`, `MosaicRestrictionFlag` and `OperationRestrictionFlag` for better compile time and runtime validation.
@@ -40,9 +86,9 @@ Client Library | v0.8.11 | https://www.npmjs.com/package/symbol-openapi-typescr
4086
**Milestone**: Gorilla.1(0.9.5.1)
4187
Package | Version | Link
4288
---|---|---
43-
SDK Core| v0.19.0 | https://www.npmjs.com/package/symbol-sdk
44-
Catbuffer | v0.0.18 | https://www.npmjs.com/package/catbuffer-typescript
45-
Client Library | v0.8.10 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
89+
SDK Core| v0.19.0 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
90+
Catbuffer | v0.0.18 | [catbuffer-typescript](]-typescript)
91+
Client Library | v0.8.10 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
4692

4793
- **[BREAKING CHANGE]** `Transaction signing` is now using `GenerationHashSeed` from `NodeInfo` or `NetworkProperties`. GenerationHash on Nemesis block (block:1) is `NOT` used for signing purposes.
4894
- **[BREAKING CHANGE]** Renamed `AccountLinkTransaction` to `AccountKeyLinkTransaction`.
@@ -63,9 +109,9 @@ Client Library | v0.8.10 | https://www.npmjs.com/package/symbol-openapi-typescr
63109
**Milestone**: Fushicho.4(RC3 0.9.3.2)
64110
Package | Version | Link
65111
---|---|---
66-
SDK Core| v0.18.0 | https://www.npmjs.com/package/symbol-sdk
67-
Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
68-
Client Library | v0.8.9 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
112+
SDK Core| v0.18.0 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
113+
Catbuffer | v0.0.11 | [catbuffer-typescript](]-typescript)
114+
Client Library | v0.8.9 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
69115

70116
- **[BREAKING CHANGE]** Stopped NodeJS v8 and v9 support. From this version (`v0.18.0`) onwards, Symbol-SDK will target on Node v10+.
71117
- **[BREAKING CHANGE]** Removed `Keccac_256` from `LockHashAlgorithm` (enum index changed).
@@ -86,9 +132,9 @@ Client Library | v0.8.9 | https://www.npmjs.com/package/symbol-openapi-typescri
86132
**Milestone**: Fushicho.4(RC3 0.9.3.2)
87133
Package | Version | Link
88134
---|---|---
89-
SDK Core| v0.17.4 | https://www.npmjs.com/package/symbol-sdk
90-
Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
91-
Client Library | v0.8.9 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
135+
SDK Core| v0.17.4 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
136+
Catbuffer | v0.0.11 | [catbuffer-typescript](]-typescript)
137+
Client Library | v0.8.9 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
92138

93139
- Added `SimpleWallet.toDTO()` method which returns JSON serialized object.
94140
- Applied latest Symbol OpenAPI generated code (`v0.8.9`).
@@ -104,9 +150,9 @@ Client Library | v0.8.9 | https://www.npmjs.com/package/symbol-openapi-typescri
104150
**Milestone**: Fushicho.4(RC3 0.9.3.1)
105151
Package | Version | Link
106152
---|---|---
107-
SDK Core| v0.17.3 | https://www.npmjs.com/package/symbol-sdk
108-
Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
109-
Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
153+
SDK Core| v0.17.3 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
154+
Catbuffer | v0.0.11 | [catbuffer-typescript](]-typescript)
155+
Client Library | v0.8.5 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
110156

111157
- Fixed `MosaicNonce` issue handling signed integer from rest payload.
112158
- **[BREAKING CHANGE]** Updated `NodeTime` model to use `UInt64`.
@@ -116,9 +162,9 @@ Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescri
116162
**Milestone**: Fushicho.4(RC3 0.9.3.1)
117163
Package | Version | Link
118164
---|---|---
119-
SDK Core| v0.17.2 | https://www.npmjs.com/package/symbol-sdk
120-
Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
121-
Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
165+
SDK Core| v0.17.2 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
166+
Catbuffer | v0.0.11 | [catbuffer-typescript](]-typescript)
167+
Client Library | v0.8.5 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
122168

123169
- **[BREAKING CHANGE]** Added `s-part` of transaction signature to transaction hash.
124170
- Added `numStatements` to `blockInfo` model.
@@ -131,9 +177,9 @@ Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescri
131177
**Milestone**: Fushicho.4(RC3 0.9.3.1)
132178
Package | Version | Link
133179
---|---|---
134-
SDK Core| v0.17.1 | https://www.npmjs.com/package/symbol-sdk
135-
Catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer-typescript
136-
Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescript-node-client
180+
SDK Core| v0.17.1 | [symbol-sdk](https://www.npmjs.com/package/symbol-sdk)
181+
Catbuffer | v0.0.11 | [catbuffer-typescript](]-typescript)
182+
Client Library | v0.8.5 | [symbol-openapi-typescript-node-client](https://www.npmjs.com/package/symbol-openapi-typescript-node-client)
137183

138184
- Rebranded `nem2-sdk` to `symbol-sdk`. Please be noted the package name changes.
139185
- **[BREAKING CHANGE]** Changed `QueryParameters` and `TransactionFilter` to use deconstructed argument (JSON object) in the constructor.
@@ -145,9 +191,9 @@ Client Library | v0.8.5 | https://www.npmjs.com/package/symbol-openapi-typescri
145191
**Milestone**: Fushicho.4(RC3 0.9.3.1)
146192
Package | Version | Link
147193
---|---|---
148-
SDK Core | v0.17.0 | https://www.npmjs.com/package/nem2-sdk
149-
catbuffer | v0.0.11 | https://www.npmjs.com/package/catbuffer
150-
Client Library | v0.8.4 | https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client
194+
SDK Core | v0.17.0 | [nem2-sdk](https://www.npmjs.com/package/nem2-sdk)
195+
catbuffer | v0.0.11 | [catbuffer](https://www.npmjs.com/package/catbuffer)
196+
Client Library | v0.8.4 | [nem2-sdk-openapi-typescript-node-client](https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client)
151197

152198
- **[BREAKING CHANGE]** Changed hashing algorithm to cope catapult-server changes. All Key derivation and signing are now using `SHA512`. Removed `SignSchema` so `NetworkType` is no longer bonded to the schema anymore (sha3 / keccak). This change will affect all existing keypairs / address (derived from public key) and transaction signatures.
153199
- **[BREAKING CHANGE]** Added new `TransactionFilter` parameter to `AccountHttp` which is now support filtering with list of transaction type.
@@ -165,9 +211,9 @@ Client Library | v0.8.4 | https://www.npmjs.com/package/nem2-sdk-openapi-typesc
165211
**Milestone**: Fushicho.4(RC3)
166212
Package | Version | Link
167213
---|---|---
168-
SDK Core| v0.16.5 | https://www.npmjs.com/package/nem2-sdk
169-
catbuffer Library| v0.0.11 | https://www.npmjs.com/package/catbuffer
170-
Client Library | v0.7.20-beta.7 | https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client
214+
SDK Core| v0.16.5 | [nem2-sdk](https://www.npmjs.com/package/nem2-sdk)
215+
catbuffer Library| v0.0.11 | [catbuffer](https://www.npmjs.com/package/catbuffer)
216+
Client Library | v0.7.20-beta.7 | [nem2-sdk-openapi-typescript-node-client](https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client)
171217

172218
- Fixed circular reference issue after removed `InnerTransaction` class.
173219

@@ -176,9 +222,9 @@ Client Library | v0.7.20-beta.7 | https://www.npmjs.com/package/nem2-sdk-openap
176222
**Milestone**: Fushicho.4(RC3)
177223
Package | Version | Link
178224
---|---|---
179-
SDK Core| v0.16.4 | https://www.npmjs.com/package/nem2-sdk
180-
catbuffer Library| v0.0.11 | https://www.npmjs.com/package/catbuffer
181-
Client Library | v0.7.20-beta.7 | https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client
225+
SDK Core| v0.16.4 | [nem2-sdk](https://www.npmjs.com/package/nem2-sdk)
226+
catbuffer Library| v0.0.11 | [catbuffer](https://www.npmjs.com/package/catbuffer)
227+
Client Library | v0.7.20-beta.7 | [nem2-sdk-openapi-typescript-node-client](https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client)
182228

183229
- Core 0.9.2.1 compatible. Changed hash algorithm for shared key derivation to `HKDF-HMAC-Sha256`.
184230
- Removed `senderPrivateKey` in `Persistent Delegation Request Transaction`. Instead, it uses an `ephemeral key pair` and the `EphemeralPublicKey` is now attached in the `PersistentDelegationMessage` payload.
@@ -194,9 +240,9 @@ Client Library | v0.7.20-beta.7 | https://www.npmjs.com/package/nem2-sdk-openap
194240
**Milestone**: Fushicho.3
195241
Package | Version | Link
196242
---|---|---
197-
SDK Core| v0.16.3 | https://www.npmjs.com/package/nem2-sdk
198-
catbuffer Library| v0.0.7 | https://www.npmjs.com/package/catbuffer
199-
Client Library | v0.7.20-beta.6 | https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client
243+
SDK Core| v0.16.3 | [nem2-sdk](https://www.npmjs.com/package/nem2-sdk)
244+
catbuffer Library| v0.0.7 | [catbuffer](https://www.npmjs.com/package/catbuffer)
245+
Client Library | v0.7.20-beta.6 | [nem2-sdk-openapi-typescript-node-client](https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client)
200246

201247
- Fixed http client (OpenAPI client package) does not support ES6 issue.
202248

@@ -205,9 +251,9 @@ Client Library | v0.7.20-beta.6 | https://www.npmjs.com/package/nem2-sdk-openap
205251
**Milestone**: Fushicho.3
206252
Package | Version | Link
207253
---|---|---
208-
SDK Core| v0.16.2 | https://www.npmjs.com/package/nem2-sdk
209-
catbuffer Library| v0.0.7 | https://www.npmjs.com/package/catbuffer
210-
Client Library | v0.7.20-alpha.6 | https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client
254+
SDK Core| v0.16.2 | [nem2-sdk](https://www.npmjs.com/package/nem2-sdk)
255+
catbuffer Library| v0.0.7 | [catbuffer](https://www.npmjs.com/package/catbuffer)
256+
Client Library | v0.7.20-alpha.6 | [nem2-sdk-openapi-typescript-node-client](https://www.npmjs.com/package/nem2-sdk-openapi-typescript-node-client)
211257

212258
- Refactored to replace generated codes by public library package for both `catbuffer` and `OpenAPI Http Client`.
213259
- Added unresolved (mosaicId, address) support in `MosaicRestrictionTransaction`.
@@ -515,6 +561,7 @@ Client Library | v0.7.20-alpha.6 | https://www.npmjs.com/package/nem2-sdk-opena
515561

516562
- Initial code release.
517563

564+
[0.20.0]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.19.2...v0.20.0
518565
[0.19.2]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.19.1...v0.19.2
519566
[0.19.1]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.19.0...v0.19.1
520567
[0.19.0]: https://github.com/nemtech/symbol-sdk-typescript-javascript/compare/v0.18.0...v0.19.0

‎README.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ The Symbol SDK for TypeScript / JavaScript allows you to develop web, mobile, an
99

1010
## Important Notes
1111

12-
### _Gorilla.1_ Network Compatibility (catapult-server@0.9.5.1)
12+
### _Gorilla.1_ Network Compatibility (catapult-server@0.9.6.1)
1313

14-
Due to a network upgrade with [catapult-server@Gorilla.1](https://github.com/nemtech/catapult-server/releases/tag/v0.9.5.1) version, **it is recommended to use this package's 0.19.2 version and upwards to use this package with Fushicho versioned networks**.
14+
Due to a network upgrade with [catapult-server@Gorilla.1](https://github.com/nemtech/catapult-server/releases/tag/v0.9.6.1) version, **it is recommended to use this package's 0.20.0 version and upwards to use this package with Fushicho versioned networks**.
1515

16-
The upgrade to this package's [version v0.19.2](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.19.2) is mandatory for **_Gorilla compatibility**.
16+
The upgrade to this package's [version v0.20.0](https://github.com/nemtech/symbol-sdk-typescript-javascript/releases/tag/v0.20.0) is mandatory for **_Gorilla compatibility**.
1717

1818
Find the complete release notes [here](CHANGELOG.md).
1919

0 commit comments

Comments
 (0)