hedera-official-agent-kit-js

hedera-official-agent-kit-js

Source: github.com/hashgraph/hedera-agent-kit-js. The body below is the upstream README.md captured at the time of registration.

---

Hedera Agent Kit

Build Hedera-powered AI agents in under a minute.

Upgrading from v3? See the v3 → v4 Migration Guide for all breaking changes.

📋 Contents

• Key Features
• About the Agent Kit Functionality
• Third Party Plugins
• Hooks and Policies
• Developer Examples
• 🚀 60-Second Quick-Start
• Agent Execution Modes
• Hedera Plugins & Tools
• Creating Plugins & Contributing
• License
• Credits

---

Key Features

The Hedera Agent Kit is an open-source toolkit that brings intelligent agent workflows to the Hedera network. It’s designed for developers who want to integrate Hedera account management and Hedera native functionality into agent applications. With the Hedera Agent Kit, developers can build agents that interact on-chain through a conversational interface. This means Hedera agents can do more than process information; they can also send tokens, manage accounts, store data on Hedera Consensus Service, and coordinate workflows directly on a public ledger.

As of v4, the Hedera Agent Kit is organized as a monorepo of @hashgraph-scoped packages. You install the core package plus only the toolkit for your framework (LangChain, Vercel AI SDK, ElizaOS, or MCP). See the v3 → v4 Migration Guide for details.

The Hedera Agent Kit is extensible with third party plugins by other projects.

---

Agent Kit Functionality

The list of currently available Hedera plugins and functionality can be found in the Plugins & Tools section of this page

👉 See docs/HEDERAPLUGINS.md for the full catalogue & usage examples for Hedera Tools.

Want to add more functionality from Hedera Services? Open an issue!

---

Third Party Plugins

The Hedera Agent Kit is extensible with third party plugins by other projects. See how you can build and submit your own plugin to listed as a Hedera Agent Kit plugin in Hedera Docs and README in docs/PLUGINS.md

• Memejob Plugin provides a streamlined interface to the memejob protocol, exposing the core actions (create, buy, sell) for interacting with meme tokens on Hedera:

  Github repository: https://github.com/buidler-labs/hak-memejob-plugin

• Bonzo Plugin is a unified SDK to the Bonzo protocol, exposing the core actions (deposit, withdraw, repay, borrow) for decentralised lending and borrowing on Hedera:

  Github repository: https://github.com/Bonzo-Labs/bonzoPlugin

• SaucerSwap Plugin provides a streamlined interface to the SaucerSwap DEX, exposing the core actions (saucerswap_get_swap_quote, saucerswap_swap_tokens, saucerswap_get_pools, saucerswap_add_liquidity, saucerswap_remove_liquidity, saucerswap_get_farms) for swaps, liquidity, and farming insights:

  NPM: https://www.npmjs.com/package/hak-saucerswap-plugin Source: https://github.com/jmgomezl/hak-saucerswap-plugin Tested/endorsed version: [email protected]

• Pyth Plugin provides access to the Pyth Network price feeds via the Hermes API, exposing tools to list feeds and fetch latest prices:

  Github repository: https://github.com/jmgomezl/hak-pyth-plugin. Tested/endorsed version of plugin: [email protected]

• CoinCap Plugin provides access to the CoinCap API service to access cryptocurrency market data. It exposes the action (get HBAR price in USD) to get the current price of HBAR in USD currency, by using it you can ask your agent to get your current HBAR balance expressed in USD.

  Github repository: https://github.com/henrytongv/coincap-hedera-plugin. Tested/endorsed version of plugin: [email protected]

• Chainlink price feed Plugin provides access to the Chainlink price feeds to get data aggregated from many data sources. It exposes the action (get price feed) that allows you to get the current price for ETH, BTC, HBAR, LINK, USDC, UST or DAI.

  Github repository: https://github.com/henrytongv/chainlink-price-plugin-js. Tested/endorsed version of plugin: [email protected]

• Hedera T3N Plugin provides access to Terminal 3 Network (T3N) to enable identity verification, authentication, and last mile-delivery or selective disclosure of private and sensitive information for AI-driven applications, ensuring compliant and auditable interactions.

  Github repository: https://github.com/Terminal-3/hedera-t3n-plugin

Contribute your own plugin

Hooks and Policies

The Hedera Agent Kit provides a flexible and powerful system for putting limits on tool usage and enforcing business logic, effectively enabling you to limit the functionality of AI agents through Hooks and Policies. These hooks and policies can be used to enforce security, compliance, and other business rules.

Features

• Hooks and policies can be called when parameters are passed, after parameter normalization, before tool execution when a transaction has been formed, and after tool execution when a transaction has been signed and submitted.
• Users can create their own hooks and policies on any available Hedera Agent Kit tool, simply fork this repo and create your own hooks and policies in the typescript/src/hooks and typescript/src/policies directories.
• We have provided examples:
  • A hook to log actions to an HCS topic, creating an easy to track audit trail.
  • A policy that sets the maximum number of recipients in a transfer or airdrop.
  • A policy the blocks tool usage by an agent.

For more information on hooks and policies, see the Hooks and Policies documentation.

Try out an example Audit Hook Agent to see how hooks and policies work in practice.

---

Developer Examples

You can try out examples of the different types of agents you can build by followin the instructions in the Developer Examples doc in this repo.

First follow instructions in the Developer Examples to clone and configure the example, then choose from one of the examples to run:

• Option A - Example Tool Calling Agent
• Option B - Example Structured Chat Agent
• Option C - Example Return Bytes Agent
• Option D - Example MCP Server
• Option E - Example ElizaOS Agent
• Option F - Example Preconfigured MCP Client Agent
• Option G - Example Google ADK Agent

---

🚀 60-Second Quick-Start

See more info at [https://www.npmjs.com/package/@

---

Content truncated.