Skip to content

v0.12.1: updated README with better Protocol Version instructions #163

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2019
Merged

v0.12.1: updated README with better Protocol Version instructions #163

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9dfb8c
v0.12.1: fixed some more Dragon DTO field names
evias Jun 5, 2019
3ef6494
updated readme with latest v0.12.1
evias Jun 5, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,11 @@ 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.12.1] - 04-Jun-2019
## [0.12.1] - 05-Jun-2019

- Fixed alias and modification type field names in Http

## [0.12.0] - 04-Jun-2019

- Added 'Receipt'
- Added 'generationHash' to transaction.sign(...) to prevent transactions from being replayed on different networks by prepending the network generation hash to transaction data prior to signing and verifying.
Expand Down
21 changes: 14 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,17 +10,22 @@ with the NEM2 (a.k.a Catapult)

## Important Notes

### Dragon Network Compatibility (catapult-server@0.4.0.1)

Due to a network upgrade with [catapult-server@dragon](https://github.com/nemtech/catapult-server/releases/tag/v0.4.0.1) version, **it is recommended to use this package's 0.10.0 version and upwards in order to use this package with Dragon versioned networks**.
### _Dragon_ Network Compatibility (catapult-server@0.4.0.1)

The upgrade to this SDK's [version v0.12.1](https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.12.1) is mandatory for **dragon compatibility**.
Due to a network upgrade with [catapult-server@dragon](https://github.com/nemtech/catapult-server/releases/tag/v0.4.0.1) version, **it is recommended to use this package's 0.12.1 version and upwards in order to use this package with Dragon versioned networks**.

The upgrade to this package's [version v0.12.1](https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.12.1) is mandatory for **dragon compatibility**.

### _Cow_ Network Compatibility (catapult-server@0.3.0.2)

[version v0.11.6](https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.11.6) is the latest locked version for **cow compatibility**.

Due to a network upgrade with [catapult-server@cow](https://github.com/nemtech/catapult-server/releases/tag/v0.3.0.2) version, **transactions from Alpaca&Bison are not compatible anymore**.
Due to a network upgrade with [catapult-server@cow](https://github.com/nemtech/catapult-server/releases/tag/v0.3.0.2) version, **transactions from Alpaca & Bison are not compatible with cow versioned networks**.

### _Alpaca_ / _Bison_ Network Compatibility (catapult-server@0.1 & 0.2)

Other versions like [version v0.10.1-beta](https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.10.1-beta) can be used for **bison** network version.
In order to be able to use this package with _Alpaca_ or _Bison_ versioned network, you must use [version v0.10.1-beta](https://github.com/nemtech/nem2-sdk-typescript-javascript/releases/tag/v0.10.1-beta).

## Requirements

Expand All @@ -32,7 +37,9 @@ Other versions like [version v0.10.1-beta](https://github.com/nemtech/nem2-sdk-t

## Installation

```npm install nem2-sdk rxjs```
```bash
npm install nem2-sdk rxjs
```

## Documentation and Getting Started

Expand Down Expand Up @@ -61,7 +68,7 @@ Please, use the following available resources to get help:

Important versions listed below. Refer to the [Changelog](CHANGELOG.md) for a full history of the project.

- [0.12.1](CHANGELOG.md#0121-04-Jun-2019) - **Dragon compatible** - 04.06.2019
- [0.12.1](CHANGELOG.md#0121-05-Jun-2019) - **Dragon compatible** - 05.06.2019
- [0.11.6](CHANGELOG.md#0116-03-Jun-2019) - **Cow compatible** - 03.06.2019
- [0.11.5](CHANGELOG.md#0115-18-Apr-2019) - **Cow compatible** - 18.04.2019
- [0.11.4](CHANGELOG.md#0114-17-Apr-2019) - **Cow compatible** - 17.04.2019
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nem2-sdk",
"version": "0.12.0",
"version": "0.12.1",
"description": "Reactive Nem2 sdk for typescript and javascript",
"scripts": {
"pretest": "npm run build",
Expand Down