https://github.com/symbol/symbol-sdk-typescript-javascript

This SDK has been deprecated as of January 2022.
https://github.com/symbol/symbol-sdk-typescript-javascript

javascript sdk symbol typescript

Last synced: 6 months ago
JSON representation

This SDK has been deprecated as of January 2022.

• Host: GitHub
• URL: https://github.com/symbol/symbol-sdk-typescript-javascript
• Owner: symbol
• License: apache-2.0
• Created: 2018-03-25T15:36:53.000Z (about 7 years ago)
• Default Branch: dev
• Last Pushed: 2024-03-15T13:51:10.000Z (about 1 year ago)
• Last Synced: 2024-05-11T20:03:28.962Z (about 1 year ago)
• Topics: javascript, sdk, symbol, typescript
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/symbol-sdk
• Size: 85.5 MB
• Stars: 102
• Watchers: 38
• Forks: 62
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
:warning: **This SDK has been deprecated as of January 2022.** The new NEM & Symbol JavaScript SDK can be found [here](https://github.com/symbol/symbol/tree/dev/sdk/javascript). 

# Symbol SDK for TypeScript and JavaScript

[![npm version](https://badge.fury.io/js/symbol-sdk.svg)](https://badge.fury.io/js/symbol-sdk)

[![Build Status](https://api.travis-ci.com/nemtech/symbol-sdk-typescript-javascript.svg?branch=main)](https://travis-ci.com/nemtech/symbol-sdk-typescript-javascript)

[![Coverage Status](https://coveralls.io/repos/github/nemtech/symbol-sdk-typescript-javascript/badge.svg)](https://coveralls.io/github/nemtech/symbol-sdk-typescript-javascript?branch=travis-ci)

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

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

## Important Notes

### _Catapult-Server_ Network Compatibility ([email protected])

Symbol network launched [catapult-client](https://github.com/symbol/symbol/releases), **it is recommended to use this package's 2.0.3 version and upwards for the Symbol public network**.

Find the complete release notes [here](CHANGELOG.md).

## Requirements

### NodeJS

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

## Installation

```bash

npm install symbol-sdk rxjs

```

## Usage

Surf the [documentation][docs] 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][sdk-ref].

## Getting help

Use the following available resources to get help:

- [Symbol Documentation][docs]

- [Symbol SDK Typescript/Javascript Reference][sdk-ref]

- Join the community [Discord server][discord]

- If you found a bug, [open a new issue][issues]

## Contributing

Contributions are welcome and appreciated.

Check [CONTRIBUTING](CONTRIBUTING.md) for information on how to contribute.

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

## License

Copyright (c) 2018-present NEM

Licensed under the [Apache License 2.0](LICENSE)

[self]: https://github.com/symbol/symbol-sdk-typescript-javascript

[docs]: https://docs.symbol.dev/getting-started/setup-workstation.html

[issues]: https://github.com/symbol/symbol-sdk-typescript-javascript/issues

[sdk-ref]: https://docs.symbol.dev/references/typescript-sdk.html

[guidelines]: https://docs.symbol.dev/contribute/contributing.html#sdk

[discord]: https://discord.com/invite/xymcity