Symbol SDK for TypeScript and JavaScript

The Symbol SDK for TypeScript / JavaScript allows you to develop web, mobile, and Node.js applications.

Important Notes

Gorilla.1 Network Compatibility (catapult-server@0.9.6.1)

Due to a network upgrade with catapult-server@Gorilla.1 version, it is recommended to use this package's 0.20.0 version and upwards to use this package with Fushicho versioned networks.

The upgrade to this package's version v0.20.0 is mandatory for _Gorilla compatibility.

Find the complete release notes here.

Requirements

NodeJS

NodeJS 10.X.X and above (from v0.18.0)

Installation

npm install symbol-sdk rxjs

Usage

Surf the documentation to get started into Symbol 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:

Symbol Documentation
Symbol SDK Typescript/Javascript Reference
Join the community slack group (#sig-api)
If you found a bug, open a new issue

Contributing

This project is developed and maintained by NEM Foundation.

Contributions are welcome and appreciated. Check CONTRIBUTING for information on how to contribute.

You can also find useful notes for developers under our documentation guidelines section.