ReadonlyContract
Defined in: src/Contract.ts:495
A read-only contract handle — can query state without a wallet or proof server.
Created via Client.createReadonly().loadContract(). Only exposes state
reading methods. Ideal for dashboards, explorers, and monitoring.
Since
0.8.0
Type Parameters
TLedger
TLedger = unknown
The ledger state type (inferred from module)
Properties
effect
readonlyeffect:object
Defined in: src/Contract.ts:524
Effect versions of read-only methods.
readRawState()
readRawState(
address):Effect<unknown,ContractError>
Parameters
address
string
Returns
Effect<unknown, ContractError>
readRawStateAt()
readRawStateAt(
address,blockHeight):Effect<unknown,ContractError>
Parameters
address
string
blockHeight
number
Returns
Effect<unknown, ContractError>
readState()
readState(
address):Effect<TLedger,ContractError>
Parameters
address
string
Returns
Effect<TLedger, ContractError>
readStateAt()
readStateAt(
address,blockHeight):Effect<TLedger,ContractError>
Parameters
address
string
blockHeight
number
Returns
Effect<TLedger, ContractError>
watchRawState()
watchRawState(
address,options?):Stream<unknown,ContractError>
Parameters
address
string
options?
Returns
Stream<unknown, ContractError>
watchState()
watchState(
address,options?):Stream<TLedger,ContractError>
Parameters
address
string
options?
Returns
Stream<TLedger, ContractError>
ledgerParser
readonlyledgerParser:LedgerParser<TLedger>
Defined in: src/Contract.ts:497
The ledger parser function (from the contract module).
Methods
onRawStateChange()
onRawStateChange(
address,callback,options?):Unsubscribe
Defined in: src/Contract.ts:518
Watch raw state changes at an address (callback).
Parameters
address
string
callback
(state) => void
options?
Returns
onStateChange()
onStateChange(
address,callback,options?):Unsubscribe
Defined in: src/Contract.ts:512
Watch parsed state changes at an address (callback).
Parameters
address
string
callback
(state) => void
options?
Returns
readRawState()
readRawState(
address):Promise<unknown>
Defined in: src/Contract.ts:506
Read raw (unparsed) contract state at an address.
Parameters
address
string
Returns
Promise<unknown>
readRawStateAt()
readRawStateAt(
address,blockHeight):Promise<unknown>
Defined in: src/Contract.ts:509
Read raw contract state at an address and specific block height.
Parameters
address
string
blockHeight
number
Returns
Promise<unknown>
readState()
readState(
address):Promise<TLedger>
Defined in: src/Contract.ts:500
Read parsed ledger state at an address.
Parameters
address
string
Returns
Promise<TLedger>
readStateAt()
readStateAt(
address,blockHeight):Promise<TLedger>
Defined in: src/Contract.ts:503
Read parsed ledger state at an address and specific block height.
Parameters
address
string
blockHeight
number
Returns
Promise<TLedger>
watchRawState()
watchRawState(
address,options?):AsyncIterableIterator<unknown>
Defined in: src/Contract.ts:521
Watch raw state changes at an address (async iterator).
Parameters
address
string
options?
Returns
AsyncIterableIterator<unknown>
watchState()
watchState(
address,options?):AsyncIterableIterator<TLedger>
Defined in: src/Contract.ts:515
Watch parsed state changes at an address (async iterator).
Parameters
address
string
options?
Returns
AsyncIterableIterator<TLedger>