v0.20.5

[0.20.5] - 30-Jun-2020

Milestone: Gorilla.1(0.9.6.2)

Package	Version	Link
SDK Core	v0.20.5	symbol-sdk
Catbuffer	v0.0.21	catbuffer-typescript
Client Library	v0.9.4	symbol-openapi-typescript-fetch-client

• Added maxVotingKeysPerAccount, minVotingKeyLifetime and maxVotingKeyLifetime in ChainProperties.
• Updated fetch client version to 0.9.4.

v0.20.4

[0.20.4] - 29-Jun-2020

Milestone: Gorilla.1(0.9.6.2)

Package	Version	Link
SDK Core	v0.20.4	symbol-sdk
Catbuffer	v0.0.21	catbuffer-typescript
Client Library	v0.9.3-1	symbol-openapi-typescript-fetch-client

• Fixed symbol-openapi-typescript-fetch-client Typescript 3+ compatibility issue.
• Fixed window.fetch default value issue in RepositoryFactory.

v0.20.3

[0.20.3] - 26-Jun-2020

Milestone: Gorilla.1(0.9.6.2)

Package	Version	Link
SDK Core	v0.20.3	symbol-sdk
Catbuffer	v0.0.21	catbuffer-typescript
Client Library	v0.9.3	symbol-openapi-typescript-fetch-client

• [BREAKING CHANGE] Added startPoint and endPoint in VotingKeyLinkTransaction.
• [BREAKING CHANGE] Renamed SupplementalAccountKeys to SupplementalPublicKeys. The new SupplementalPublicKeys has been changed from array type to an object containing: linked, node, vrf and voting key(s).
• [BREAKING CHANGE] Changed to use the SDK's own enums for order, orderBy, blockOrderBy and meklePosition.
• [BREAKING CHANGE] Added TransactionGroup parameter in getTransactionsById which can query unconfirmed and partial transactions now.
• Changed base client library from symbol-openapi-typescript-node-client to symbol-openapi-typescript-fetch-client for better client / brower usability. There is no need to browserify the packages or special webpack processing
• Made Fetch API injectable via RepositoryFactory which works like the injected websocket in Listener.

v0.20.2

[0.20.2] - 18-Jun-2020

Milestone: Gorilla.1(0.9.6.1)

Package	Version	Link
SDK Core	v0.20.2	symbol-sdk
Catbuffer	v0.0.20	catbuffer-typescript
Client Library	v0.9.2	symbol-openapi-typescript-node-client

• Fixed missing TransactionGroup export issue.
• Added contributors..
• Fixed issues in travis scripts.

v0.20.0

[0.20.0] - 18-Jun-2020

Milestone: Gorilla.1(0.9.6.1)

Package	Version	Link
SDK Core	v0.20.0	symbol-sdk
Catbuffer	v0.0.20	catbuffer-typescript
Client Library	v0.9.2	symbol-openapi-typescript-node-client

• [BREAKING CHANGE] Model property name changes:

  1. MetadataEntry: senderPublicKey: string => sourceAddress: Address; targetPublicKey: string => targetAddress: Address
  2. MultisigAccountGraphInfo: multisigAccounts => multisigEntries
  3. MultisigAccountInfo: account: PublicAccount => accountAddress: Address; cosignatories: PublicAccount[] => cosignatoryAddresses: Address; multisigAccounts: PublicAccount[] => multisigAddresses: Address[]
  4. BlockInfo / NewBlock: beneficiaryPublicKey: PublicAccount | undefined => beneficiaryAddress: Address | undefined
  5. MosaicId: owner: PublicAccount => ownerAddress: Address
  6. MosaicInfo: owner: PublicAccount => ownerAddress: Address; height => startHeight.
  7. NamespaceInfo: owner: PublicAccount => ownerAddress: Address
  8. ChainProperties: harvestNetworkFeeSinkPublicKey => harvestNetworkFeeSinkAddress
  9. MosaicNetworkProperties: mosaicRentalFeeSinkPublicKey => mosaicRentalFeeSinkAddress
  10. NamespaceNetworkProperties: namespaceRentalFeeSinkPublicKey => namespaceRentalFeeSinkAddress
  11. NetworkProperties: publicKey => nemesisSignerPublicKey
  12. BalanceChangeReceipt: targetPublicAccount: PublicAccount => targetAddress: Address
  13. BalanceTransferReceipt: sender: PublicAccount => senderAddress: Address

• [BREAKING CHANGE] Transaction property name changes:

  1. AccountMetadataTransaction: targetPublicKey: string => targetAddress: UnresolvedAddress
  2. MosaicMetadataTransaction: targetPublicKey: string => targetAddress: UnresolvedAddress
  3. NamespaceMetadataTransaction: targetPublicKey: string => targetAddress: UnresolvedAddress
  4. MultisigAccountModificationTransaction: publicKeyAdditions: PublicAccount[] => addressAdditions: UnresolvedAddress[]; publicKeyDeletions: PublicAccount[] => addressDeletions: UnresolvedAddress[]
  5. AggregateTransactionService: cosignatories: string[] => cosignatories: Address[]

• [BREAKING CHANGE] Address format changed from 25 bytes to 24 bytes. See new address test vector here.

• [BREAKING CHANGE] MosaicId creation (from Nonce) changed from using PublicKey to Address. See new mosaicId test vector here.

• [BREAKING CHANGE] Added 8 bytes (uint64) version field in CosignatureSignedTransaction and AggregateTransactionCosignature with default value 0.

• [BREAKING CHANGE] Removed all transaction get endpoints from AccountHttp and BlockHttp.

• [BREAKING CHANGE] Added TransactionGroup (required) parameter in getTransaction endpoint in TransactionHttp.

• Added Search endpoints to TransactionHttp, BlockHttp, and MosaicHttp.

  Note:

  1. Search endpoints returns pagination payload (Page<t>) rather than raw arraes.
  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.

• Added SearchCriteria interfaces for the new search endpoints.

• group filter in TransactionSearchCriteria to be mandatory due to rest endpoint changes.

• Added streamer for the 3 new search endpoints (block, mosaic, transaction) to improve pagination querying.

v0.19.2

[0.19.2] - 26-May-2020

Milestone: Gorilla.1(0.9.5.1)

Package	Version	Link
SDK Core	v0.19.2	https://www.npmjs.com/package/symbol-sdk
Catbuffer	v0.0.19	https://www.npmjs.com/package/catbuffer-typescript
Client Library	v0.8.11	https://www.npmjs.com/package/symbol-openapi-typescript-node-client

• [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).
• [BREAKING CHANGE] RepositoryFactory: Optional constructor parameters has been moved into RepositoryFactoryConfig interface (optional).
• [BREAKING CHANGE] Added websocketInjected (optional) parameter to the RepositoryFactoryConfig interface. RepositoryFactory.createListener() can now take injected websocket instance to create Listener object.
• [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)
• [BREAKING CHANGE] Listener.newBlock channel is now returning new object NewBlock rather than sharing with BlockInfo used by rest-gateway payload.
• Added stateHashSubCacheMerkleRoots to BlockInfo.

v0.19.1

[0.19.1] - 21-May-2020

Milestone: Gorilla.1(0.9.5.1)

Package	Version	Link
SDK Core	v0.19.1	https://www.npmjs.com/package/symbol-sdk
Catbuffer	v0.0.19	https://www.npmjs.com/package/catbuffer-typescript
Client Library	v0.8.11	https://www.npmjs.com/package/symbol-openapi-typescript-node-client

• [BREAKING CHANGE] RemotePublicKey has been renamed to LinkedPublicKey in AccountKeyLinkTransaction.
• [BREAKING CHANGE] AccountRestrictionFlags has been split into 3 separate flags: AddressRestrictionFlag, MosaicRestrictionFlag and OperationRestrictionFlag for better compile time and runtime validation.
• [BREAKING CHANGE] Added NamaspaceRepository interface to Listener constructor parameters for resolving alias purpose. Listener object can still be instantiated by using RepositoryFactory.createListener() with no coding change.
• Added signer and signature as optional parameters to the create methods in transaction classes. TransactionMapping.createFromPayload is now including signer and signature.
• Refactored address filter in websocket listener channels which now filters on recipientAddress, targetAccount, signerPublicKey fields in all transaction types. The Listener can filter on unresolved (alias) addresses now.
• Added optional transactionHash parameter in websocket listener channel subscribers which can be used for specific transaction monitoring now.

v0.19.0 Release (Gorilla.1)

[0.19.0] - 15-May-2020

Milestone: Gorilla.1(0.9.5.1)

Package	Version	Link
SDK Core	v0.19.0	https://www.npmjs.com/package/symbol-sdk
Catbuffer	v0.0.18	https://www.npmjs.com/package/catbuffer-typescript
Client Library	v0.8.10	https://www.npmjs.com/package/symbol-openapi-typescript-node-client

• [BREAKING CHANGE] Transaction signing is now using GenerationHashSeed from NodeInfo or NetworkProperties. GenerationHash on Nemesis block (block:1) is NOT used for signing purposes.
• [BREAKING CHANGE] Renamed AccountLinkTransaction to AccountKeyLinkTransaction.
• [BREAKING CHANGE] Renamed networkGenerationHash to networkGenerationHashSeed in NodeInfo.
• [BREAKING CHANGE] replaced linkedPublickKey with supplementalAccountKeys array in AccountInfo.
• Added new transaction VrfKeyLinkTransaction.
• Added new transaction VotingKeyLinkTransaction.
• Added new transaction NodeKeyLinkTransaction.
• Added new properties proofGamma, proofScalar, proofVarificationHash in BlockInfo
• Added new properties harvestNetworkPercentage, harvestNetworkFeeSinkPublicKey in NetworkProperties.
• Added new KeyType: Unset / Linked / VRF / Voting / Node / All.
• Added package shx for cross-platform building purpose.
• Fixed AggregateTransaction.getMaxCosignatures() to return distinct cosignature set.
• Fixed a few documentaion issues.

v0.18.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.

v0.17.4

[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.