跳转到内容

本页面的来源

本页面的每条论断都对应固定的修订版本。打开路径即可查看验证所依据的确切来源。

universe-index-atomicals-nfts-and-realms

Universe Atomicals NFT, Realm, and Subrealm index

修订 1d9109c68d95

打开固定路径: server

Materialized read model for plain NFTs, Realms, and Subrealms projected from Atomicals ElectrumX.

universe-index-atomicals

Universe ARC-20 index and Marketplace v1 authority

修订 670030e50071

打开固定路径: tokenExplorerDocs

Universe ARC-20 token explorer feed and the durable Marketplace v1 protocol authority.

Readiness and freshness

Raw

Configured, live, ready, degraded, stale, and mixed tip are six different states. A caller must handle each one differently.

Universe implementation Verified 2026-08-31 Metadata & Sources

Describes what a Bitcoin Universe service actually does today. It is not a statement about the protocol in general.

Page ID
develop/readiness-and-freshness
Normative authority
Universe implementation documentation
Networks
mainnet
Documentation version
2026.08
Audience
developer, operator, integrator
Owner
bitcoin-universe-docs
Sources

此内容尚不支持你的语言。

A configured source is not a healthy source

Section titled “A configured source is not a healthy source”

Configuration means someone wrote a setting. Readiness means the service can currently answer correctly. They are unrelated.

Endpoint Answers
GET /live Is the process running?
GET /ready Can it answer correctly, and if not, why?
GET /health What is the state, including unavailable?
GET /version Which service and provider revisions?
GET /metrics Operational metrics, where enabled

/live returning 200 says nothing about whether an answer would be correct. Read /ready.

The NFT and Realm read model reports ready only when all of the following hold:

  • a generation identifier exists;
  • the indexed height is a safe integer;
  • the view is not stale;
  • the tip is not mixed;
  • the integrity check has not failed.

When any fails, the response is 503 with the reason, the state, the source, the network, the generation identifier, the indexed height, the source revision, and the counts.

That response is designed to be actionable rather than merely negative.

State Meaning What a caller does
Configured A setting exists Nothing. Wait for readiness
Live The process is running Nothing. Check readiness
Ready Can answer correctly Proceed
Degraded Answering from an incomplete view Do not act on the answer
Stale Answering from an old chain position Check the indexed height
Mixed tip The generation spans more than one provider tip Do not act on the answer

The ARC-20 source declares partial coverage with an explicit reason: confirmed authoritative history and complete proven holder snapshots are indexed, but the shipped adapter has no exhaustive mempool feed with stable pending lifecycle and disappearance handling.

That limitation is about pending activity. It does not weaken the confirmed scan or the holder proof requirements. Read the declared coverage rather than assuming completeness.

Render the state, never a misleading zero:

  • “We cannot reach the index right now” for unavailable.
  • “Showing data from block N” for stale.
  • “This view does not cover that asset type” for out of scope.
  • “No assets found” only when ready and genuinely empty.

The production read service runs on the dedicated Universe indexer host and binds only to its local interface. A supervised private compatibility tunnel keeps existing application routes available during infrastructure changes, while automatic restart and health checks restore both the indexer and its private route without manual intervention. Endpoint consumers still apply the readiness and freshness rules above: resilience of the service does not exempt a caller from declaring coverage and lag.

Unavailable index against empty balance.