docs: add feegrant curl guide #1892
Conversation
WalkthroughThe documentation has been expanded by adding a new section titled “Optional: Using FeeGrant with curl commands” to guide users through granting fee allowances using curl. The update includes step-by-step instructions for starting a local light node, exporting an authentication token, retrieving the granter address, setting the grantee address, and issuing a feegrant request via curl. Minor formatting adjustments and reformatting of command examples have been applied for consistency. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant LightNode
participant API
User->>LightNode: Start local light node
User->>LightNode: Export auth token and retrieve granter address
User->>User: Set grantee address
User->>API: Send feegrant request via curl
API-->>User: Return feegrant response
Assessment against linked issues
Possibly related PRs
Suggested reviewers
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 (3)
how-to-guides/feegrant-for-blobs.md (3)
241-262: Add explanation for gas parameters.The curl command includes hardcoded values for
gas_price(0.002) andgas(142225). Consider:
- Explaining how these values were determined
- Providing guidance on adjusting them based on network conditions
\"params\": [ \"$GRANTEE_ADDRESS\", \"42\", { - \"gas_price\": 0.002, + \"gas_price\": 0.002, # Minimum gas price for Mocha testnet \"is_gas_price_set\": true, - \"gas\": 142225, + \"gas\": 142225, # Estimated gas limit for feegrant transactionsAlso consider adding a note about checking current network conditions for appropriate gas values.
264-277: Add error handling guidance.The guide shows a successful response but doesn't cover potential error scenarios. Consider adding:
- Common error responses
- Troubleshooting steps
- How to handle timeouts or network issues
279-279: Fix formatting issues.
- Line 279 exceeds the line length limit. Consider breaking the URL into a separate line.
- Line 283 has inconsistent punctuation. Add a period at the end for consistency.
-You can verify the transaction on [Celenium Explorer](https://mocha.celenium.io/tx/4AAFDA4CE622C56CE9681B7E3BE7773E3B36ABE6C02BD66111BD2F2491011FD2?tab=messages) by searching for the transaction hash. +You can verify the transaction on [Celenium Explorer] by searching for the transaction hash. + +[Celenium Explorer]: https://mocha.celenium.io/tx/4AAFDA4CE622C56CE9681B7E3BE7773E3B36ABE6C02BD66111BD2F2491011FD2?tab=messages -The parameters in the request are: +The parameters in the request are as follows:Also applies to: 283-283
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
279-279: Line length
Expected: 80; Actual: 200(MD013, line-length)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
how-to-guides/feegrant-for-blobs.md(6 hunks)
🧰 Additional context used
🪛 LanguageTool
how-to-guides/feegrant-for-blobs.md
[uncategorized] ~283-~283: Loose punctuation mark.
Context: ...eters in the request are: - gas_price: The price of gas in utia - `is_gas_pric...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 markdownlint-cli2 (0.17.2)
how-to-guides/feegrant-for-blobs.md
279-279: Line length
Expected: 80; Actual: 200
(MD013, line-length)
🔇 Additional comments (2)
how-to-guides/feegrant-for-blobs.md (2)
108-108: LGTM! Formatting improvements.The added markdownlint comments and JSON response formatting changes improve code readability and maintainability.
Also applies to: 118-126, 149-156, 175-190
208-212: LGTM! Well-structured curl guide.The new section provides clear and comprehensive instructions for using FeeGrant with curl commands, which aligns well with the PR objectives of enhancing the feegrant documentation.
Added documentation for using feegrant with curl commands in the feegrant-for-blobs.md guide.
Closes #1779
Summary by CodeRabbit