애플리케이션 API

이것들은 무엇인가

체인의 인터페이스는 JSON-RPC입니다. 이 페이지들에 있는 모든 것은 어떤 애플리케이션이 자기를 위해 만들고 나서 닿을 수 있게 남겨 둔 것입니다. 시퀀서의 로그 스풀 위의 Postgres 인덱스, 키를 들고 있는 프로세스, 게임 루프입니다. 편리하고, 퍼스트파티이며, 권위 있는 것은 아닙니다.

어디서 응답하는가

이 서비스들 중 자기 호스트명을 가진 것은 하나도 없습니다. 각각은 어느 프런트엔드 출처 위의 /api/ 마운트이며, 그래서 공개 베이스는 서비스의 사실이 아니라 nginx의 사실입니다. 사이트를 옮기는 배포는 그 API도 함께 옮기고, 안쪽의 경로는 그대로입니다. 직접 운영하는 스택에서는 같은 서비스들이 루프백에서, 각자의 페이지가 적어 둔 포트에서 답합니다.

인증

넷 중 어느 것도 인증을 받지 않으며, 중요한 차이는 인증 없이 각자 무엇을 할 수 있는가입니다.

• 익스플로러, DEX API, 아케이드는 인증을 받지 않습니다. 읽기 전용이고 공개입니다. 익스플로러는 모든 POST에 405로 답하고, DEX API는 GET 외의 어떤 동사도 구현하지 않습니다.
• Faucet도 인증을 받지 않으면서 체인에 씁니다. 그 할당량이 엄격하고 무엇이 서명되기 전에 미리 잡히는 이유가 전적으로 그것입니다.

브라우저에서 호출하기

CORS는 서비스마다 설정되어 있고 서로 일치하지 않으므로, 먼저 확인할 것은 여러분 출처의 페이지가 원하는 그것을 아예 호출할 수 있는지입니다.

• DEX API는 CORS 헤더를 보내지 않고 OPTIONS 핸들러도 없습니다. 브라우저에서 출처를 넘는 fetch는 곧바로 실패하는데 서버에서 보낸 같은 요청은 성공하며, 그것이 네트워크 탓으로 돌려지는 버그의 모양입니다. 프록시하거나 백엔드에서 부르십시오.
• 익스플로러와 Faucet은 허용 목록을 둡니다. 목록에 없는 출처의 사전 요청은 403으로 거절되며, 적어도 분명한 답입니다.
• 아케이드는 업그레이드에서 Origin을 확인하고 핸드셰이크 전에 403으로 거절하므로, 소켓이 열렸다가 조용해지는 대신 아예 열리지 않습니다.

한도와 페이징

요청 속도를 제한하는 것은 익스플로러뿐입니다. 나머지 셋은 대신 제한, 할당량, 또는 연결 상한에 기댑니다.

페이징이 있는 곳에서는 커서가 아니라 limit과 offset입니다. 그것은 머리에서 자라는 목록이 두 페이지 사이에 발밑에서 밀린다는 뜻입니다. 이미 본 행이 다시 나타나고, 보지 못한 행이 건너뛰어질 수 있습니다. 완전해야 하는 것이라면 offset이 아니라 여러분이 통제하는 키 - 블록 번호나 해시 - 로 페이징하십시오.

관례

// The shape of a careful call against any of these: a timeout, a status check
// before the body, and a big-integer parse of anything that looks like money.
const res = await fetch(`${BASE}/pools`, { signal: AbortSignal.timeout(5000) });
if (!res.ok) throw new Error(`pools: ${res.status}`);          // never the message
const { pools } = await res.json();                              // an object, not an array
const reserve0 = BigInt(pools[0].reserve0);                      // a decimal string

하나가 죽었을 때

넷은 저마다 다르게 실패하며, 그중 바깥에서 실패처럼 보이는 것은 하나뿐입니다.

• DEX API는 503 index not ready로 답합니다. 데이터베이스에 닿을 수 없거나 인덱서가 한 번도 돌지 않아 테이블이 없을 때입니다. 그쪽이 정직한 경우입니다. 정직하지 않은 쪽은 멈춘 인덱서입니다. 모든 라우트가 도달했던 상태로 계속 답하고, 그것을 말해 주는 것은 /health의 lagBlocks뿐입니다.
• 익스플로러는 노드에 닿을 수 없어도 인덱스를 계속 제공합니다. 실시간 읽기가 필요한 부분 - 잔액, 네임 서비스 레코드, 수수료 라우터의 미지급 잔액 - 은 오류를 내는 대신 null이나 부재로 돌아옵니다. /stats의 indexLag 필드가 지켜볼 수치입니다.
• Faucet은 노드가 응답하지 않을 때 502로 답하며, 아무것도 서명되지 않은 상태입니다. 503은 자금이 떨어졌거나 드립이 revert했다는 뜻입니다.
• 아케이드의 /ready는 노드로 가는 소켓이 죽었을 때, 또는 마지막으로 적용한 미니블록이 다섯 초보다 오래되었을 때 503으로 답합니다. 대신 도착을 재면 멈춰 버린 프로세스가 아무것도 움직이지 않으면서 200으로 답할 수 있었습니다.

다른 곳에 문서화된 것

• The node. Chain state, transactions, logs and subscriptions are JSON-RPC and are documented in this reference's own RPC pages, not here.
• Contracts. What the pools, the faucet and the games actually do on chain - their functions, their events and their revert reasons - is the contract reference.
• Prices. Several answers here carry a dollar figure or a price snapshot. Those fields come from a layer this page does not own; read its own reference for what the number means, how old it is and when it is absent.