nem2-sdk
v0.17.0
Published
Reactive Nem2 sdk for typescript and javascript
Downloads
704
Keywords
Readme
nem2-sdk for TypeScript and JavaScript
The official nem2-sdk for TypeScript and JavaScript, available for browsers, mobile applications, and NodeJS, to work with the NEM2 (a.k.a Catapult)
Important Notes
Fushicho Network Compatibility ([email protected])
Due to a network upgrade with catapult-server@Fushicho version, it is recommended to use this package's 0.17.0 version and upwards to use this package with Fushicho versioned networks.
The upgrade to this package's version v0.17.0 is mandatory for fushicho compatibility.
Elephant Network Compatibility ([email protected])
Due to a network upgrade with catapult-server@elephant3 version, it is recommended to use this package's 0.13.4 version and upwards to use this package with Elephant versioned networks.
The upgrade to this package's version v0.13.3 is mandatory for elephant compatibility.
Dragon Network Compatibility ([email protected])
Due to a network upgrade with catapult-server@dragon version, it is recommended to use this package's 0.12.4 version and upwards to use this package with Dragon versioned networks.
The upgrade to this package's version v0.12.4 is mandatory for dragon compatibility.
Cow Network Compatibility ([email protected])
version v0.11.6 is the latest locked version for cow compatibility.
Due to a network upgrade with catapult-server@cow version, transactions from Alpaca & Bison are not compatible with cow versioned networks.
Alpaca / Bison Network Compatibility ([email protected] & 0.2)
To be able to use this package with Alpaca or Bison versioned network, you must use version v0.10.1-beta.
You can find the complete changelog here.
Requirements
NodeJS
- NodeJS 8.9.X
- NodeJS 9.X.X
- NodeJS 10.X.X
Installation
npm install nem2-sdk rxjs
Usage
Surf the NEM Developer Center to get started into NEM development. You will find self-paced guides and useful code snippets using the TypeScript/Javascript SDK.
To get the full description of the available classes and their functions, check the SDK reference.
Getting help
Use the following available resources to get help:
- nem2-sdk-typescript-javascript documentation
- If you found a bug, open a new issue
Contributing
This project is developed and maintained by NEM Foundation. Contributions are welcome and appreciated. You can find nem2-sdk on GitHub.
Feel free to start an issue or create a pull request. Check CONTRIBUTING before start.
You can also find useful notes for developers under our documentation guidelines section.
License
Copyright (c) 2018-2019 NEM Licensed under the Apache License 2.0