Update Solana gateway docs #480
Conversation
fadeev
requested review from
bbbeeeee,
brewmaster012 and
a team
as code owners
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 Walkthrough📝 WalkthroughWalkthroughThe changes introduce a new Changes
Possibly related issues
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
🧹 Outside diff range and nitpick comments (5)
src/pages/developers/chains/solana.mdx (5)
1-5: Consider adding a brief explanation of universal applications.The introduction effectively explains the purpose of the Solana Gateway. However, it might be beneficial to include a brief explanation or link to documentation about universal applications for readers who may be unfamiliar with the concept.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~2-~2: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... (the native gas token of Solana) to an externally-owned account (EOA) or a universal applicatio...(HYPHENATED_LY_ADVERB_ADJECTIVE)
91-183: Consider adding error handling examples in the frontend code.The frontend interaction section provides a comprehensive guide on how to call the
depositfunction. To enhance the robustness of the example, consider adding error handling code snippets. This would demonstrate how to catch and handle potential errors that may occur during the transaction process, improving the overall reliability of the implementation.
217-227: Consider adding estimated timelines for upcoming features.The future support section provides valuable information about upcoming features. To help developers plan their implementations more effectively, consider adding estimated timelines or release versions for each of the mentioned features. This would give users a clearer expectation of when they can leverage these new capabilities.
229-241: Consider adding practical error handling examples.The error handling section effectively lists the possible error codes. To further assist developers in implementing robust error handling, consider adding practical code examples demonstrating how to catch and handle these specific errors in both Solana programs and frontend applications. This would provide developers with a clear template for implementing error handling in their own code.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~234-~234: Loose punctuation mark.
Context: ...ure scenarios: -SignerIsNotAuthority: The signer is not authorized to perform...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...to perform the action. -DepositPaused: Deposits are currently paused. - `MemoL...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~236-~236: Loose punctuation mark.
Context: ...currently paused. -MemoLengthTooShort: Thememopayload is less than the min...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...ngth of 20 bytes. -MemoLengthExceeded: Thememopayload exceeds the maximum ...(UNLIKELY_OPENING_PUNCTUATION)
243-247: Consider elaborating on the revert process.The revert transactions section provides crucial information about how failed cross-chain calls are handled. To give developers a more comprehensive understanding, consider expanding this section to include:
- The specific conditions that trigger a revert.
- The expected timeframe for the revert process to complete.
- Any actions developers or users need to take in case of a revert.
- How developers can monitor or be notified of reverted transactions.
This additional information would help developers better prepare for and handle potential revert scenarios in their applications.
🧰 Tools
🪛 LanguageTool
[style] ~246-~246: Consider using just “reverted”.
Context: ...taChain side, the deposited SOL will be reverted back to the original sender on Solana. ## C...(RETURN_BACK)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/pages/developers/chains/solana.mdx (1 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/developers/chains/solana.mdx
[uncategorized] ~2-~2: Although a hyphen is possible, it is not necessary in a compound modifier in which the first word is an adverb that ends in ‘ly’.
Context: ... (the native gas token of Solana) to an externally-owned account (EOA) or a universal applicatio...(HYPHENATED_LY_ADVERB_ADJECTIVE)
[uncategorized] ~21-~21: Loose punctuation mark.
Context: ...sult<()> ``` ### Parameters -amount: The amount of SOL (in lamports) to depo...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~22-~22: Loose punctuation mark.
Context: ...f SOL (in lamports) to deposit. -memo: A vector of bytes containing the receiv...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~84-~84: This phrasing could be wordy, so try replacing it with something more concise.
Context: ...a contract call. - If thememolength is greater than 20 bytes, depositing SOL will **trigger...(MORE_THAN_EXCEEDS)
[uncategorized] ~234-~234: Loose punctuation mark.
Context: ...ure scenarios: -SignerIsNotAuthority: The signer is not authorized to perform...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~235-~235: Loose punctuation mark.
Context: ...to perform the action. -DepositPaused: Deposits are currently paused. - `MemoL...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~236-~236: Loose punctuation mark.
Context: ...currently paused. -MemoLengthTooShort: Thememopayload is less than the min...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~238-~238: Loose punctuation mark.
Context: ...ngth of 20 bytes. -MemoLengthExceeded: Thememopayload exceeds the maximum ...(UNLIKELY_OPENING_PUNCTUATION)
[style] ~246-~246: Consider using just “reverted”.
Context: ...taChain side, the deposited SOL will be reverted back to the original sender on Solana. ## C...(RETURN_BACK)
|
@bbbeeeee @zeta-chain/fullstack @brewmaster012 please, review. |
Summary by CodeRabbit
New Features
Documentation