Expand description
Typed provider with explicit routing, validated reads and signed transaction submission.
Modules§
- event_
hub - Runtime-independent bounded local event registration and delivery. Runtime-independent bounded local event delivery. Transport polling is explicit.
- header_
hash - Recompute a Quai zone header’s hashes from the node’s JSON, binding its state roots to the hashes other nodes report.
- state_
proof - Merkle-Patricia proofs of Quai account state, checked without trusting the node.
Structs§
- Access
List Estimate - Node-generated access declaration and simulated gas for one exact call.
- Access
List Item - An account transaction’s storage access declaration.
- Account
Nonce Candidate - A cryptographically verified transaction occupying the watched sender/nonce.
- Account
Replacement Scan - Advisory bounded scan result. Absence only covers the reported page prefix.
- Account
Replacement Scan Request - One explicit page of canonical-by-number account transaction discovery.
- Account
Replacement Tracker - In-memory, timer-independent cursor for successive canonical replacement pages. A failed or cancelled poll never advances the cursor. Reorgs fail explicitly; reconstruct from a trusted start height rather than trusting a stale cursor.
- Account
State - One account’s balance and nonce at the block an
Provider::account_statescall was pinned to. - Address
Outpoint - Address-index result; presence alone does not prove spendability or index completeness.
- Block
Hashes - A mined block containing executed transaction identities only. This saves transport/decoding work but cannot validate each transaction’s inclusion fields.
- Block
Metadata - Borrowed block metadata; field parsing is explicit and performs no RPC.
- Block
Reference - A source-reported zone block identity, not a verified chain proof.
- Broadcast
Result - The server acknowledged the exact expected ID. Inclusion/finality are separate.
- Call
Request - Account-only simulation request. This does not authorize or submit a transaction.
- Code
Wait Config - Portable millisecond limits for code-appearance waiting, without a misleading confirmation-depth setting. At most 100,000 completed observations.
- Confirmed
Receipt - A receipt that passed the requested observed confirmations and consistency checks.
- Confirmed
Transaction - Rechecked indexed transaction inclusion; signature verification is separate.
- Contract
Code Observation - Source-reported runtime code at one exact canonical block, including empty code. This does not prove ABI semantics, proxy implementation, future code or finality.
- Contract
Code Target - Explicit account and trusted network/runtime constraints, with no deployment hash.
- Conversion
Estimate - One conversion priced two ways at the current head, and the gap between.
- Conversion
Observation - Current lifecycle observations; they are not a persistent monotonic state machine.
- Conversion
Reference - Locally signed conversion identity and intent used to validate origin/final ETX observations.
- Deployment
Code - Code in the source’s state at the end of the canonical inclusion block. Empty code is preserved: successful creation does not guarantee deployed code.
- Deployment
Reference - Exact locally signed creation intent and optional expected runtime-code hash.
- Ecdsa
Values - ECDSA values reported by the node; parsing does not verify the signature.
- EtxCorrelation
- Stable ETX correlation identity; prime processing may change the final transaction hash.
- EtxExecution
Observation - A final-hash ETX and its optionally available, association-checked receipt.
- EtxScan
Request - Explicit inclusive scan bounds. There is no implicit genesis-to-latest lookup.
- EtxScan
Result - A bounded, linked and rechecked source observation.
- Extensions
- Unknown response fields retained explicitly; diagnostic formatting omits values.
- External
Observation - Source-reported execution outcome, separate from token minting or Qi maturity.
- External
Reference - Exact nonconversion ETX expectation reconstructed from locally signed bytes. Persist those bytes to reconstruct this identity after a restart.
- External
Transaction - External transaction fields, preserving protocol origin rather than pretending it is signed locally.
- FeeData
- Optional exact gas price view. Absence is metadata, never an automatic zero fee.
- Head
Follow Policy - Bounded reconnection and missed-notification polling policy.
- Head
Tracker - Memory-bounded replay cursor; clone before polling when application persistence must commit before advancing its in-memory cursor. No transaction is resubmitted.
- Head
Update - A bounded update in application order: undo removed blocks, then apply added blocks.
- Inclusion
- Included transaction’s untrusted RPC location metadata.
- Locked
Balance Observation - Latest-only aggregate locked balance; cannot attribute funds to a conversion or historical block.
- Log
- Contract log and its block/transaction association.
- LogFilter
- Zone-explicit log query with bounded addresses, topics and numeric span.
- Network
- Immutable human-readable label and exact chain ID. This does not include a genesis hash, RPC endpoint, activation state or any authenticated chain claim.
- Network
Registry - Caller-owned network registry, containing at most 256 combined name/chain keys. No default mainnet entry, endpoint selection or process-global mutation occurs.
- OutPoint
- Exact UTXO identity.
- Outpoint
Deltas - Exact created/deleted outpoints reported over a block-hash range, inclusive. The connected node must retain spent/trimmed history; this is not a proof.
- Pool
Inspection - One source-formatted pool entry; its text is not parsed as authoritative values.
- Pool
Status - Current pool counts, including Qi even though account pool content excludes Qi.
- Pool
Transaction - One validated account pool transaction. Absence cannot authorize nonce release.
- Proven
Account - An account’s state, proven against one block’s
evmRoot. - Proven
Slot - One storage slot’s value, proven under its account’s storage root.
- Provider
- A provider with a fixed routing table and an explicitly expected chain ID.
- QiCredit
Observation - Current source-reported outputs attributable to one canonical external hash. This is not a complete historical credit or an atomic UTXO snapshot.
- QiFee
Quote - Advisory quote for the exact specialized input/output shape and sampled head.
- QiInput
- Qi transaction input. Keys are structural bytes until cryptographic verification.
- QiOutput
- Qi output, including Quai destinations used by conversions.
- QiTransaction
- Qi transaction fields.
- Quai
Transaction - Account transaction RPC fields.
- Receipt
- Initial typed transaction receipt for all three transaction kinds.
- RpcData
- Hex-encoded RPC bytes, distinct from a numeric quantity. Debug reveals length only.
- State
Anchor - A block to prove state at, read once and shared by any number of proofs.
- Transaction
- Typed transaction lookup result. Pending inclusion is represented as None.
- Transaction
Block - Executed block transactions; emitted outbound ETXs are deliberately separate extensions.
- Wait
Config - Explicit limits for native confirmation polling. No retry/submission is performed.
- WsHead
Follower - A new-head subscription paired with bounded canonical replay. Raw notifications are wake-up hints only. No transaction submission or pending-event replay occurs.
- Zone
Header - Fields needed to verify a receipt’s canonical block association on a zone.
Enums§
- Account
Replacement Poll - Result of one portable replacement-tracker poll; no timer or custody change.
- Block
Tag - A block selector supported by the initial account read methods.
- Block
Transaction Id - Exact transaction lookup without numeric/string coercion.
- Broadcast
Error - Submission errors distinguish preflight failures from ambiguous send outcomes.
- Code
Wait Error - Waiting errors do not undo deployments, change bindings or authorize transactions.
- Conversion
Effect - Interpretations of reported external subtypes under the pinned static mapping.
- Conversion
Origin Observation - Current origin-receipt observation; unavailable/noncanonical do not mean rejected.
- Conversion
Spendability - Receipts cannot qualify whether converted/refunded funds are currently spendable.
- Deployment
Observation - Current source-reported direct deployment state.
- Deployment
Wait Error - Native bounded deployment-wait failures never cancel an already signed operation.
- LogRange
- Explicit bounded log location; no implicit genesis-to-latest query.
- Mined
Block - A mined block selector. Hash lookup may return an orphan; latest is sampled once. Genesis has a root location and uses the separate genesis identity API.
- Network
Error - Invalid or conflicting network metadata. Names are labels, never trusted identities.
- Network
Match - Explicit matching intent, avoiding ambiguous numeric-name string coercion.
- Outbound
Block Transaction - An outbound item is distinct from an executed transaction in this block.
- Provider
Error - Provider failures without raw endpoint URLs or remote response bodies.
- QiFee
Profile - Caller-selected rules. Chain ID/client-version strings do not attest software.
- Receipt
Confirmation - Result of one bounded observation, without timers or automatic retries.
- Receipt
Outcome - Receipt execution outcome, preserving a historical post-state root when supplied.
- Replacement
Reason - Classification used by the pinned quais.js account response waiter. This is descriptive, never authorization to adopt a transaction or release a claim.
- Scan
Coverage - Completeness of this requested range only; neither variant proves complete wallet history.
- Topic
Match - Match one event topic position.
- Transaction
Confirmation - One bounded transaction observation without timers, retry or submission.
- Transaction
Details - A transaction’s complete initial typed variant.
- Transaction
Kind - Node transaction discriminator. Unknown transaction kinds are rejected.
- Wait
Error - Native confirmation-wait failures never imply a transaction was rejected or cancelled.
Constants§
- MAX_
ACCOUNT_ STATES - Most accounts one
Provider::account_statescall accepts. - MAX_
CONTRACT_ CODE_ TARGETS - Most addresses one
Provider::observe_contract_codescall accepts: its second round carries a guard, every code read and two rechecks in one batch. - MAX_
HEAD_ STATE_ BYTES - Maximum encoded public head cursor: 4,096 numbered hashes and fixed metadata.
- MAX_
OUTPOINT_ ADDRESSES - Most addresses one
Provider::outpoints_manycall accepts. It pages them internally, so a caller needs no page size of its own. - MAX_
PROVEN_ ACCOUNTS - Most accounts one
Provider::prove_accountscall accepts. - MAX_
PROVEN_ SLOTS - Most storage slots proven per account in one call.
- MAX_
RPC_ DATA_ BYTES - Maximum decoded byte payload accepted by these typed APIs.
Functions§
- qi_
special_ gas - Conservative native gas bound for a same-zone conversion or wrapping.