Add API Migration Guide for Horizon to RPC #1247
Merged
+149
−0
Conversation
This file contains 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
|
Preview is available here: |
|
Preview is available here: |
|
Preview is available here: |
2 similar comments
|
Preview is available here: |
|
Preview is available here: |
2opremio
approved these changes
Feb 3, 2025
mollykarcher
reviewed
Feb 3, 2025
|
Preview is available here: |
|
Preview is available here: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What
Adds a guide mapping Horizon REST API endpoints to RPC JSON-RPC API methods.
Why
Provides developers a clear reference for transitioning between APIs, detailing method mappings and migration strategies.
There don't exist docs today that help a developer who is already using Horizon know what endpoints they should look to on the RPC. While the endpoints are intuitive to a degree any migration comes with a cost, and documentation that helps devs see the path is clear or not can help with adoption.
The doc will also make it pretty quickly clear to a dev if they are relying on features of Horizon that just aren't supported by the RPC, so may help those devs start earlier at identifying other products and solutions they will need to acquire or build.
Most of the content in this page being added is derived from a diagram @mollykarcher and @ire-and-curses drew:
There's not really a limit to how far or to what a migration guide could talk about. It could talk about operationally, or other aspects of the API such as pagination. But I think what's contained in this PR is at least a good starting point that should be impactful.