Update account cmd and balance cmd docs on tutorials intro #498
Conversation
lukema95
requested review from
bbbeeeee,
fadeev,
brewmaster012 and
a team
as code owners
|
@lukema95 is attempting to deploy a commit to the Zeta Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThe pull request introduces enhancements to the tutorial for setting up smart contracts on ZetaChain. Key modifications include clarification on wallet types generated by the Changes
Possibly related PRs
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 (4)
src/pages/developers/tutorials/intro.mdx (4)
66-66: Consider rephrasing to avoid split infinitive.Consider rewording to "first attempts to import the private key automatically" for better grammatical structure.
-1. It first attempts to automatically import the private key from the `~/.config/solana/id.json` file. +1. It first attempts to import the private key automatically from the `~/.config/solana/id.json` file.🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Style-wise, it’s not ideal to insert an adverb (‘automatically’) in the middle of an infinitive construction (‘to import’). Try moving the adverb to avoid split infinitives.
Context: ... the process is as follows: 1. It first attempts to automatically import the private key from the~/.config/solana/id.jsonfil...(SPLIT_INFINITIVE)
65-69: Add private key format specifications.Consider adding information about the expected format of Solana private keys for manual entry to help users avoid input errors.
For Solana wallets, the process is as follows: 1. It first attempts to import the private key automatically from the `~/.config/solana/id.json` file. -2. If this file doesn't exist or can't be read, you'll be prompted to enter the private key manually. +2. If this file doesn't exist or can't be read, you'll be prompted to enter the private key manually (expected format: base58-encoded string). Finally, the private key is saved into the `.env` file.🧰 Tools
🪛 LanguageTool
[style] ~66-~66: Style-wise, it’s not ideal to insert an adverb (‘automatically’) in the middle of an infinitive construction (‘to import’). Try moving the adverb to avoid split infinitives.
Context: ... the process is as follows: 1. It first attempts to automatically import the private key from the~/.config/solana/id.jsonfil...(SPLIT_INFINITIVE)
71-72: Consider using a structured list for address formats.The address format information would be clearer in a structured list format.
-The `account` command shows derived addresses in hexadecimal (for EVM-based -chains), bech32 with `zeta` prefix for ZetaChain, base58 for Solana, and bech32 for Bitcoin. +The `account` command shows derived addresses in the following formats: +- EVM-based chains: hexadecimal format +- ZetaChain: bech32 format with `zeta` prefix +- Solana: base58 format +- Bitcoin: bech32 format
96-96: Enhance example with realistic placeholder values.Consider providing more realistic placeholder values in the example to better guide users.
-npx hardhat balances --evm EVM_ADDRESS --solana SOLANA_ADDRESS --bitcoin BITCOIN_ADDRESS +npx hardhat balances --evm 0x742d35Cc6634C0532925a3b844Bc454e4438f44e --solana 5ZWj7a1f8tWkjBESHKgrNmk1kXUrcHjsWdh2TK7zUX9 --bitcoin bc1qxy2kgdygjrsqtzq2n0yrf2493p83kkfjhx0wlh
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- src/pages/developers/tutorials/intro.mdx (3 hunks)
🧰 Additional context used
🪛 LanguageTool
src/pages/developers/tutorials/intro.mdx
[style] ~66-~66: Style-wise, it’s not ideal to insert an adverb (‘automatically’) in the middle of an infinitive construction (‘to import’). Try moving the adverb to avoid split infinitives.
Context: ... the process is as follows: 1. It first attempts to automatically import the private key from the~/.config/solana/id.jsonfil...(SPLIT_INFINITIVE)
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Related issue: zeta-chain/toolkit#187
Summary by CodeRabbit