[docs-agent] Add docs for 5 new Bitcoin-ecosystem chains and UTXO REST API#1281
Open
JackReacher0807 wants to merge 2 commits intomainfrom
Open
[docs-agent] Add docs for 5 new Bitcoin-ecosystem chains and UTXO REST API#1281JackReacher0807 wants to merge 2 commits intomainfrom
JackReacher0807 wants to merge 2 commits intomainfrom
Conversation
…T API Adds JSON-RPC chain pages and OpenRPC specs for Bitcoin Cash (mainnet/testnet), Litecoin (mainnet/testnet), and Dogecoin (mainnet), each surfacing the same 38 Bitcoin-style methods that already live in src/openrpc/chains/_components/bitcoin/methods.yaml. Also adds a new src/openapi/utxo/utxo.yaml OpenAPI 3.1 spec covering the 12 Trezor Blockbook REST endpoints (block-index, tx, tx-specific, address, xpub, utxo, block, sendtx GET+POST, tickers-list, tickers, balancehistory) for all 7 supported UTXO networks (Bitcoin Mainnet, Bitcoin Testnet 4, Bitcoin Cash mainnet/testnet, Litecoin mainnet/testnet, Dogecoin Mainnet). Wires the UTXO API endpoints under each chain section in docs.yml. Refs DOCS-71
🔗 Preview Mode
|
🔍 Link CheckStatus: ❌ Failed Summary
Broken links (129) — click to expandErrors per inputErrors in ./content/wallets/wallet-integrations/privy/jwt-auth-migration.mdx
Errors in ./content/tutorials/snapshots/worldchain.mdx
Errors in ./content/api-reference/litecoin/litecoin-api-quickstart.mdx
Errors in ./content/api-reference/data/webhooks/custom-webhooks-quickstart/custom-webhooks-quickstart.mdx
Errors in ./content/api-reference/bitcoincash/bitcoincash-api-overview.mdx
Errors in ./content/api-reference/dogecoin/dogecoin-api-faq.mdx
Errors in ./content/api-reference/bitcoincash/bitcoincash-api-quickstart.mdx
Errors in ./content/api-reference/starknet/starknet-api-faq.mdx
Errors in ./content/api-reference/base/base-api-faq.mdx
Errors in ./content/api-reference/arbitrum-nova/arbitrum-nova-deprecation-notice.mdx
Errors in ./content/api-reference/litecoin/litecoin-api-overview.mdx
Errors in ./content/api-reference/bitcoincash/bitcoincash-api-faq.mdx
Errors in ./content/api-reference/litecoin/litecoin-api-faq.mdx
Errors in ./content/tutorials/smart-wallets/learn-account-abstraction/introduction-to-account-abstraction.mdx
Errors in ./content/api-reference/dogecoin/dogecoin-api-overview.mdx
Errors in ./content/wallets/wallet-integrations/privy/signer-migration-overview.mdx
Errors in ./content/api-reference/dogecoin/dogecoin-api-quickstart.mdx
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2ab2dae346
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
SahilAujla
approved these changes
May 5, 2026
Codex flagged that Blockbook explicitly requires the trailing slash on POST /api/v2/sendtx/ (per upstream docs: 'NB: the / symbol at the end is mandatory.'). Generated clients following the no-slash spec literally would route-miss on the actual endpoint. Update the path key in src/openapi/utxo/utxo.yaml to include the trailing slash and disable the Redocly no-path-trailing-slash rule globally so the linter does not contradict upstream behavior. Refs DOCS-71 Requested-by: @SahilAujla
0xmts
approved these changes
May 5, 2026
dslovinsky
approved these changes
May 5, 2026
| openapi: {} | ||
| rules: | ||
| "security-defined": off # APIs use API key in the URL path, not headers/query/cookie | ||
| "no-path-trailing-slash": off # Blockbook's POST /api/v2/sendtx/ requires a mandatory trailing slash; the rule conflicts with upstream behavior |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds docs for 5 new Bitcoin-ecosystem chains launching this Thursday (Bitcoin Cash mainnet/testnet, Litecoin mainnet/testnet, Dogecoin mainnet) and a new UTXO REST API spec used across all 7 supported UTXO networks (the 5 above plus Bitcoin Mainnet and Bitcoin Testnet 4).
JSON-RPC docs
src/openrpc/chains/{bitcoincash,litecoin,dogecoin}/<chain>.yaml. Each$refs the existingsrc/openrpc/chains/_components/bitcoin/methods.yamlso the 38 Bitcoin-style methods (getblock,sendrawtransaction, etc.) appear identically across the new chains. Confirmed by the requester that all 38 methods are available on all 5 new chains.content/api-reference/{bitcoincash,litecoin,dogecoin}/:<chain>-api-quickstart.mdx,<chain>-api-faq.mdx,<chain>-api-overview.mdx, mirroring the existing Bitcoin pages.content/docs.ymlin alphabetical order: Bitcoin Cash between Bitcoin and Blast, Dogecoin between Degen and Fantom, Litecoin between Linea and Lumia.UTXO REST API
src/openapi/utxo/utxo.yamlcovering the 12 Trezor Blockbook REST endpoints the requester confirmed are exposed:GET /api/v2/block-index/{block_height}GET /api/v2/tx/{txid}GET /api/v2/tx-specific/{txid}GET /api/v2/address/{address}GET /api/v2/xpub/{xpub}GET /api/v2/utxo/{descriptor}GET /api/v2/block/{block}GET /api/v2/sendtx/{hex}andPOST /api/v2/sendtxGET /api/v2/tickers-listGET /api/v2/tickersGET /api/v2/balancehistory/{address}{network}server variable:bitcoin-mainnet,bitcoin-testnet4,bitcoincash-mainnet,bitcoincash-testnet,litecoin-mainnet,litecoin-testnet,dogecoin-mainnet. Server URL pattern follows the JSON-RPC one (https://{network}.g.alchemy.com/v2/{apiKey}) per the requester's "same host" answer, so each path resolves to e.g.https://bitcoincash-mainnet.g.alchemy.com/v2/{apiKey}/api/v2/tx/{txid}. Please confirm this composition is what node-gateway is exposing, since I couldn't verify against a live endpoint pre-launch — if the UTXO REST is mounted without the API key in the path, the server URL needs to be adjusted tohttps://{network}.g.alchemy.com(or wherever it actually lives).docs.ymlas- api: UTXO API Endpoints; api-name: utxowithflattened: true, so users browsing Bitcoin / Bitcoin Cash / Litecoin / Dogecoin all see the UTXO endpoints under that chain.Validation
pnpm run generate:rpcandpnpm run validate:rpc: both pass cleanly with the new chain specs.pnpm run validate:rest: 0 errors. TheWoohoo! Your API description is valid.line appears for every spec including the newutxo.yaml. Existing warning counts in other specs are unchanged.Daikon coordination
These chain specs and the new UTXO OpenAPI are landing manually because Daikon's chain-config update for these 5 chains was not yet visible from the docs-agent side at PR time. Reviewers, please confirm with @dslovinsky that the upstream chain-config either already includes these chains or is landing in time for the Thursday launch, otherwise the next noon-EST Daikon Update Specs run could either clobber these new chain specs (if chain-config disagrees) or leave them unmanaged (if chain-config is silent on them). I did NOT add a chain-level
x-bot-ignorebecause it is per-method, not per-chain — if reviewers want temporary protection while Daniel's PR lands, happy to push a follow-up that adds explicit method-level guards.Open questions / things to double-check
utxo.yamlserver URL composition — confirm the/v2/{apiKey}/api/v2/...path is correct._components/bitcoin/methods.yamlare Bitcoin-mainnet-specific (real BTC block hashes, real BTC txids). Reusing them for BCH/LTC/DOGE is structurally sound but the example values won't match those chains. If we want chain-specific examples, that's a follow-up — happy to either spin a per-chain_components/<chain>/methods.yamlor thread chain-agnostic example data through.Linear
DOCS-71 — https://linear.app/alchemyapi/issue/DOCS-71/docs-for-5-new-bitcoin-ecosystem-chains-bch-ltc-doge-utxo-api