Skip to content
Back to search

standards-sdk

The official HOL Standards SDK, implementing the standards found in https://hol.org/docs/standards

Safety scan

A static text scan, not a guarantee. Select the badge to see what was scanned and every finding.

Checked today
Badge for your README
findsafeskills safety rating

Markdown

[![findsafeskills safety rating](/api/listings/hashgraph-online--standards-sdk/badge.svg)](/listings/hashgraph-online--standards-sdk)

HTML

<a href="/listings/hashgraph-online--standards-sdk"><img src="/api/listings/hashgraph-online--standards-sdk/badge.svg" alt="findsafeskills safety rating" /></a>

Install

i

Install instructions from the README

As written by the repo's author. findsafeskills has not verified these steps.

npm install @hol-org/standards-sdk
# Legacy scope:
# npm install @hashgraphonline/standards-sdk

For the standalone Registry Broker client with a smaller footprint:

npm install @hol-org/rb-client

HOL-scoped distributions are published in parallel:

- `@hol-org/rb-client`: registry broker client only - `@hol-org/standards-sdk`: full SDK under the HOL scope

Optional dependencies for `@hol-org/rb-client`

The client ships with zero network transports bundled. Install these peers when you need the related features:

- `axios` + `x402-axios` + `x402` for X402 credit purchases and payments - `viem` for EVM-based ledger authentication - `@hashgraph/sdk` for Hedera ledger authentication

Core agent search/chat flows only require a `fetch` implementation.

What was scanned

The files the safety scan read, as written by the repository's author and shown as plain text. Lines with a finding are marked.

README.md · README · 262 lines

View this file on GitHub (read at the repository's current version: the scan did not record which commit it read)

  1. # HOL Standards SDK
  2. | ![](./Hashgraph-Online.png) | A lightweight SDK providing reference implementations for Hashgraph Consensus Standards (HCS) created by HOL.<br><br>This SDK is built and maintained by [HOL](https://hol.org), a consortium of leading Hedera Organizations within the Hedera ecosystem.<br><br>[📚 Standards SDK Documentation](https://hol.org/docs/libraries/standards-sdk/)<br>[📖 HCS Standards Documentation](https://hol.org/docs/standards) |
  3. | :-------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
  4. ## Quick Start
  5. ```bash
  6. npm install @hol-org/standards-sdk
  7. # Legacy scope:
  8. # npm install @hashgraphonline/standards-sdk
  9. ```
  10. For the standalone Registry Broker client with a smaller footprint:
  11. ```bash
  12. npm install @hol-org/rb-client
  13. ```
  14. HOL-scoped distributions are published in parallel:
  15. - `@hol-org/rb-client`: registry broker client only
  16. - `@hol-org/standards-sdk`: full SDK under the HOL scope
  17. ### Optional dependencies for `@hol-org/rb-client`
  18. The client ships with zero network transports bundled. Install these peers when you need the related features:
  19. - `axios` + `x402-axios` + `x402` for X402 credit purchases and payments
  20. - `viem` for EVM-based ledger authentication
  21. - `@hashgraph/sdk` for Hedera ledger authentication
  22. Core agent search/chat flows only require a `fetch` implementation.
  23. ## Documentation
  24. For complete documentation, examples, and API references, visit:
  25. - [Standards SDK Documentation](https://hol.org/docs/libraries/standards-sdk/)
  26. ### Registry Broker skill verification (DNS TXT domain proof)
  27. The `RegistryBrokerClient` supports version-scoped skill verification plus DNS TXT domain proof:
  28. ```typescript
  29. import { RegistryBrokerClient } from '@hashgraphonline/standards-sdk';
  30. const client = new RegistryBrokerClient({
  31. apiKey: process.env.REGISTRY_BROKER_API_KEY,
  32. });
  33. await client.requestSkillVerification({
  34. name: 'demo-skill',
  35. version: '1.0.0',
  36. tier: 'basic', // or 'express'
  37. });
  38. const challenge = await client.createSkillDomainProofChallenge({
  39. name: 'demo-skill',
  40. version: '1.0.0',
  41. domain: 'example.com',
  42. });
  43. const challengeToken = challenge.txtRecordValue.replace(/^hol-skill-verification=/, '');
  44. await client.verifySkillDomainProof({
  45. name: 'demo-skill',
  46. version: '1.0.0',
  47. domain: 'example.com',
  48. challengeToken,
  49. });
  50. ```
  51. Runnable demo: `pnpm -C standards-sdk tsx demo/registry-broker/skill-domain-proof-demo.ts --skill-name=<name> --base-url=<broker-api-url>`.
  52. ### Registry Broker skill lifecycle status
  53. The `RegistryBrokerClient` can resolve lifecycle status for a skill name/version and surface preview evidence when a repo has only completed validate-first checks:
  54. ```typescript
  55. import { RegistryBrokerClient } from '@hashgraphonline/standards-sdk';
  56. const client = new RegistryBrokerClient({
  57. baseUrl: 'https://hol.org/registry/api/v1',
  58. });
  59. const status = await client.getSkillStatus({
  60. name: 'registry-broker',
  61. version: '1.0.0',
  62. });
  63. console.log(status.trustTier);
  64. console.log(status.nextSteps);
  65. console.log(status.preview?.statusUrl ?? null);
  66. ```
  67. Runnable demo: `pnpm -C standards-sdk run demo:registry-broker-skill-status -- --skill-name=<name> --skill-version=<version> --base-url=<broker-api-url>`.
  68. ### Registry Broker UAID DNS verification (HCS-14 DNS TXT profile)
  69. The `RegistryBrokerClient` can verify and persist `_uaid.<nativeId>` TXT proof for an agent UAID:
  70. ```typescript
  71. import { RegistryBrokerClient } from '@hashgraphonline/standards-sdk';
  72. const client = new RegistryBrokerClient({
  73. baseUrl: 'https://hol.org/registry/api/v1',
  74. });
  75. const verify = await client.verifyUaidDnsTxt({
  76. uaid: 'uaid:aid:...;uid=...;proto=a2a;nativeId=agent.hol.org',
  77. persist: true,
  78. });
  79. const status = await client.getVerificationDnsStatus(
  80. 'uaid:aid:...;uid=...;proto=a2a;nativeId=agent.hol.org',
  81. { refresh: true, persist: false },
  82. );
  83. ```
  84. Runnable demo: `pnpm -C standards-sdk run demo:registry-broker-uaid-dns -- --uaid=<uaid> --base-url=<broker-api-url>`.
  85. ## Interactive CLI and Demos
  86. Launch the bundled CLI to explore registry broker demos, inspect required env vars, and run helper scripts:
  87. ```bash
  88. pnpm run cli
  89. ```
  90. The CLI surfaces:
  91. - Guided registry broker demos (OpenRouter, chat history, ledger auth) plus the HCS-10 agent flows.
  92. - A map of required env vars so you can bootstrap Hedera credentials and adapters quickly.
  93. - Links back to the docs plus the demo scripts you can run manually (`demo/registry-broker`, `demo/hcs-10`).
  94. See [cli/standards-cli/README.md](cli/standards-cli/README.md) for advanced and non-interactive commands.
  95. ## Supported Standards
  96. | Standard | Description |
  97. | :--- | :--- |
  98. | `HCS-1` | File Storage |
  99. | `HCS-2` | Registry and Indexing Standard |
  100. | `HCS-3` | Recursive File Loading |
  101. | `HCS-7` | Smart Hashinals |
  102. | `HCS-10` | Trustless Peer-to-Peer Communication for Agents and AI |
  103. | `HCS-11` | Decentralized Profile and Identity Standard |
  104. | `HCS-20` | Auditable Points |
  105. | `HCS-27` | Transparency Logs |
  106. ## Running Demos
  107. The SDK includes demo implementations that showcase registry broker flows (discovery, chat, ledger auth, OpenRouter) and HCS-10 agent communication. Follow these steps to run them:
  108. 1. Clone the repository
  109. ```bash
  110. git clone https://github.com/hashgraph-online/standards-sdk.git
  111. cd standards-sdk
  112. ```
  113. 2. Install dependencies
  114. ```bash
  115. npm install
  116. ```
  117. 3. Set up environment variables
  118. ```bash
  119. cp .env.example .env
  120. ```
  121. 4. Edit the `.env` file with your Hedera credentials:
  122. ```
  123. HEDERA_ACCOUNT_ID=0.0.12345
  124. HEDERA_PRIVATE_KEY=your_private_key_here
  125. HEDERA_NETWORK=testnet
  126. REGISTRY_URL=https://moonscape.tech
  127. ```
  128. The CLI can also auto-persist agent state in `.env` if a demo is interrupted. See `.env.example` for generated state fields.
  129. 5. Start a demo (or use `pnpm run cli` for an interactive launcher):
  130. ```bash
  131. npm run demo:registry-broker
  132. ```
  133. ```bash
  134. npm run demo:hcs-10
  135. ```
  136. Each demo directory contains README instructions plus you can review `demo/registry-broker` and `demo/hcs-10` for fine-grained scripts covering OpenRouter, history snapshots, ledger authentication, and fee flows.
  137. ### Demo Descriptions
  138. #### Inscribe Demo
  139. The inscribe demo (`demo/inscribe-demo.ts`) showcases different file inscription capabilities:
  140. - Text inscription using buffers
  141. - URL-based inscriptions
  142. - File buffer inscriptions
  143. - Creating Hashinal NFTs from URLs
  144. - Creating Hashinal NFTs from buffers
  145. - Creating Hashinal NFTs from text content
  146. Each inscription demonstrates different options and metadata capabilities.
  147. #### HCS-10 AI Agent Communication Demo
  148. The HCS-10 demo (`demo/hcs-10/index.ts`) demonstrates trustless peer-to-peer communication between AI agents:
  149. - Agent creation and registration (Alice and Bob)
  150. - Agent metadata and profile management
  151. - Connection establishment between agents
  152. - Sending and retrieving small messages
  153. - Sending and retrieving large messages with recursive storage
  154. - Message data processing
  155. - **Resumable agent creation**: If agent creation is interrupted, the SDK automatically resumes from where it left off using state saved in environment variables
  156. 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.
  157. ## Contributing
  158. Please read our [Contributing Guide](CONTRIBUTING.md) and [Code of Conduct](CODE_OF_CONDUCT.md) before contributing to this project.
  159. For bugs and feature requests, please use the [issue templates](https://github.com/hashgraph-online/standards-sdk/issues/new/choose).
  160. ## Security
  161. For security concerns, please refer to our [Security Policy](SECURITY.md).
  162. ## Maintainers
  163. See [MAINTAINERS.md](MAINTAINERS.md) for a list of project maintainers.
  164. ## Resources
  165. - [HCS Standards Documentation](https://hol.org/docs/standards)
  166. - [Hedera Documentation](https://docs.hedera.com)
  167. - [Telegram Community](https://t.me/hashinals)
  168. ### 📝 Blog Tutorials
  169. - [Building a Decentralized Registry with Go & HCS-2](https://hol.org/blog/building-decentralized-registry-go-hedara)
  170. - [Universal Agent Discovery with MCP](https://hol.org/blog/universal-agent-discovery-mcp)
  171. - [Creating Reactive Service Agents](https://hol.org/blog/creating-reactive-service-agents)
  172. - [End-to-End Encrypted Agent Communication](https://hol.org/blog/end-to-end-encrypted-agent-communication)
  173. - [Building Monetized Agents with x402](https://hol.org/blog/building-monetized-agents-x402)
  174. - [Bridging AgentVerse Communication](https://hol.org/blog/bridging-agentverse-communication)
  175. - [Discovering NANDA Agents with Registry Broker](https://hol.org/blog/discovering-nanda-agents-registry-broker)
  176. - [ERC-8004: Trustless Agent Registry](https://hol.org/blog/erc-8004-trustless-agent-registry)
  177. <!-- hol-sponsors:start -->
  178. <!-- hol-sponsors:end -->
  179. ## License
  180. Apache-2.0

Ratings and comments

Sign in to rate this skill.

Sign in

Free to use. If it’s helped, pass it on.