Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hashgraph/hedera-sdk-js
Hedera™ Hashgraph SDK for JavaScript/TypeScript
https://github.com/hashgraph/hedera-sdk-js
distributed-ledger-technology hacktoberfest hashgraph hedera hedera-sdk javascript javascript-sdk sdk typescript typescript-sdk
Last synced: about 2 months ago
JSON representation
Hedera™ Hashgraph SDK for JavaScript/TypeScript
- Host: GitHub
- URL: https://github.com/hashgraph/hedera-sdk-js
- Owner: hashgraph
- License: apache-2.0
- Created: 2019-07-25T21:30:47.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T08:13:52.000Z (3 months ago)
- Last Synced: 2024-10-29T09:30:58.489Z (3 months ago)
- Topics: distributed-ledger-technology, hacktoberfest, hashgraph, hedera, hedera-sdk, javascript, javascript-sdk, sdk, typescript, typescript-sdk
- Language: JavaScript
- Homepage: https://docs.hedera.com/guides/docs/sdks
- Size: 33.6 MB
- Stars: 268
- Watchers: 20
- Forks: 144
- Open Issues: 124
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- best-of-crypto - GitHub - 11% open · ⏱️ 03.06.2024): (Smart Contract Platforms)
README
# Hedera™ Hashgraph JavaScript SDK
[](https://discord.com/channels/373889138199494658/616725732650909710)
[](https://docs.hedera.com/guides/getting-started/javascript/environment-set-up)
[](https://www.npmjs.org/package/@hashgraph/sdk)
> The JavaScript SDK for interacting with Hedera Hashgraph: the official distributed
> consensus platform built using the hashgraph consensus algorithm for fast,
> fair and secure transactions. Hedera enables and empowers developers to
> build an entirely new class of decentralized applications.
## Install
**NOTE**: v1 of the SDK is deprecated and support will be discontinued after October 2021. Please install the latest version 2.x or migrate from v1 to the latest 2.x version. You can reference the [migration documentation](/MIGRATING_V1.md).
```
# with NPM
$ npm install --save @hashgraph/sdk
# with Yarn
$ yarn add @hashgraph/sdk
# with PNPM
$ pnpm add @hashgraph/sdk
```
## Build
After downloading the repo run `task build` to build the SDK.
## React Native Support
The Hedera JavaScript SDK supports the following:
* React Native with Expo - keep in mind that the SDK uses some functionalities provided from ethers/ethersproject and there is an issue using parts of ethers.js in this environment. A [shims](https://www.npmjs.com/package/@ethersproject/shims) package has to be installed and imported before importing the SDK in your project as it is showed [here](./examples/react-native-example/App.tsx)
* Useful information: [here](https://github.com/ethers-io/ethers.js/discussions/3652) and [here](https://docs.ethers.org/v5/cookbook/react-native/)
The Hedera JavaScript SDK does not currently support the following:
* React Native Bare
## Usage
See [examples](./examples).
Every example can be executed using the following command from the root directory: `node examples/[name-of-example].js`
## Start tests
* To start the integration tests follow the next steps:
- Run the [local node](https://github.com/hashgraph/hedera-local-node)
- Run `task test:intergration:node`
- Stop the [local node](https://github.com/hashgraph/hedera-local-node)
* To start unit tests follow the next steps:
- Run `task test:unit` (Note: the local node should not be running)
## Contributing to this Project
We welcome participation from all developers!
For instructions on how to contribute to this repo, please
review the [Contributing Guide](CONTRIBUTING.md).
## License Information
Licensed under Apache License,
Version 2.0 – see [LICENSE](LICENSE) in this repo
or [apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0).