Symbol SDK for TypeScript and JavaScript

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

Important Notes

Catapult-Server Network Compatibility (catapult-server@0.10.0.8)

Symbol network pre-launch catapult-server, it is recommended to use this package's 0.23.3 version and upwards for the upcoming pre-release versions and final release.

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

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.