@hashgraph/sdk

Hiero JavaScript SDK

The JavaScript SDK for interacting with a Hiero based network

[!NOTE]
The project has been transfered from the https://github.com/hashgraph org and therefore the namespace is at several locations still based on hashgraph and hedera. We are working activly on migration the namespace fully to hiero.

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.

# with NPM
$ npm install --save @hiero-ledger/sdk

# with Yarn
$ yarn add @hiero-ledger/sdk

# with PNPM
$ pnpm add @hiero-ledger/sdk

Browser Usage

The SDK is also available as a UMD (Universal Module Definition) build, which can be loaded directly in the browser from popular CDNs:

UNPKG

<script src="https://unpkg.com/@hiero-ledger/sdk@2.70.0/dist/umd.js"></script>

When using the UMD build in the browser, the SDK will be available as a global variable sdk. A minified version is also available at dist/umd.min.js.

Build

Prerequisites

• Taskfile tool installation
• Node.js: It is recommended to use Node.js v20 or higher for best performance and compatibility. The package may also work with Node.js v16, but this version has not been officially tested.

# with npm
$ npm install -g @go-task/cli

# with homebrew
$ brew install go-task

• pNpm package manager installation

# with npm
$ npm install -g pnpm

# with homebrew
$ brew install pnpm

After downloading the repo run:

• task install

• task build to build the SDK

React Native Support

The Hiero JavaScript SDK provides comprehensive support for React Native environments, including Expo. To ensure seamless integration, follow the guidelines based on your Expo version:

✅ Hiero Javascript SDK Version 2.60 and Above For projects using SDK version 2.60 and above, Expo SDK version 51+ is supported, the SDK requires the react-native-get-random-values package in order to work. To install it, run:

npm install react-native-get-random-values

After installation, the native dependency must be linked for the respective platforms:

🔗 Linking for Native Platforms

• iOS: Run the following command to install the native modules:

cd ios && pod install

Then, rebuild the iOS project.

• Android: Rebuild the Android project to link the dependency

⚠️ ✅ Hiero Javascript SDK Version 2.59 and Below For projects using SDK version 2.59 and below, Expo SDK Version 49 and below is supported, 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 package has to be installed and imported before importing the SDK in your project.

• Useful information: here and here

npm install @ethersproject/shims

Import it before importing the SDK as shown below:

import '@ethersproject/shims';

import {
    Client,
    PrivateKey
    AccountBalance,
} from "@hiero-ledger/sdk";
...

The Hiero JavaScript SDK does not currently support the following:

• React Native Bare

Usage

See examples.

Every example can be executed using the following command from the root directory: node examples/[name-of-example].js.

Note: Before running any examples, ensure you have:

• Built the SDK by running task build in the root directory.
• Installed dependencies by running pnpm install in the examples directory

Configuration

For detailed information on configuring the SDK, including environment variables and client settings, please refer to the CONFIGURATION.md file.

Start tests

• To start the integration tests follow the next steps:
  • Run the local node
  • Rename sample.env in the root directory to .env
    • Ensure the OPERATOR_ID and OPERATOR_KEY are fields populated from accounts created by the local node
    • Update the network to HEDERA_NETWORK="local-node"
  • Run task test:integration:node
  • Stop the local node
• To start unit tests follow the next steps:
  • Run task test:unit

Contributing

Whether you’re fixing bugs, enhancing features, or improving documentation, your contributions are important — let’s build something great together! Please read our contributing guide to see how you can get involved.

Code of Conduct

Hiero uses the Linux Foundation Decentralised Trust Code of Conduct.

License

Apache License 2.0