# nem2-library-js

[![npm version](https://badge.fury.io/js/nem2-library.svg)](https://badge.fury.io/js/nem2-library)
[![Build Status](https://api.travis-ci.org/nemtech/nem2-library-js.svg?branch=master)](https://travis-ci.org/nemtech/nem2-library-js)
[![Coverage Status](https://coveralls.io/repos/github/nemtech/nem2-library-js/badge.svg?branch=travis-ci)](https://coveralls.io/github/nemtech/nem2-library-js?branch=travis-ci)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

:warning:️ nem2-library-js is not meant to be used in NEM2 Tools/Applications. 
It is used by [nem2-sdk-typescript-javascript](https://github.com/nemtech/nem2-sdk-typescript-javascript).

:information_source: nem2-library-js is not related to nem-library of NIS1.

This project is developed and maintained by NEM Foundation. 

## 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**.

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

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

[version v0.9.19](https://github.com/nemtech/nem2-library-js/releases/tag/v0.9.19) 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**.

### Alpaca / Bison Network Compatibility (catapult-server@0.1 & 0.2)

In order to be able to use this package with _Alpaca_ or _Bison_ versioned network, you must use [version v0.9.5-2](https://github.com/nemtech/nem2-library-js/releases/tag/v0.9.5-2).

## Notes on generation of catapult-rest DTO and API client

Following command can be used to generate DTOs and Api clients for the [nem2-sdk-typescript-javascript](https://github.com/nemtech/nem2-sdk-typescript-javascript) :

```bash
$ git clone git@github.com:nemtech/nem2-docs
$ cd nem2-docs && mkdir sdks && cd sdks
$ cp ../source/resources/collections/swagger.yaml .
$ docker run --rm -v ${PWD}:/local swaggerapi/swagger-codegen-cli generate -i /local/swagger.yaml -l javascript -t /local/es6_promise --additional-properties usePromises=true -o /local/nem2-js-sdk && rm -R nem2-js-sdk/test
```

## Changelog

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

- [v0.10.1](CHANGELOG.md#v0101) - **Dragon Compatible** - 2019-06-04
- [v0.9.19](CHANGELOG.md#v0919) - **Cow Compatible** - 2019-06-03
- [v0.9.18](CHANGELOG.md#v0918) - **Cow Compatible** - 2019-05-16
- [v0.9.17](CHANGELOG.md#v0917) - **Cow Compatible** - 2019-05-16
- [v0.9.16](CHANGELOG.md#v0916) - **Cow Compatible** - 2019-05-06
- [v0.9.15](CHANGELOG.md#v0915) - **Cow Compatible** - 2019-05-01
- [v0.9.14](CHANGELOG.md#v0914) - **Cow Compatible** - 2019-04-10
- [v0.9.13](CHANGELOG.md#v0913) - **Cow Compatible** - 2019-03-24
- [v0.9.12](CHANGELOG.md#v0912) - **Cow Compatible** - 2019-03-10
- [v0.9.11](CHANGELOG.md#v0911) - **Cow Compatible** - 2019-03-07
- [v0.9.8](CHANGELOG.md#v098) - **Cow Compatible** - 2019-02-28
- [v0.9.7](CHANGELOG.md#v097) - **Cow Compatible** - 2019-02-25
- [v0.9.6](CHANGELOG.md#v096) - **Cow Compatible** - 2019-02-25
- [v0.9.5-2](CHANGELOG.md#v0952) - **Alpaca Compatible** -

## License

Copyright (c) 2018 NEM
Licensed under the [Apache License 2.0](LICENSE)