@hieco/mirror

@hieco/mirror is the Hieco client for read-only Hedera data from Mirror Node.

Use it when you want typed access to public blockchain data without bringing in signer logic, transaction execution, or framework-specific state management.

Why This Package Exists

Many Hedera apps spend most of their time reading:

• accounts and balances
• tokens and NFTs
• transactions
• contracts and logs
• topics and messages
• schedules, blocks, and network state

@hieco/mirror gives those reads a cleaner shape with one client, domain-specific APIs, and shared result types that power the CLI, MCP server, and framework wrappers.

When To Use It

Choose @hieco/mirror when you are building:

• server-side data fetchers
• read-only dashboards
• indexing or reporting tools
• scripts that inspect public chain data
• framework wrappers or internal services that need Mirror Node access

If you want framework-native query APIs, use one of the wrapper packages:

• @hieco/mirror-react
• @hieco/mirror-preact
• @hieco/mirror-solid

Installation

npm install @hieco/mirror

pnpm add @hieco/mirror

yarn add @hieco/mirror

bun add @hieco/mirror

Quick Start

import { MirrorNodeClient } from "@hieco/mirror";

const mirror = new MirrorNodeClient({ network: "testnet" });

const account = await mirror.account.getInfo("0.0.1001");
const transactions = await mirror.transaction.listPaginated({
  accountId: "0.0.1001",
  limit: 10,
  order: "desc",
});

The Client Shape

MirrorNodeClient is organized by domain instead of raw endpoint path.

Main namespaces include:

• account
• balance
• block
• contract
• network
• schedule
• token
• topic
• transaction

That keeps common tasks easy to discover and makes the same data model reusable across the rest of the ecosystem.

Common Workflows

Read account data

const info = await mirror.account.getInfo("0.0.1001");
const balances = await mirror.balance.list({
  account: "0.0.1001",
  limit: 1,
});

Inspect token and NFT state

const token = await mirror.token.getInfo("0.0.2001");
const nfts = await mirror.token.getNfts("0.0.2001", {
  serialNumber: 1,
});

Explore contract activity

const contract = await mirror.contract.getInfo("0.0.3001");
const logs = await mirror.contract.getLogs("0.0.3001", {
  topic0: "0xddf252ad",
});

Network Configuration

Built-in networks work out of the box through network. If you need a custom endpoint, pass mirrorNodeUrl.

That same model is what the framework wrappers, CLI, and MCP server build on.

Packaging And Runtime Support

@hieco/mirror ships browser-friendly ESM output with explicit conditional exports for browser, worker, workerd, node, and default.

The important effect for consumers is simple: the package is easier to reuse in browser tools, edge-style runtimes, and server code without changing the API.

API At A Glance

Core exports:

• MirrorNodeClient
• domain API classes such as AccountApi, TokenApi, and ContractApi
• shared pagination and response types
• shared result and network types used across the Hieco package family

Related Packages

• @hieco/mirror-react, @hieco/mirror-preact, and @hieco/mirror-solid for framework bindings
• @hieco/mirror-cli for terminal access
• @hieco/mirror-mcp for MCP-based agent access