Docs chiado changes #1030
Docs chiado changes #1030
Conversation
📝 WalkthroughWalkthroughThe pull request includes updates to several documentation files related to deploying cross-chain applications using Axelar GMP, specifically focusing on deploying EVM and WASM contracts. It introduces a new Changes
Possibly related PRs
Suggested labels
Suggested reviewers
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
Documentation and Community
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎ 1 Skipped Deployment
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (13)
docs/developer-docs/docs/tokens/ward-token/distribution.md (2)
30-30: Fix table formatting: Add missing trailing pipe.The table row is missing a trailing pipe which affects consistency with Markdown formatting standards.
-| Validators and operators |10%| Initial amount delegated to mainnet validators and operators | Available at genesis but bonded +| Validators and operators |10%| Initial amount delegated to mainnet validators and operators | Available at genesis but bonded |🧰 Tools
🪛 Markdownlint
30-30: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
27-33: Improve table readability with consistent spacing.The table's readability can be enhanced by maintaining consistent spacing between columns.
-|Category|% | Description |Circulating| -| Public goods | 10% | Incentivized testnet and genesis airdrop, and public good initiatives |Available at genesis -|Ecosystem & community | 20%| Allocated for initiatives that contribute to the Warden Protocol's ecosystem and community projects|Available at genesis locked to governance -| Developer incentives|16%|Developer and builder incentives | Available at genesis locked to governance -| Validators and operators |10%| Initial amount delegated to mainnet validators and operators | Available at genesis but bonded -| Treasury & R&D | 24% |Long term treasury and research programmes | 10M available at genesis, linear unlock two year weekly vest -| Core contributors | 20% | Reserved for the development team, advisors and early contributors | 6 month cliff, two year linear weekly vest +| Category | % | Description | Circulating | +| Public goods | 10% | Incentivized testnet and genesis airdrop, and public good initiatives | Available at genesis | +| Ecosystem & community | 20% | Allocated for initiatives that contribute to the Warden Protocol's ecosystem and community projects | Available at genesis locked to governance | +| Developer incentives | 16% | Developer and builder incentives | Available at genesis locked to governance | +| Validators and operators | 10% | Initial amount delegated to mainnet validators and operators | Available at genesis but bonded | +| Treasury & R&D | 24% | Long term treasury and research programmes | 10M available at genesis, linear unlock two year weekly vest | +| Core contributors | 20% | Reserved for the development team, advisors and early contributors | 6 month cliff, two year linear weekly vest |🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...esis but bonded | Treasury & R&D | 24% |Long term treasury and research programmes | 10M ...(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...10M available at genesis, linear unlock two year weekly vest | Core contributors | 20% |...(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Markdownlint
27-27: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
28-28: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
29-29: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
30-30: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
31-31: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
32-32: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style(MD055, table-pipe-style)
docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md (4)
34-34: Fix typo in the migration noticeThere's a typo in "When migrating ot Chiado" - it should be "to".
-When migrating ot Chiado, please keep in mind the following key changes: +When migrating to Chiado, please keep in mind the following key changes:
52-62: Consider adding example outputs for commandsTo improve user experience, consider adding example outputs for both commands. This would help users verify they're getting the expected results.
Example enhancement:
```bash wardend keys add my-key-name --recover
+Example output:
+```
+Enter your bip39 mnemonic
+> your secret recovery phrase here
+- name: my-key-name
- address: ward1...
- pubkey: wardpub1...
+```--- `17-17`: **Consider adding more context for technical terms** The document references several technical concepts that might benefit from additional context: 1. The AIBI link leads to more information, but consider adding a brief inline description. 2. The oracle services section could benefit from mentioning supported oracle types or implementation details. Would you like me to help draft expanded descriptions for these technical concepts? Also applies to: 27-28 --- `68-68`: **Consider adding a "Next Steps" section** To improve documentation navigation, consider adding a "Next Steps" section at the end of the document. This could include: - Links to related configuration guides - References to troubleshooting documentation - Links to community resources or support channels Would you like me to help draft a "Next Steps" section? </blockquote></details> <details> <summary>docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md (1)</summary><blockquote> `8-8`: **Consider enhancing the transition notice.** While the message is clear, it could be more impactful by briefly mentioning the benefits of transitioning to Chiado. Consider this enhancement: ```diff -Chiado is our new and improved testnet. Please make sure to transition all your testing and development processes here. +Chiado is our new and improved testnet with enhanced stability and features. Please make sure to transition all your testing and development processes here.🧰 Tools
🪛 LanguageTool
[misspelling] ~8-~8: Did you mean “you're” (short for ‘you are’)?
Context: ...net. Please make sure to transition all your testing and development processes here....(YOUR)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...testing and development processes here. ::: ## Overview This tutorial explains ...(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (6)
Line range hint
1-42: Overview section is well-structured but needs minor improvements.Consider the following enhancements:
- Add a note about the expected duration or complexity level of this guide
- Include prerequisites for understanding Axelar GMP concepts
- Specify the minimum token amounts needed for both networks
Line range hint
43-89: Contract overview needs more clarity on security implications.The section should emphasize that:
- The contract will hold all tokens in its own balance
- Only the contract itself can burn tokens
- The contract is permissionless, allowing any chain to send burn instructions
This information is crucial for security considerations.
Line range hint
90-196: EVM contract code needs additional documentation.The
BurnableToken.solcontract code should include:
- Documentation for the
receive()function explaining why it's needed- A note about the significance of the initial supply amount
- Explanation of why tokens are minted to the contract address
Line range hint
197-242: Migration script needs version compatibility notes.The migration script section should specify:
- Compatible Truffle versions
- Node.js version requirements
- Gas price considerations for Sepolia network
Line range hint
243-686: WASM contract deployment section needs structural improvements.Consider reorganizing this section to:
- Move the prerequisites to the beginning
- Add a troubleshooting section
- Include expected gas costs
- Add version compatibility matrix
Line range hint
687-728: Verification section needs more detailed success criteria.The verification section should include:
- Expected token balances after successful execution
- Common error messages and their solutions
- Links to monitoring tools or dashboards
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (5)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md(1 hunks)docs/developer-docs/docs/operate-a-node/chiado-testnet/chiado-overview.md(1 hunks)docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md(1 hunks)docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md(1 hunks)docs/developer-docs/docs/tokens/ward-token/distribution.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (5)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/developer-docs/docs/operate-a-node/chiado-testnet/chiado-overview.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
docs/developer-docs/docs/tokens/ward-token/distribution.md (1)
Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"
🪛 LanguageTool
docs/developer-docs/docs/operate-a-node/chiado-testnet/chiado-overview.md
[misspelling] ~8-~8: Did you mean “you're” (short for ‘you are’)?
Context: ...net. Please make sure to transition all your testing and development processes here....
(YOUR)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...testing and development processes here. ::: ## Version history | Release ...
(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md
[misspelling] ~8-~8: Did you mean “you're” (short for ‘you are’)?
Context: ...net. Please make sure to transition all your testing and development processes here....
(YOUR)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...testing and development processes here. ::: ## Overview This tutorial explains ...
(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md
[misspelling] ~8-~8: Did you mean “you're” (short for ‘you are’)?
Context: ...net. Please make sure to transition all your testing and development processes here....
(YOUR)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...testing and development processes here. ::: ## Key features Chiado represents a...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint
docs/developer-docs/docs/tokens/ward-token/distribution.md
30-30: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
🔇 Additional comments (4)
docs/developer-docs/docs/tokens/ward-token/distribution.md (1)
Line range hint 1-42: Documentation content looks good!
The documentation is well-structured, accurate, and provides clear information about the WARD token distribution. The content is comprehensive and the changes improve clarity, especially in the "Validators and operators" section.
🧰 Tools
🪛 LanguageTool
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...esis but bonded | Treasury & R&D | 24% |Long term treasury and research programmes | 10M ...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
[uncategorized] ~31-~31: If this is a compound adjective that modifies the following noun, use a hyphen.
Context: ...10M available at genesis, linear unlock two year weekly vest | Core contributors | 20% |...
(EN_COMPOUND_ADJECTIVE_INTERNAL)
🪛 Markdownlint
27-27: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
28-28: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
29-29: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
30-30: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
31-31: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
32-32: Expected: leading_and_trailing; Actual: leading_only; Missing trailing pipe
Table pipe style
(MD055, table-pipe-style)
docs/developer-docs/docs/operate-a-node/chiado-testnet/whats-new.md (1)
1-6: LGTM!
The frontmatter and title are properly formatted.
docs/developer-docs/docs/operate-a-node/chiado-testnet/join-chiado.md (1)
Line range hint 1-24: Documentation structure and content look great!
The document is well-structured with:
- Clear section hierarchy
- Comprehensive setup instructions
- Well-formatted code blocks
- Proper use of admonitions for important notices
🧰 Tools
🪛 LanguageTool
[misspelling] ~8-~8: Did you mean “you're” (short for ‘you are’)?
Context: ...net. Please make sure to transition all your testing and development processes here....
(YOUR)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...testing and development processes here. ::: ## Overview This tutorial explains ...
(UNLIKELY_OPENING_PUNCTUATION)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (1)
686-686:
Incorrect tip formatting and placement.
The tip about the cryptographic module is incorrectly indented, which breaks the markdown formatting.
Apply this diff to fix the formatting:
- :::tip
- Buenavista uses the `cosmos.crypto.secp256k1` module for cryptographic operations. If your key is created with the `ethermint.crypto.v1.ethsecp256k1` module, downgrade your node to `v0.4.1` and create a key with `cosmos.crypto.secp256k1`.
- :::
+:::tip
+Buenavista uses the `cosmos.crypto.secp256k1` module for cryptographic operations. If your key is created with the `ethermint.crypto.v1.ethsecp256k1` module, downgrade your node to `v0.4.1` and create a key with `cosmos.crypto.secp256k1`.
+:::Likely invalid or redundant comment.
* chiado updates + minor fixes * improved info about the new signature scheme * a minor fix * improved the narrative about new addresses * improved the narrative about new addresses * improved the narrative about new addresses
Summary by CodeRabbit
New Features
Documentation
Bug Fixes