Stellar-rpc: Document the queryEvents beta RPC method by urvisavla · Pull Request #2922 · stellar/stellar-docs

urvisavla · 2026-10-19T21:58:48Z

Summary

Adds a reference page for queryEvents, a new Stellar RPC method that only the archive RPC node serves. The archive node is in beta (stellar-rpc tag archive-node-beta), and the method is not part of any general RPC release. The page says so in a caution block at the top.

Known limitations

The method is deliberately kept out of the main OpenRPC spec, static/stellar-rpc.openrpc.json. Third parties consume that file, and a beta method that can change without notice does not belong in it. The method page still needs to look like every other method page, which the RpcMethod component renders from a spec. So this PR adds a second spec:

New source directory openrpc/src/stellar-rpc-beta/ holds the method, its parameters, schemas, and examples.
The build script gains a componentsFrom option. The beta service reuses every component of the main spec, so the method references shared schemas such as Event directly. A beta-local file with the same name overrides the shared one in the beta spec only.
The build writes static/stellar-rpc-beta.openrpc.json, and the validate script checks it. The page imports that file.

When queryEvents reaches general availability:

Move the files under openrpc/src/stellar-rpc-beta/ into the matching directories under openrpc/src/stellar-rpc/. Beta-local overrides such as Event and QueryFormat need to be merged with, or replace, the shared versions.
Change the import in queryEvents.mdx to @site/static/stellar-rpc.openrpc.json.
Remove the beta caution from the page and the beta mentions in the methods index and the getEvents note.
Remove the stellar-rpc-beta service from openrpc/scripts/build.mjs and validate.mjs if no other beta method remains.

openrpc/README.md records the same steps.

🤖 Generated with Claude Code

queryEvents is only served by the archive RPC node (stellar-rpc tag archive-node-beta). Keep it out of the main OpenRPC spec: add a stellar-rpc-beta spec that reuses the main spec's components, and render it on a new method page with the usual RpcMethod component. Also drop the deprecated inSuccessfulContractCall field from the shared Event schema, and make the spec build read only *.json files. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions · 2026-10-19T22:07:19Z

PR Preview: https://developers-pr-2922.previews.kube001.services.stellar-ops.com

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions · 2026-10-19T22:22:09Z

PR Preview: https://developers-pr-2922.previews.kube001.services.stellar-ops.com

Copilot

🟡 Changes recommended

Unresolved documentation and OpenRPC schema mismatches remain, including a stable Event compatibility issue.

4 open issues

What changed in this PR

Adds beta OpenRPC documentation and generated artifacts for the queryEvents RPC method.

Changes:

Adds beta schemas, examples, parameters, and generated specification.
Extends OpenRPC build and validation for shared beta components.
Adds documentation, routing, and beta maintenance guidance.

File	Summary
`static/stellar-rpc.openrpc.json`	Updates the stable generated specification.
`static/stellar-rpc-beta.openrpc.json`	Adds the generated beta specification.
`routes.txt`	Registers the new documentation route.
`openrpc/src/stellar-rpc/schemas/Event.json`	Updates the shared event schema.
`openrpc/src/stellar-rpc/examples/Events.json`	Updates stable event examples.
`openrpc/src/stellar-rpc-beta/schemas/QueryEvents.json`	Defines beta query and event schemas.
`openrpc/src/stellar-rpc-beta/methods/queryEvents.json`	Defines the beta RPC method.
`openrpc/src/stellar-rpc-beta/examples/QueryEvents.json`	Adds method examples.
`openrpc/src/stellar-rpc-beta/examplePairingObjects/QueryEventsPairs.json`	Pairs request and response examples.
`openrpc/src/stellar-rpc-beta/contentDescriptors/QueryEvents.json`	Defines method parameters.
`openrpc/scripts/validate.mjs`	Validates the beta specification.
`openrpc/scripts/build.mjs`	Supports shared beta component builds.
`openrpc/README.md`	Documents beta specification maintenance.
`docs/data/apis/rpc/api-reference/methods/README.mdx`	Adds the method index entry.
`docs/data/apis/rpc/api-reference/methods/queryEvents.mdx`	Adds the beta method reference page.

_{Review effort: Lite}

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions · 2026-10-20T17:16:51Z

PR Preview: https://developers-pr-2922.previews.kube001.services.stellar-ops.com

Co-authored-by: Molly Karcher <mdarkar@gmail.com>

github-actions · 2026-10-20T21:21:10Z

PR Preview: https://developers-pr-2922.previews.kube001.services.stellar-ops.com

github-actions · 2026-10-21T17:45:28Z

PR Preview: torn down

Port of 8255fe9 to the Mintlify tree. Refs #2922 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Point Confidential Token resources to OpenZeppelin's stable release (#2915) * Fix broken Confidential Token repo link on Privacy page OpenZeppelin deleted the feat/confidential-verifier-ultrahonk branch. The code now lives in packages/confidential on main. - Link the package, the deployment guide and examples, and the design overview. - Mark the demo as a developer preview. It still targets the old branch. - Point to the stellar-contracts library for the Stellar implementation. Refs #2914 * Point Confidential Token resources to OpenZeppelin's stable release OpenZeppelin released the confidential token in stellar-contracts v0.8.0. - Pin the Privacy page links to v0.8.0. Add crates.io, release notes, and the OpenZeppelin docs page. - Replace the developer-preview caution. The v0.8.0 audit covers the token, but proofs are not yet zero-knowledge. - Add a Confidential Token entry to the OpenZeppelin page and add confidential/ to the repository tree. - Remove "Coming Soon". Governor shipped in v0.7.0, so it moves to Utilities. Refs #2914 * Pin the stellar-confidential crates.io link to 0.8.0 * Describe the Confidential Token as a wrapper around a SEP-41 token The v0.8.0 interface exposes confidential_balance and confidential_transfer, not the SEP-41 balance and transfer methods. (cherry picked from commit fc4b3c9) * pr-preview: allow maintainer-approved previews for bot PRs (#2923) Members can apply the preview-approved label to build a preview for a PR opened by the stellar-triage-bot App. Needs stellar/actions#119. Refs stellar/ops#4953. Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> (cherry picked from commit a55db9e) * Stellar-rpc: Document the queryEvents beta RPC method (#2922) queryEvents is only served by the archive RPC node (stellar-rpc tag archive-node-beta). Keep it out of the main OpenRPC spec. Also drop the deprecated inSuccessfulContractCall field from the shared Event schema. (cherry picked from commit 8255fe9) * ci: add manual build of legacy-docs image for legacydocs.stellar.org (#2935) * ci: add manual build of legacy-docs image for legacydocs.stellar.org Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * ci: don't persist checkout credentials into the legacy docs build context Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> (cherry picked from commit 17f2d69) * chore: reword the legacy docs banner Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> * docs: point the legacy README at main's last Docusaurus commit Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com> --------- Co-authored-by: Kaan Kacar <kaankacar02@gmail.com> Co-authored-by: Jonathan Eid <sevenmelee@gmail.com> Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com> Co-authored-by: urvisavla <urvi.savla@stellar.org>

) Replaces the Docusaurus site with Mintlify's converted tree (base bcec501), with tooling trimmed to prettier, husky, redocly, the OpenRPC build, and the mint CLI. Commits that landed on main after bcec501 were ported by hand. Ported: Refs #2448 Refs #2671 Refs #2672 Refs #2727 Refs #2827 Refs #2828 Refs #2837 Refs #2856 Refs #2857 Refs #2869 Refs #2871 Refs #2878 Refs #2880 Refs #2881 Refs #2885 Refs #2886 Refs #2890 Refs #2892 Refs #2893 Refs #2895 Refs #2900 Refs #2901 Refs #2902 Refs #2903 Refs #2905 Refs #2912 Refs #2913 Refs #2915 Refs #2918 Refs #2922 Merged into the branch: Refs #2936 Refs #2937 Refs #2938 Refs #2940 Co-authored-by: alexistabak-cpu <alexis.tabak@stellar.org> Co-authored-by: Emir Ayral <73669654+emirayral@users.noreply.github.com> Co-authored-by: John Wooten <60260750+JFWooten4@users.noreply.github.com> Co-authored-by: Kaan Kacar <kaankacar02@gmail.com> Co-authored-by: Leigh <351529+leighmcculloch@users.noreply.github.com> Co-authored-by: maz <42838313+mmazco@users.noreply.github.com> Co-authored-by: Michael Lip <51033404+theluckystrike@users.noreply.github.com> Co-authored-by: Scopuly <39069225+Scopuly@users.noreply.github.com> Co-authored-by: stellar-triage-bot[bot] <333411864+stellar-triage-bot[bot]@users.noreply.github.com> Co-authored-by: Steph <91382964+oceans404@users.noreply.github.com> Co-authored-by: urvisavla <urvi.savla@stellar.org> Co-authored-by: water-k-max <codexsourcelogos@gmail.com> Co-authored-by: Wlademyr Mendes <wlademyr.mendes@gmail.com> Co-Authored-by: Claude Opus 5.5 <noreply@anthropic.com>

urvisavla and others added 2 commits October 19, 2026 14:58

Drop the queryEvents note from the getEvents page

16a466d

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions Bot added the preview Preview builds for PRs by SDF employees. label Oct 19, 2026

Drop the paging pseudocode from the queryEvents page

d0cca72

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions Bot added preview Preview builds for PRs by SDF employees. and removed preview Preview builds for PRs by SDF employees. labels Oct 19, 2026

urvisavla requested a lite review from Copilot October 19, 2026 23:16

Copilot started reviewing on behalf of urvisavla October 19, 2026 23:17

View session

Copilot AI reviewed Oct 19, 2026

View reviewed changes

Comment thread docs/data/apis/rpc/api-reference/methods/queryEvents.mdx Outdated

Comment thread openrpc/src/stellar-rpc-beta/schemas/QueryEvents.json

Comment thread openrpc/src/stellar-rpc-beta/schemas/QueryEvents.json

Comment thread openrpc/src/stellar-rpc/schemas/Event.json

Reject empty and unknown filter fields in the queryEvents beta schema

eca0ec9

Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com>

github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Oct 20, 2026

urvisavla changed the title ~~Document the queryEvents beta RPC method~~ Stellar-rpc: Document the queryEvents beta RPC method Oct 20, 2026

github-actions Bot added the preview Preview builds for PRs by SDF employees. label Oct 20, 2026

urvisavla added this to Platform Scrum Oct 20, 2026

github-project-automation Bot moved this to To Do in Platform Scrum Oct 20, 2026

mollykarcher reviewed Oct 20, 2026

View reviewed changes

Update docs/data/apis/rpc/api-reference/methods/README.mdx

1d1d7da

Co-authored-by: Molly Karcher <mdarkar@gmail.com>

github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Oct 20, 2026

urvisavla and others added 2 commits October 20, 2026 14:15

Update docs/data/apis/rpc/api-reference/methods/queryEvents.mdx

2685569

Co-authored-by: Molly Karcher <mdarkar@gmail.com>

Update docs/data/apis/rpc/api-reference/methods/queryEvents.mdx

362656f

Co-authored-by: Molly Karcher <mdarkar@gmail.com>

github-actions Bot added the preview Preview builds for PRs by SDF employees. label Oct 20, 2026

mollykarcher approved these changes Oct 21, 2026

View reviewed changes

urvisavla merged commit 8255fe9 into stellar:main Oct 21, 2026
7 checks passed

urvisavla deleted the docs/rpc-queryevents-beta branch October 21, 2026 17:45

github-project-automation Bot moved this from To Do to Done in Platform Scrum Oct 21, 2026

github-actions Bot removed the preview Preview builds for PRs by SDF employees. label Oct 21, 2026

ElliotFriend pushed a commit that referenced this pull request Oct 21, 2026

Stellar-rpc: Document the queryEvents beta RPC method

e1bd67f

Port of 8255fe9 to the Mintlify tree. Refs #2922 Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

This was referenced Oct 22, 2026

build: migrate developers.stellar.org from Docusaurus to Mintlify #2941

Merged

Chore: sync legacy-docs with main's last Docusaurus commits #2943

Merged

Navigation Menu

Repository navigation

Stellar-rpc: Document the queryEvents beta RPC method - #2922

Stellar-rpc: Document the queryEvents beta RPC method#2922
urvisavla merged 7 commits into
stellar:mainfrom
urvisavla:docs/rpc-queryevents-beta

urvisavla commented Oct 19, 2026

Uh oh!

github-actions Bot commented Oct 19, 2026

Uh oh!

github-actions Bot commented Oct 19, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

Uh oh!

github-actions Bot commented Oct 21, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

urvisavla commented Oct 19, 2026

Summary

Known limitations

Uh oh!

github-actions Bot commented Oct 19, 2026

Uh oh!

github-actions Bot commented Oct 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

🟡 Changes recommended

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Oct 20, 2026

Uh oh!

Uh oh!

github-actions Bot commented Oct 21, 2026

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants