https://github.com/hashgraph-online/hashgraph-online-standards-sdk-js
The official Hashgraph Online Standards SDK, implementing the standards found in https://hashgraphonline.com/docs/standards
https://github.com/hashgraph-online/hashgraph-online-standards-sdk-js
hedera hedera-hashgraph
Last synced: 4 months ago
JSON representation
The official Hashgraph Online Standards SDK, implementing the standards found in https://hashgraphonline.com/docs/standards
- Host: GitHub
- URL: https://github.com/hashgraph-online/hashgraph-online-standards-sdk-js
- Owner: hashgraph-online
- License: apache-2.0
- Created: 2025-03-04T16:08:39.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2025-06-18T14:35:56.000Z (4 months ago)
- Last Synced: 2025-06-18T15:37:56.500Z (4 months ago)
- Topics: hedera, hedera-hashgraph
- Language: HTML
- Homepage: https://hashgraphonline.com
- Size: 1.38 MB
- Stars: 26
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# Hashgraph Online Standards SDK
A lightweight SDK providing reference implementations for Hashgraph Consensus Standards (HCS) created by Hashgraph Online.
## Quick Start
```bash
npm install @hashgraphonline/standards-sdk
```
## Documentation
For complete documentation, examples, and API references, visit:
- [Standards SDK Documentation](https://hashgraphonline.com/docs/libraries/standards-sdk/)
## Supported Standards
- **HCS-3**: Recursion for Inscribed Files
- **HCS-7**: Dynamic, Programmable, and 100% on-graph assets
- **HCS-10**: Trustless, peer to peer communication for AI Agents
- **HCS-11**: Profile Standard
## Running Demos
The SDK includes demo implementations that showcase various features. Follow these steps to run them:
1. Clone the repository
```bash
git clone https://github.com/hashgraph-online/standards-sdk.git
cd standards-sdk
```
2. Install dependencies
```bash
npm install
```
3. Set up environment variables
```bash
cp .env.example .env
```
4. Edit the `.env` file with your Hedera credentials:
```
HEDERA_ACCOUNT_ID=0.0.12345
HEDERA_PRIVATE_KEY=your_private_key_here
HEDERA_NETWORK=testnet
REGISTRY_URL=https://moonscape.tech
```
**Note**: The SDK automatically saves agent creation progress to the `.env` file. If agent creation is interrupted, it will resume from the last successful step when you run the demo again. See `.env.example` for details on the auto-generated agent state variables.
5. Run the demos:
The following demo showcases inscribing a file.
```bash
# Run the inscribe demo
npm run demo:inscribe
```
The following demo showcases registering Alice and Bob and exchanging messages between the two agents.
```bash
# Run the HCS-10 AI agent communication demo
npm run demo:hcs-10
```
The following demo showcases a polling agent that polls an inbound topic for new messages with an OpenAI integration and simple commands.
```bash
# Run the HCS-10 polling demo
npm run demo:polling-agent
```
The following demo showcases Foo and Bar agents exchanging messages where Foo also requires a fee to send messages to Bar's inbound topic:
```bash
# Run the HCS-10 fee demo
npm run demo:hcs-10-fee
```
### Demo Descriptions
#### Inscribe Demo
The inscribe demo (`demo/inscribe-demo.ts`) showcases different file inscription capabilities:
- Text inscription using buffers
- URL-based inscriptions
- File buffer inscriptions
- Creating Hashinal NFTs from URLs
- Creating Hashinal NFTs from buffers
- Creating Hashinal NFTs from text content
Each inscription demonstrates different options and metadata capabilities.
#### HCS-10 AI Agent Communication Demo
The HCS-10 demo (`demo/hcs-10/index.ts`) demonstrates trustless peer-to-peer communication between AI agents:
- Agent creation and registration (Alice and Bob)
- Agent metadata and profile management
- Connection establishment between agents
- Sending and retrieving small messages
- Sending and retrieving large messages with recursive storage
- Message data processing
- **Resumable agent creation**: If agent creation is interrupted, the SDK automatically resumes from where it left off using state saved in environment variables
The demo automatically handles agent funding, topic creation, and registration with the global registry. Agent creation progress is tracked in real-time and saved to the `.env` file, allowing recovery from any interruption.
## Contributing
Please read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project.
For bugs and feature requests, please use the [issue templates](https://github.com/hashgraph-online/standards-sdk/issues/new/choose).
## Security
For security concerns, please refer to our [Security Policy](SECURITY.md).
## Maintainers
See [MAINTAINERS.md](MAINTAINERS.md) for a list of project maintainers.
## Resources
- [HCS Standards Documentation](https://hcs-improvement-proposals.pages.dev/docs/standards)
- [Hedera Documentation](https://docs.hedera.com)
- [Telegram Community](https://t.me/hashinals)
## License
Apache-2.0