@hiero-did-sdk/hcs
v0.1.7
Published
This package provides a comprehensive interface for interacting with Hedera Consensus Service (HCS) within the Hiero DID SDK JS.
Readme
@hiero-did-sdk/hcs
This package provides a comprehensive interface for interacting with Hedera Consensus Service (HCS) within the Hiero DID SDK JS. It offers a set of services for managing topics, submitting and retrieving messages, and handling files through HCS.
Features
- HCS Topics Management: Provides capabilities for creating, updating and deleing HCS Topics.
- HCS Messages Management: Submit and retrieve HCS messages.
- HCS-1 standard support: Submit and retrieve files using HCS as a storage layer according to HCS-1 Standard.
- Caching Support: Improve performance with optional caching of HCS messages and Topics info.
- TypeScript Support: Built with TypeScript to enhance developer experience and code maintainability.
Installation
Install the package via npm:
npm install @hiero-did-sdk/hcsUsage
Learn how to use:
- HederaHcsService Usage Guide
- HcsTopicService Usage Guide
- HcsMessageService Usage Guide
- HcsFileService Usage Guide
API Reference
See detailed API specifications and available methods here:
- HederaHcsService API Reference.
- HcsTopicService API Reference
- HcsMessageService API Reference
- HcsFileService API Reference
Running Tests
Unit tests are included to validate functionality. Run tests with:
npm testLicense
This project is licensed under the Apache License 2.0. See the LICENSE file for details.
References
- Hiero DID SDK - The official repository for the Hashgraph DID SDK, containing the complete source code and documentation.
- Hedera JavaScript SDK - The official Hedera JavaScript SDK, used for interacting with the Hedera network.
- Hedera Consensus Service - Documentation for the Hedera Consensus Service used by this package.
