add rta and deprecation info to rpc docs #106
Open
Conversation
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
There was a problem hiding this comment.
Pull Request Overview
This PR enhances the X Layer RPC documentation by adding comprehensive Real-time API documentation and deprecation notices for outdated RPC methods. The changes provide developers with clear migration paths and highlight the new real-time capabilities that offer 20-30ms transaction confirmations.
- Added mainnet upgrade notice and deprecated RPC interface warnings for v0.8.0
- Introduced comprehensive Real-time API documentation with usage examples and performance benchmarks
- Updated ZKEVM RPC methods table with deprecation warnings and status indicators
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
Co-authored-by: Copilot <[email protected]>
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.
Mainnet Upgrade Notice
Added notice about completed mainnet upgrade to v0.8.0
Listed deprecated RPC interfaces that were removed in v0.8.0
Real-time API Documentation
Added Real-time API section
Documented new block tags: "pending" and "latest"
Added State APIs, Account APIs, Block APIs, and Transaction APIs tables
Included integration guide and migration requirements
Added performance benchmarks and use cases
RPC Method Updates
Updated ZKEVM RPC methods table with status indicators
Marked deprecated methods with deprecation warnings
Added new eth_realtimeEnabled method
Added eth_getBlockInternalTransactions method
Enhanced Examples
Added Real-time API usage examples
Updated curl commands and JSON-RPC examples
Added subscription examples
Developers can now use Real-time APIs for instant blockchain interactions
Clear migration path from deprecated to active RPC methods