Skip to content

docs: remove getOrders from the orderbook precompile reference#234

Draft
claude[bot] wants to merge 1 commit into
mainfrom
remove-getorders-precompile-docs
Draft

docs: remove getOrders from the orderbook precompile reference#234
claude[bot] wants to merge 1 commit into
mainfrom
remove-getorders-precompile-docs

Conversation

@claude

@claude claude Bot commented Jul 6, 2026

Copy link
Copy Markdown

Requested by Alex Brezas · Slack thread

Before

The orderbook precompile reference documented a getOrders(bytes32 orderbookId, bytes32[] orderIds) eth_call read, and the API-reference pages mentioned it as one of the precompile's read-only methods. The method is being removed from the node (podnetwork/pod#1397): it duplicated the RPC read path and had returned unusable data (a remainingBase of ~2^256 for any order not fully filled, and a startTs that echoed endTs) since podnetwork/pod#403 landed in Dec 2025.

After

The docs no longer describe getOrders on the precompile. Order state and history reads point at the existing RPC read path instead — ob_getOrders and the Read market data guide — consistent with how the rest of the page already references order reads. Balance reads (balanceOf, withdrawableBalance, getBalance) on the precompile are unchanged.

How

  • doc/api-reference/applications-precompiles/orderbook.md — removed the getOrders ABI entry and docblock; the intro now points order-state reads at the ob_ JSON-RPC endpoints; the order_id hint no longer lists getOrders.
  • doc/api-reference/README.md — dropped getOrders from the order-id hint.
  • doc/api-reference/json-rpc/openapi.yaml and doc/api-reference/.gitbook/assets/openapi.yaml — removed the getOrders bullet from the eth_call description.

Note: this PR only touches doc/api-reference/*; it does not overlap with #231 (which edits doc/protocol/orderbook.md). No SDK code (rust-sdk, ts-sdk, types, solidity-sdk, examples) referenced the precompile getOrders.

🤖 Generated with Claude Code

https://claude.ai/code/session_01A74BZVmHFAksnZWVaGBcgi


Generated by Claude Code

The getOrders eth_call method is being removed from the orderbook
precompile (podnetwork/pod): it duplicated the RPC read path and has
returned incorrect data since Dec 2025. Point readers at ob_getOrders
and the read-market-data guide for order state instead.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01A74BZVmHFAksnZWVaGBcgi
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant