QubiQ Core Overview

Use this page as the table of contents for @qubiq/core. Each section below links to the detailed guides already present in the sidebar so you can jump directly to the area you need.

Foundations

• Getting Started – install instructions, example scripts, and the recommended Bun/Node workflow.
• Architecture – how wallets, clients, automation, and telemetry fit together.
• Module Map – quick reference for every public export.
• Configuration – live/query/archive client knobs and environment profiles.
• TypeScript Tooling – repo layout, lint/test commands, and contributor tips.

Wallets & Signing

• Wallet Toolkit – deterministic derivation, identity helpers, secure storage, offline bundles, and watchers.

Automation & Operations

• Runtime overview – polling jobs, runtime composition, and balance snapshots.
• Monitoring & Telemetry – Tick/Balance monitors, Prometheus exporters, and instrumentation helpers.
• Boot Manager – ensure services resume safely after downtime.

Interop & Clients

• HTTP Clients – Live/Query/Archive clients with Zod validation.
• Connectors – event-driven abstractions such as the HttpConnector.
• Node Client – façade that combines the live/query stack.
• Serialization – transaction/header encoders plus byte helpers.
• Schemas & Utils – request/response Zod schemas, identity helpers, and codec utilities.
• Contract Metadata – generated struct layouts for every upstream smart contract.

Governance & Quality

• Governance – proposal registry, workflow helpers, and automation hooks.
• Quality & Testing – snapshot replay fixtures, mock clients, and best practices.

Use the sidebar to explore individual topics or jump back here whenever you need to reorient yourself.