docs: update JSON RPC 0.7.1 support #464
Conversation
|
To view this pull requests documentation preview, visit the following URL: docs.page/focustree/starknet.dart~464 Documentation is deployed and generated using docs.page. |
WalkthroughThe documentation has been updated in multiple files. In the main index file, a detailed table of RPC methods for JSON RPC v0.7.1 has been removed and replaced with a concise heading and reference link. A new section on source code generation from contract ABI has been added with a feature comparison table across Cairo versions. The documentation for the Starknet Provider has been enhanced with expanded sections on transaction support, supported JSON RPC methods, and usage examples. Additionally, the README has been revised for clarity, naming consistency, and improved table formatting. Changes
Possibly related PRs
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (5)
docs/packages/starknet-builder.mdx (1)
3-14: New Section for Source Code Generation from Contract ABI
The addition of the "Source code generation from contract ABI" section—with its comparison table across Cairo versions—is a valuable enhancement. It clearly outlines which features are available in legacy and current Cairo versions. For improved markdown compliance and readability, consider adding a blank line both before and after the table (per MD058 recommendations).packages/starknet_provider/README.md (2)
6-14: Enhanced Transaction Support and JSON RPC Version Details
The revised sections now distinctly present the transaction support along with the supported JSON RPC version (0.7.1). The inclusion of detailed tables for the supported read and write methods makes it straightforward for users to ascertain which methods are implemented. To further improve readability, add blank lines surrounding the tables as suggested by markdownlint (MD058).
47-58: Consistent Write Methods Documentation
The write methods table mirrors its read counterpart effectively, ensuring consistency in how supported features are documented. As before, consider adding surrounding blank lines for markdown best practices.docs/packages/starknet-provider.mdx (2)
7-14: Clear Transaction Support Section
The "Transaction support" section, with its well-formatted table, effectively communicates the available features and their corresponding versions. As with other tables, ensure that proper blank lines exist above and below to satisfy markdownlint guidelines.
51-63: Comprehensive Write Methods Table
The write methods table complements the read section perfectly, maintaining a uniform presentation throughout the document. A minor improvement would be to insert blank lines around the table for enhanced readability and compliance with markdownlint (MD058).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/index.mdx(1 hunks)docs/packages/starknet-builder.mdx(1 hunks)docs/packages/starknet-provider.mdx(1 hunks)packages/starknet_provider/README.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
packages/starknet_provider/README.md
22-22: Tables should be surrounded by blank lines
null
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: lint
- GitHub Check: test-integration
🔇 Additional comments (7)
docs/index.mdx (1)
17-18: Clear Addition of Supported JSON RPC Version Section
The new section now succinctly informs users that JSON RPC version 0.7.1 is supported and provides a direct link to the detailed supported methods. Ensure that the anchor link (#supported-json-rpc-methods) exactly matches the target section in the referenced document so that users aren’t led to a dead-end.packages/starknet_provider/README.md (2)
14-20: Clear Presentation of Supported JSON RPC Methods
Introducing the "## Supported JSON RPC version: 0.7.1" heading followed by the "Read methods" section is an excellent way to funnel users toward the updated documentation. Ensure that the command snippet usingjqremains accurate as the Starknet specifications evolve.
21-46: Comprehensive Read Methods Table
The detailed table enumerating each JSON RPC read method and its implementation status is well organized. It offers a quick reference, which is ideal for developers checking compatibility. Verify that the icons (✅/❌) are consistent with other parts of the documentation.🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
22-22: Tables should be surrounded by blank lines
null(MD058, blanks-around-tables)
docs/packages/starknet-provider.mdx (4)
1-6: Updated Document Header and Package Information
The revised header and the inclusion of a direct link to the package documentation enhance overall clarity and professionalism. This sets a solid foundation for the rest of the document.
15-20: Well-Organized Supported JSON RPC Methods Section
The introduction of the "Supported JSON RPC methods" section—with a dedicated subsection for version 0.7.1—provides an excellent structure for users to navigate the available RPC methods.
20-50: Detailed Read Methods Documentation
Including the command snippet to extract method names and the following table offers invaluable insight into the current state of JSON RPC methods. This clear delineation is very helpful for future updates. Ensure that the table formatting is consistently spaced to meet markdown best practices.
64-99: Informative Usage Example for Calling a Read-only Method
The provided Dart code example is clear and practical—it demonstrates the provider setup, method call, error handling, and result parsing effectively. This example will greatly aid users in implementing similar functionality in their projects. Consider a final review to ensure code formatting aligns perfectly with Dart style guidelines.
Summary by CodeRabbit