Para desenvolvedores / Ativos do mundo real

Ler um preço

Quatro superfícies respondem à mesma pergunta. A que você quer é em geral o adaptador do feed, porque ele é uma AggregatorV3Interface da Chainlink e o seu código existente já a fala.

A partir de um contrato

O adaptador é uma AggregatorV3Interface da Chainlink

The adapter implements AggregatorV3Interface with the same five functions and the same signatures, so existing code that reads a Chainlink feed compiles and runs against it unchanged. Point your consumer at the feed's adapter and it works.

Duas formas existem, e elas guardam as mesmas rodadas. O registro indexa cada leitura por feedId; um adaptador por feed prende um feedId a um endereço, para que um consumidor escrito contra a Chainlink não precise saber nada sobre identificadores de feed.

solidity
// The adapter: what an existing Chainlink consumer already calls.
AggregatorV3Interface feed = AggregatorV3Interface(adapter);
(, int256 answer,, uint256 updatedAt,) = feed.latestRoundData();
uint8 decimals = feed.decimals();          // 8 on every feed today - read it anyway

// The registry: one address for all 33 feeds, keyed by the hash of the symbol.
bytes32 feedId = keccak256(bytes("XAU/USD"));
(, int256 gold,, uint256 goldUpdatedAt,) = registry.latestRoundData(feedId);
uint8 state = registry.status(feedId);     // 1 open, 2 closed
uint64 observedAt = registry.latestObservedAt(feedId);

As seis coisas que um consumidor Chainlink deveria saber antes de confiar nisto:

  • One adapter per feed, holding no data: it stores the registry address and its own feedId and forwards every call. Rounds live in the registry.
  • startedAt equals updatedAt. Every round is a single transmission, as an OCR feed reports it, and answeredInRound equals roundId because no round is ever carried over.
  • updatedAt is the block timestamp of the publishing transaction, not the time the price was observed. The observation time is observedAt(feedId, roundId) on the registry, which usually LEADS updatedAt - that is why it is kept off the Chainlink tuple, where startedAt <= updatedAt is assumed.
  • The adapter emits no events. A consumer watching AnswerUpdated on it sees nothing; the registry emits FeedUpdated(feedId, ...) instead, and feedId is indexed.
  • version() returns 2, which is this layer's version and not a Chainlink aggregator version.
  • latestRoundData() on a feed that has never been written reverts with Error("No data present"), bubbled from the registry unchanged. The legacy latestAnswer() does not revert - it reads the ring at index 0 and returns 0, which is exactly the zero a consumer must not treat as a price.

Um consumidor que faz suas próprias verificações quer o registro em vez do adaptador, porque o status e a hora de observação não estão na tupla da Chainlink:

solidity
interface IPickleFeeds {
    function latestRoundData(bytes32 feedId)
        external view returns (uint80, int256, uint256, uint256, uint80);
    function status(bytes32 feedId) external view returns (uint8);
    function decimals(bytes32 feedId) external view returns (uint8);
}

uint8 constant STATUS_OPEN = 1;
uint8 constant STATUS_CLOSED = 2;

/// maxAge is YOUR tolerance, in seconds, and it only applies while the market is open.
function priceOf(IPickleFeeds registry, bytes32 feedId, uint256 maxAge)
    internal view returns (int256 answer, uint8 decimals)
{
    uint256 updatedAt;
    // Reverts with Error("No data present") when the feed has never been written.
    (, answer,, updatedAt,) = registry.latestRoundData(feedId);
    require(answer > 0, "feed: non-positive answer");

    uint8 state = registry.status(feedId);
    require(state == STATUS_OPEN || state == STATUS_CLOSED, "feed: status unknown");
    // A closed market's last print is the right price for as long as it is closed.
    if (state == STATUS_OPEN) {
        require(block.timestamp - updatedAt <= maxAge, "feed: stale");
    }
    decimals = registry.decimals(feedId);
}

As leituras do registro

  • latestRoundData(bytes32 feedId) returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound)
  • getRoundData(bytes32 feedId, uint80 roundId) returns (uint80, int256, uint256, uint256, uint80)
  • latestAnswer(bytes32 feedId) returns (int256)
  • latestTimestamp(bytes32 feedId) returns (uint256)
  • latestRound(bytes32 feedId) returns (uint256)
  • observedAt(bytes32 feedId, uint80 roundId) returns (uint64)
  • latestObservedAt(bytes32 feedId) returns (uint64)
  • status(bytes32 feedId) returns (uint8)
  • source(bytes32 feedId) returns (uint8)
  • decimals(bytes32 feedId) returns (uint8)
  • description(bytes32 feedId) returns (string)
  • symbol(bytes32 feedId) returns (string)
  • feed(bytes32 feedId) returns (FeedView)
  • feeds(uint256 offset, uint256 limit) returns (FeedView[])
  • feedCount() returns (uint256)
  • feedIdAt(uint256 index) returns (bytes32)
  • adapterOf(bytes32 feedId) returns (address)
  • adapterAddress(bytes32 feedId) returns (address)
  • version() returns (uint256)

As leituras do adaptador

  • decimals() returns (uint8)
  • description() returns (string)
  • version() returns (uint256)
  • latestRoundData() returns (uint80 roundId, int256 answer, uint256 startedAt, uint256 updatedAt, uint80 answeredInRound)
  • getRoundData(uint80 roundId) returns (uint80, int256, uint256, uint256, uint80)
  • latestAnswer() returns (int256)
  • latestTimestamp() returns (uint256)
  • latestRound() returns (uint256)
  • symbol() returns (string)

Nenhum dos dois endereços é impresso neste site. Resolver os endereços é como você os obtém da cadeia.

A resposta e suas casas decimais

Uma resposta é um inteiro de ponto fixo, não um número de ponto flutuante e não wei. Todo feed do conjunto de gênese carrega decimals = 8, então uma resposta de 415012345678 é 4150.12345678. O campo permite de 0 a 18 e é por feed, então leia-o do feed em vez de compilar 8 no seu consumidor.

javascript
// answer arrives as a decimal string, because it does not fit a JS number safely.
const { answer, decimals, price } = result;         // "415012345678", 8, "4150.12345678"
const scaled = BigInt(answer);                       // keep it integral
const human = Number(scaled) / 10 ** decimals;       // only for display

// price is the same number pre-formatted with exactly `decimals` digits.
// Never parseFloat(answer) and never compare two feeds without rescaling both.

Zero não é um preço

O contrato recusa uma resposta não positiva, então um zero nunca chega a uma rodada. Um zero que você lê veio portanto de outro lugar: um latestAnswer() legado num feed que nunca foi escrito, ou uma chamada a um endereço sem código, que tem sucesso e não devolve nada. Verifique roundId != 0, ou use latestRoundData(), que dá revert no lugar disso.

Por JSON-RPC

Três métodos, todos leituras simples sem chave e sem conta. Eles estão listados com todos os outros métodos na referência JSON-RPC; o que se segue é o que eles respondem para esta camada.

Params
none
Retorno
{ core, version, blockNumber, timestamp, publisher, owner, genesisStateHash, feeds: [FeedObject] }

The whole registry in one read, and the answer to "what assets are there". The node reads feeds(offset, 256) against the published state snapshot once per EVM block and memoises it, so a client polling the list costs about what one eth_call costs.

Params
[feed] - "ETH/USD", "ETH-USD", "eth-usd" or "0x<64 hex feedId>"
Retorno
one FeedObject, the shape pickle_prices lists

One feed. A name that is not a well-formed symbol or a 32-byte id, or one the chain does not carry, answers -32602 "unknown feed" - never an empty answer that reads as a price of zero.

Params
none
Retorno
{ configured, pair, contract, roundId, answer, price, decimals, updatedAt, observedAt, ageSecs, staleAfterSecs, staleOnchain, feedId, adapter, core }

ETH/USD alone, in the shape the first version of this layer served, with contract set to the feed's adapter. When the feed cannot be read it answers an object carrying an error field rather than failing, so a caller must check for it.

bash
curl -s $RPC_URL -H 'content-type: application/json' \
  -d '{"jsonrpc":"2.0","id":1,"method":"pickle_price","params":["AAPL-USD"]}'

# -> {"jsonrpc":"2.0","id":1,"result":{
#      "symbol":"AAPL/USD","feedId":"0x...","adapter":"0x...","decimals":8,
#      "roundId":184,"answer":"23144000000","price":"231.44000000",
#      "updatedAt":1758470400,"observedAt":1758470396,
#      "status":2,"statusName":"closed","source":2,"sourceName":"pyth",
#      "ageSecs":51840,"staleAfterSecs":330,"staleOnchain":false, ... }}
#
# staleOnchain is FALSE at fourteen hours old, because the market is closed.

O objeto feed

CampoValue
symbol"ETH/USD"the canonical spelling
feedId0x + 64 hexkeccak256 of the symbol
adapterchecksummed addressthis feed's Chainlink-shaped face; the one to point a consumer at
decimals8read it rather than assuming it
roundIduint0 means never written. answer, price, updatedAt and observedAt are then null
answerinteger as a stringthe fixed-point integer. 415012345678 at 8 decimals is 4150.12345678
pricedecimal stringthe same number formatted with exactly `decimals` fractional digits. A convenience, never a float
updatedAtunix secondsthe timestamp of the block that wrote the round
observedAtunix secondswhen the source saw the price. Usually LEADS updatedAt
status / statusName0 unknown, 1 open, 2 closed, 3 halted3 is reserved and never published. Check this before you check the age
source / sourceName0 unknown, 1 exchanges-median, 2 pythwhich method produced this round
ageSecsnow - updatedAtwall clock at the request, not at the seal. null on an unwritten feed
staleAfterSecs30, or heartbeat + 30flat on an everyBlock feed; a deviation feed gets its heartbeat plus the default, so a feed that has not moved is not stale until it has missed a heartbeat
staleOnchainbooleanageSecs > staleAfterSecs AND the status is not closed. An unwritten feed is always true
policy / policyName0 paused, 1 everyBlock, 2 deviationwith deviationBps, heartbeatSecs and maxStepBps beside them
capacityring lengthhow many rounds back getRoundData can still reach
Estas leituras consomem do orçamento de leituras caras

All three methods run on the blocking pool and draw on the same token bucket as eth_call, eth_estimateGas and eth_getLogs: they simulate against the state snapshot. Exhausting it answers -32005 "rate limit exceeded for expensive read methods".

The registry read is memoised on the block tip, so the first caller in a block pays for the catalog decode and the rest do not. Leader and replica answer identically because both read the published snapshot rather than live execution state.

A partir do serviço de oráculo

Esta API não é publicada num host público

The oracle service answers on port 3005 for reads and 3006 for the batch the node polls. The deployment binds 3005 to loopback and leaves 3006 unpublished, and no public vhost proxies either one.

Treat the JSON-RPC price methods as the public read surface. The routes below matter when you run the stack yourself, and when you need the per-venue detail the chain does not carry.

O que ela acrescenta em relação à cadeia é o detalhe do cálculo: qual mercado estava atualizado, qual entrou na mediana, a que distância cada um ficou dela, e por que um feed não está publicando. Quando um preço falta, é aí que está a razão.

/v1/prices

GET

Every feed's FeedView, with generatedAtMs. The service-side equivalent of pickle_prices, plus the per-source detail: which venue was fresh, which was included in the median, each one's age, spread and delivery lag.

/v1/price/{symbol}

GET

One feed. The symbol may be ETH/USD, ETH-USD, eth-usd, the percent-encoded slash, or 0x + 64 hex. Anything else, or a feed that does not exist, answers 404 {"error":"unknown feed"}.

/v1/stream

GET

Server-sent events. An immediate prices event with every feed, then one per change carrying only the feeds that changed, plus an onchain event per new block listing the feeds whose round advanced. Bursts are coalesced and a keepalive comment is sent when nothing has moved.

/v1/eth-usd and /v1/eth-usd/stream

GET

The ETH/USD view and its stream in the shape the first version of this service served, kept for its consumers. The same data as /v1/price/ETH-USD under the original key names.

/v1/sources

GET

Operational rather than price data: every venue with its connection state, per-product message counts, reconnects and last message time, the Pyth client's state and per-feed accept and reject counters, and the chain poller's own status. This is where you look when a feed is stale and you want to know which leg failed.

/v1/contract

GET

The registry's address, owner, publisher and feed count as read from the chain, the two ABIs when the build artefacts are present, every feed's adapter, and the event topic hashes - recomputed locally so they are served even without the ABI files.

/v1/pyth/audit/{symbol}

GET

The raw accepted updates for one feed, up to 256 deep, with their publish times and slots, plus the reject counters by reason. The audit trail behind a price.

/health and /ready

GET

/health is 200 unless a worker thread has died. /ready is 503 while starting, when no feed is fresh, when the chain is unreachable or the registry has gone stale on chain - and 200 with a pyth_unauthorized warning when the credential is missing, because that is a degraded service rather than an unready one.

Duas portas, dois públicos. A API de leitura responde na 3005; o lote que o nó consulta é um ouvinte separado na 3006, carregando um HMAC dos bytes exatos do corpo em X-Pickle-Batch-Hmac, e pedir /v1/publish ao ouvinte público responde 404 em vez de admitir que a rota existe. Todo corpo de erro é uma string fixa: sem caminho, sem origem a montante, sem texto de exceção.

O que uma visão de feed carrega além da cadeia

CampoValue
stale + reasonboolean and a codeno_sources, too_few_sources, starting, market_closed, cross_check_diverged, or a Pyth reason - state, age, lag, no_data
market{ isOpen, schedule, hermesIsOpen, nextOpen, nextClose, nextTransition }present on all 33 feeds, since every one carries a Pyth id; null only on a feed configured without one. The schedule is the raw schedule string
sourcesone row per venue, plus the Pyth rowprice, kind (mid or last), observedAtMs, ageMs, fresh, included, spreadBps, lagMs, state
degradedbooleanthe median was taken on exactly minSources venues; one more drop-out and the feed stops publishing
dispersed + dispersionBpsboolean and an integerthe spread between the included venues, and whether it exceeded the limit even after the outlier was dropped
outlierDroppedvenue name or nullwhich venue was excluded from this median
crossCheckBps + crossCheckDivergedinteger and booleanhow far the exchange median sits from the Pyth price for the same feed
lastKnown{ price, observedAtMs, ageMs } or nullthe last good answer while the feed is stale. Shown for diagnosis - it is not republished on chain
onchainthe chain's own row for this feedpolled once a second, so the service can show what actually landed beside what it computed

Defasagem

Leia o status antes da idade

Read status first, then staleness. A closed market's last print is the correct price for as long as the market is closed, and a naive "reject anything older than N minutes" check rejects every equity every weekend.

CasoRegra
everyBlock feedstale after 30 sORACLE_STALE_AFTER_SECS on the node, matching the service's setting of the same name
deviation feedstale after heartbeat + 30 s90 s on the crypto feeds, 330 s on every real-world feed. A feed that has not moved is not late
status closednever stale by agestaleOnchain stays false while the market is closed, however old the round is
roundId 0always stalenever written. answer and price are null, and the adapter's latestRoundData reverts

staleOnchain é o nó aplicando essas regras por você, no relógio de parede da sua requisição em vez do relógio do selamento. É uma comodidade: um consumidor dentro de um contrato não tem esse campo e precisa comparar updatedAt com a sua própria tolerância, que é a verificação que o exemplo acima faz.

updatedAt é o sinal honesto em todos os casos, porque ele simplesmente para de avançar quando a publicação para. Não há verificação de idade on-chain em que se apoiar: There is deliberately no on-chain age check on observedAt. The node replays its write-ahead log with the restart-time timestamp, so a rule of the form block.timestamp - observedAt <= maxAge would fail every replayed update. Freshness is enforced by the publisher, which does not submit a stale aggregate, and by you, through updatedAt - which simply stops advancing when publication stops.

O serviço reporta uma reason ao lado de stale, e as razões merecem ser tratadas separadamente: too_few_sources significa que mercados caíram, cross_check_diverged significa que os mercados e a segunda fonte discordam e o feed está deliberadamente em silêncio, market_closed significa que não há absolutamente nada errado. Como cada uma surge está em Como um preço é formado.

Horários de mercado

Each feed with a Pyth leg carries a schedule: a time zone, seven day patterns starting Monday, and a list of dated overrides for holidays and half-days. It is resolved against the real time-zone database, so a market opens at 09:30 local whatever the daylight-saving offset that day.

SeçãoGramática
Time zoneAmerica/New_Yorkthe first section; every schedule in the catalog uses it
A dayO, C, or HHMM-HHMMO is the whole day, C is closed. Ranges are half-open and joined with & for a day with a break
OverridesMMDD/speca dated exception using the same day grammar - 1225/C for a holiday, 1127/0930-1300 for a half-day
FeedsCalendário
Crypto and the energy indicesO,O,O,O,O,O,Oopen every day, all day, with no overrides
The nine equities0930-1600 Monday to Friday, C,C at the weekendwith the exchange holiday and half-day list as overrides
EUR/USD, GBP/USD, USD/JPY, USD/CHFcontinuous to 17:00 Friday, closed Saturday, reopening 17:00 Sundaytwo dated overrides shorten the sessions around the end of December
XAU/USD, XAG/USD, USD/CNHa daily 17:00-18:00 break, closed Saturday, reopening Sunday eveningthe metals carry the longer holiday list

The upstream also reports whether the market is open right now. That flag wins while its poll is fresh and no scheduled transition has passed since - it knows about a halt or an unlisted holiday that the schedule does not. Otherwise the schedule decides.

The status machinery applies to a feed whose price comes from the second source, which is every real-world feed. A feed publishing an exchange median reports status open, and that is consistent rather than a gap: all thirteen of them are crypto pairs whose schedule is open every day, all day.

Um mercado fechado não é um feed defasado

The price that stands while a market is closed is the one seen at the close, never anything republished afterwards. It is published with status closed and reason market_closed, and it is republished on a one-hour heartbeat rather than on the feed's normal cadence.

A trava de reabertura. Going from closed back to open needs one accepted update whose publish time is later than the newest one seen up to the reopen. Until that arrives the feed keeps reporting closed and the standing price, so a stale pre-close print is never labelled as an open-market quote. A restart while the market is closed adopts the first accepted update as the standing price, because there was no close to observe.

Saltos são esperados. The first print after a reopen legitimately gaps. The contract's step check is bypassed whenever the status changed, so that print lands instead of being skipped as an implausible move.

Para um consumidor isso quer dizer três coisas. Um feed de ação pode ficar legitimamente inalterado por dois dias e meio sem estar defasado. Uma verificação de atualidade ingênua rejeita todo feed do mundo real todo fim de semana, e cada um deles toda noite. E uma posição que não deve ser liquidada sobre um preço que ninguém está fazendo agora deveria ler status e recusar-se a agir enquanto ele valer 2, em vez de agir sobre um preço em pé, correto mas imóvel.

javascript
const feed = result;                       // one feed object

if (feed.roundId === 0) throw new Error("never written");
if (feed.statusName === "unknown") throw new Error("status not established");

const closed = feed.statusName === "closed";
if (!closed && feed.staleOnchain) throw new Error("stale while open");

// closed === true is a valid, current price for a market that is not trading.
// Decide deliberately whether your product acts on it.

Rodadas, histórico e pulos

Rounds live in a fixed-size ring per feed rather than an append-only history. Round r sits at index r % capacity, is readable while latestRound - r < capacity, and is overwritten afterwards.

getRoundData on an evicted round reverts with "No data present", not with a zero answer. A feed with capacity 1,024 keeps its last 1,024 rounds and no more, so an indexer that wants full history reads the FeedUpdated logs rather than paging the ring.

updateMany never reverts on a bad item. One stale or out-of-range feed in a batch of sixty must not cost the other fifty-nine their round, so a bad item is skipped with a FeedSkipped(feedId, reason) log and the rest are written. Only a malformed batch - mismatched array lengths, over maxBatch, or a sender that is not the publisher - reverts.

RazãoSignificado
1unknown feedno feed registered under that id
2pausedthe feed's policy is paused
3answer out of rangenot strictly positive, or wider than int128
4observedAt in the futurebeyond block.timestamp + futureTolerance
5observedAt regressedolder than the feed's last observation; the round would go backwards in time
6step too largea move wider than the feed's maxStepBps - 2,000 bps on the equities and energy indices, 1,000 on the metals, 500 on FX, disabled on everything crypto. Bypassed whenever the status changed, so a reopening gap still lands

Um item pulado só é visível como um log FeedSkipped: a rodada não avança e a resposta anterior permanece. Um consumidor que observa um feed deveria portanto observar FeedUpdated com o identificador do feed como tópico indexado - é o evento que o adaptador não emite - e tratar um longo silêncio pelo que ele é, em vez de esperar um erro que nunca chega.