Clients & SDKs
Everything the chain can do is reachable three ways: the virtengine CLI,
gRPC/REST queries, and the TypeScript SDK. All three speak to the same node
API.
The CLI
Section titled “The CLI”The virtengine binary doubles as the client. Transactions and queries are
namespaced per module — the pattern is consistent across the protocol:
# Transactions: virtengine tx <module> <action> [flags]virtengine tx hpc submit-job job.yaml --from tenantvirtengine tx settlement dispute-usage --usage-id usage-123 --from customervirtengine tx gov vote 42 yes --from validator
# Queries: virtengine query <module> <query> [flags]virtengine query settlement disputes --status pendingvirtengine query gov proposal 42
# Some modules also expose top-level helpersvirtengine hpc templates listvirtengine veid enroll --consent-biometric=true ...Spec-file-driven commands (HPC job submission, provider registration, queue
creation) accept JSON or YAML with an optional schema_version: "1.0" —
formats are documented in the repo’s docs/hpc-cli-specs.md and on
Submitting HPC Jobs.
TypeScript SDK
Section titled “TypeScript SDK”A TypeScript SDK lives in the repository at sdk/ts/ as a pnpm workspace:
pnpm -C sdk/ts installUse it to build web and Node.js integrations against chain queries and transaction construction without shelling out to the CLI.
gRPC and REST
Section titled “gRPC and REST”As a Cosmos SDK chain, VirtEngine nodes expose the standard query surfaces:
gRPC services per module, and REST via gRPC-gateway, alongside CometBFT RPC
(default :26657) for consensus-level queries. Any Cosmos-ecosystem client
tooling that lets you register custom message types can be adapted.
Where module APIs are defined
Section titled “Where module APIs are defined”There is no better reference than the module source. For each module
x/<name>:
| Location | Contents |
|---|---|
x/<name>/types/msgs.go | Message types (Msg…) — the transaction API |
x/<name>/types/keys.go | Module name, store keys |
x/<name>/keeper/ | State logic, query handlers |
x/<name>/types/codec.go | Registered message routes |
x/<name>/client/ | CLI wiring (where present) |
Example: x/veidregistry/types/msgs.go defines
MsgUpsertVerifierVersion, MsgApproveVerifierVersion,
MsgCancelVerifierVersion, MsgRetireVerifierVersion,
MsgReportValidatorReadiness, and MsgUpdateParams — the complete
verifier-registry transaction surface.
Related tooling
Section titled “Related tooling”- Bosun — VirtEngine’s autonomous AI agent orchestrator
(
npm install -g bosun), used to supervise fleets of coding agents; see the Bosun repository for docs. - Economics tooling —
pkg/economics/simulation and audit framework; see Tokenomics.