ReadonlyClient

A read-only Midnight client for querying contract state.

No wallet, proof server, or private state required. Created via Client.createReadonly(). Ideal for dashboards, explorers, and monitoring tools.

Since

0.8.0

Properties

networkConfig

readonly networkConfig: NetworkConfig

Defined in: src/Client.ts:226

Network configuration

provider

readonly provider: PublicDataProvider

Defined in: src/Client.ts:228

Public data provider (for advanced use)

Methods

loadContract()

loadContract<M>(options): ReadonlyContract<InferLedger<M>>

Defined in: src/Client.ts:247

Load a contract module for read-only state queries.

Only requires the contract module (for its ledger parser). No wallet, proof server, or private state needed.

Type Parameters

M

M extends ContractModule<unknown, string>

Contract module type (inferred from options.module)

Parameters

options

module

M

Returns

ReadonlyContract<InferLedger<M>>

A ReadonlyContract handle with readState() and related methods.

Example

const reader = Client.createReadonly({ networkConfig });
const counter = reader.loadContract({ module: CounterContract });
const state = await counter.readState(address);
console.log(state.counter); // 42n