Practical overview
When it fits
Use the SDK when a JavaScript or TypeScript application needs to perform asset or smart-contract interactions on a Hedera or other Hiero network. The browser UMD build is an alternative to package-manager installation for browser use.
Who it is for
- JavaScript and TypeScript developers building applications for Hedera or other Hiero networks
- Contributors who want to build the SDK or run its integration tests locally
Documented uses
- Create or update on-ledger assets from an application
- Connect application logic to smart contracts on a Hedera or other Hiero network
- Build and locally link SDK packages while developing the library
Requirements & limits
The SDK is publicly available as a package and repository under the Apache-2.0 license. The README lists npm, Yarn and pnpm installation options and a browser UMD build.
- The library targets Hedera and other Hiero networks, rather than acting as a network or hosted application itself.
- The repository uses pnpm workspaces and includes proto, cryptography and main SDK packages.
- The README distinguishes React Native setup by SDK version; React Native Bare is listed as unsupported.
- Solo-based local integration testing has separate platform and memory requirements from ordinary package use.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Install the SDK and prepare its examples
Add the SDK package to a JavaScript or TypeScript project and prepare the repository examples.
Before you start
- Node.js and a JavaScript package manager such as npm, Yarn or pnpm
- For the repository examples: Taskfile, Node.js (20 or later recommended), and pnpm
Steps
Install the SDK with the command below,
yarn add @hiero-ledger/sdkorpnpm add @hiero-ledger/sdk.npm install --save @hiero-ledger/sdkTo prepare repository examples, run
task buildfrom the repository root.Install example dependencies with
pnpm installin theexamplesdirectory.
Expected outcome
The package is added to the project; after the repository build and dependency installation, the examples are prepared to run.
Guide limitations
- The guide prepares the examples but does not describe a specific network configuration or transaction.
- Node.js 20 or later is recommended for building; Node.js 16 may work but is not officially tested.
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 10 October 2026
- Original website title
- hiero-ledger/hiero-sdk-js · Official homepage title · retained in its source language

