Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs deploy on chiado #965

Merged
merged 12 commits into from
Nov 5, 2024
Merged

Docs deploy on chiado #965

merged 12 commits into from
Nov 5, 2024

Conversation

ijonele
Copy link
Collaborator

@ijonele ijonele commented Oct 28, 2024

Added instructions on how to deploy contracts on Chiado

Summary by CodeRabbit

  • Documentation
    • Updated instructions for creating a Keychain, including version changes and command adjustments for the Warden Protocol.
    • Enhanced clarity and organization in deploying WASM contracts, with detailed steps for local and Chiado environments.
    • Improved guidance for deploying EVM contracts, including prerequisites and step-by-step instructions for both local and Chiado networks.
    • Comprehensive guide for deploying cross-chain applications, detailing prerequisites and instructions for both EVM and WASM contracts.
    • Added warnings about the importance of the seed phrase and mnemonic phrase for account recovery.

@ijonele ijonele linked an issue Oct 28, 2024 that may be closed by this pull request
Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

📝 Walkthrough
📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request includes updates to several documentation files related to the Warden Protocol, focusing on enhancing clarity and accuracy. Key changes involve version updates, command adjustments, and restructuring of content for better usability. Notable modifications include the update of the Warden repository version from v0.4.2 to v0.5.2, command syntax changes, and the addition of new instructions for deploying WASM and EVM contracts. The documentation now emphasizes the importance of key recovery information and provides clearer, step-by-step guidance for users.

Changes

File Path Change Summary
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md Updated Warden repository version from v0.4.2 to v0.5.2, modified build/install commands, and clarified balance check commands. Added a warning about seed phrases and refined Keychain registration instructions.
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md Restructured document for clarity, updated section titles, added detailed steps for running a local chain, and clarified contract deployment instructions.
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md Enhanced structure and content for deploying EVM contracts, split instructions into distinct sections, and added warnings about mnemonic phrases and private key confidentiality.
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md Updated to guide deploying a cross-chain application, detailing prerequisites and step-by-step instructions for EVM and WASM contract deployments. Emphasized verification of deployments on explorers.

Possibly related PRs

Suggested reviewers

  • jjheywood

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?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

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)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added the docs label Oct 28, 2024
@@ -130,11 +189,6 @@ Now you need to modify files in the `/src` directory as shown in the steps below
#[returns(String)]
GetGreeting {},
}

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alijnmerchant21 It looks like this part of the code isn't used anywhere else, so I deleted it. I checked the code after that and was able to deploy the contract

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 4

🧹 Outside diff range and nitpick comments (11)
docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (3)

Line range hint 1-24: Consider relaxing the Go version requirement.

The documentation specifies Go version 1.22.3 exactly. Consider using a more flexible version requirement (e.g., "Go 1.22 or later") to avoid unnecessary version constraints while ensuring compatibility.


Line range hint 150-170: Fix YAML indentation in the fees example.

The YAML output example has inconsistent indentation which might confuse readers. The key_req and sig_req fields should be aligned with their parent fees field.

Here's the corrected indentation:

   fees:
     key_req:
-      - amount: "100"
-        denom: award
-    sig_req:
-      - amount: "1"
-        denom: award
+    - amount: "100"
+      denom: award
+     sig_req:
+    - amount: "1"
+      denom: award

Line range hint 74-85: Add expected output for initialization commands.

Consider adding example output for the initialization commands to help users verify their setup. This would be particularly helpful for the wardend init command.

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (5)

42-42: Consider using variables for version numbers.

The hardcoded version numbers (1.22.3 for Go and 1.34.0 for just) might become outdated. Consider using variables or a more flexible version specification like "1.22.3 or later".


94-94: Add context about Chiado network.

Consider adding a brief explanation of what Chiado is (e.g., testnet, purpose) to help users understand why they might choose this option.


191-192: Enhance security warning for private key handling.

While there's a comment about keeping the private key confidential, consider adding a stronger security warning about:

  1. Using environment variables instead of hardcoding
  2. Risks of accidentally committing private keys
  3. Adding the config file to .gitignore

204-205: Add explanation for gas parameters.

Consider adding comments explaining:

  1. What gas limit and gas price represent
  2. How these values were determined
  3. When users might need to adjust them

285-302: Add deployment verification steps.

Consider adding instructions for:

  1. Verifying the deployed contract on a block explorer
  2. Basic checks to ensure the contract is operational
  3. Troubleshooting common deployment issues
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (3)

104-104: Improve grammar in step description

The phrase "returned in the previous step" uses incorrect preposition.

-5. Fund your key using [Chiado faucet](https://faucet.chiado.wardenprotocol.org) and the public address returned in the previous step.
+5. Fund your key using [Chiado faucet](https://faucet.chiado.wardenprotocol.org) and the public address returned from the previous step.
🧰 Tools
🪛 LanguageTool

[grammar] ~104-~104: The usual collocation for “returned” is “to”, not “in”.
Context: ...denprotocol.org) and the public address returned in the previous step. 6. Check your balan...

(RETURN_IN_THE)


296-307: Clarify code ID placeholder usage in examples

The examples use a hardcoded code ID "1" which might confuse users since actual code IDs are sequential and unique.

Consider using a more obvious placeholder like <code-id> and adding a note explaining that users should replace it with their actual code ID.

Also applies to: 345-358


Line range hint 420-424: Add Chiado option for query command

The query command should include the Chiado node URL option for consistency with other commands.

Add a tabs section similar to other commands:

+<Tabs>
+<TabItem value="local" label="Local chain">
 ```bash
 wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}'

+
+
+```bash
+wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}' \


<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary><blockquote>

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

---

[grammar] ~104-~104: The usual collocation for “returned” is “to”, not “in”.
Context: ...denprotocol.org) and the public address returned in the previous step.  6. Check your balan...

(RETURN_IN_THE)

</blockquote></details>

</details>

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Files that changed from the base of the PR and between ace2aa981b6aa1b4bb959723a99c65edd35c4a7b and a23c4b209a2823f5ef6a20fc2728a0792cc16adc.

</details>

<details>
<summary>📒 Files selected for processing (3)</summary>

* docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1 hunks)
* docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (8 hunks)
* docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (5 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (3)</summary><blockquote>

<details>
<summary>docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>

</blockquote></details><details>
<summary>🪛 LanguageTool</summary><blockquote>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md</summary><blockquote>

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

---

[grammar] ~104-~104: The usual collocation for “returned” is “to”, not “in”.
Context: ...denprotocol.org) and the public address returned in the previous step.  6. Check your balan...

(RETURN_IN_THE)

</blockquote></details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary><blockquote>

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...gs, the chain ID is `warden_1337-1`.    :::  ### Option 2. Connect to Chiado  1. ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~126-~126: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

---

[grammar] ~128-~128: The usual collocation for “returned” is “to”, not “in”.
Context: ...denprotocol.org) and the public address returned in the previous step.  6. Check your balan...

(RETURN_IN_THE)

</blockquote></details>

</blockquote></details>
<details>
<summary>🪛 Markdownlint</summary><blockquote>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md</summary><blockquote>

251-251: null
Link fragments should be valid

(MD051, link-fragments)

</blockquote></details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary><blockquote>

195-195: null
Bare URL used

(MD034, no-bare-urls)

---

214-214: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</blockquote></details>

</blockquote></details>

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>docs/developer-docs/docs/build-a-keychain/operate-a-keychain/create-a-keychain.md (1)</summary><blockquote>

`74-74`: **LGTM: Version and command updates are consistent.**

The changes correctly update the repository version to v0.5.2 and modify the build commands to use the 'wardend' prefix.



Also applies to: 76-77

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

provider: function() {
return new HDWalletProvider(PRIVATE_KEY, "http://localhost:8545");
},
network_id: 1337, // The first number from your chain ID
Copy link
Collaborator Author

@ijonele ijonele Oct 28, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@alijnmerchant21
The host and port values seem to duplicate what the HDWalletProvider does, so I deleted them. I also set the RPC URL as a constant. After these adjustments, I was able to deploy the contract locally.

Copy link

vercel bot commented Oct 28, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
warden-help-center ⬜️ Ignored (Inspect) Visit Preview Nov 1, 2024 3:01pm

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 3

🧹 Outside diff range and nitpick comments (11)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (4)

191-192: Enhance security warning for private key handling.

Consider adding a more prominent warning about private key security and suggesting environment variables instead of hardcoding.

-// Keep your private key confidential, DO NOT commit to version control!
+// SECURITY WARNING: Never hardcode private keys. Use environment variables:
+// const PRIVATE_KEY = process.env.PRIVATE_KEY;
+// If you must use a hardcoded key for testing, ensure it's a dedicated test account.

Also applies to: 220-221


287-288: Add verification step before deployment.

Add a step to verify the chain connection before deployment:

# Add this command before deployment to verify chain connection:
truffle exec --network warden -e 'web3.eth.getBlockNumber().then(console.log)'

Line range hint 350-392: Add error handling examples for contract interactions.

Consider adding examples of handling common errors during contract interaction:

// Add error handling examples:
try {
  await instance.setMessage("Hello, EVM on Warden!");
} catch (error) {
  if (error.message.includes("gas")) {
    console.error("Insufficient gas. Try increasing the gas limit.");
  } else {
    console.error("Transaction failed:", error.message);
  }
}
🧰 Tools
🪛 LanguageTool

[uncategorized] ~347-~347: Loose punctuation mark.
Context: ... currency – WARD, denominated in award. ::: ## 8. Interact with the contract 1....

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 1-392: Documentation structure and content approved with suggestions.

The documentation is well-structured and comprehensive. Consider these minor enhancements:

  1. Add a troubleshooting section with common issues and solutions
  2. Include estimated gas costs for different operations
  3. Add links to related documentation (e.g., smart contract security best practices)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...gs, the chain ID is warden_1337-1. ::: ### Option 2. Connect to Chiado 1. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~126-~126: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (5)

Line range hint 11-39: Consider specifying versions for all prerequisite tools

While Go version is specified (1.22.3), the installation instructions for other tools (cargo-generate, wasm-opt) don't specify versions. This could lead to compatibility issues.

Consider adding version information for better reproducibility:

 rustup target add wasm32-unknown-unknown
-cargo install cargo-generate --features vendored-openssl
+cargo install cargo-generate@0.18.3 --features vendored-openssl
🧰 Tools
🪛 LanguageTool

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)


92-94: Enhance the security warning for seed phrase

While the warning about the seed phrase is present, it could be more comprehensive.

Consider expanding the warning:

-The seed phrase is the only way to restore your keys. Losing it can result in the irrecoverable loss of WARD tokens.
+WARNING: The seed phrase (mnemonic) is the ONLY way to restore your keys. Store it securely offline and never share it with anyone. Losing or exposing it can result in the irrecoverable loss of WARD tokens.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 251-286: Add explanation for gas parameters

The deployment command includes gas parameters without explaining their purpose.

Consider adding a brief explanation before the command:

The command uses these gas-related parameters:
- `--gas auto`: Automatically estimates the gas needed
- `--gas-adjustment 1.3`: Adds a 30% buffer to the estimated gas
- `--gas-prices`: Sets the gas price in award tokens

Line range hint 376-410: Enhance contract interaction examples

The contract execution section could be more comprehensive.

Consider adding:

  1. Example of successful execution output
  2. Common error scenarios and how to resolve them
  3. Transaction hash verification steps

Example addition:

After executing the contract, you should see output similar to:
```json
{
  "height": "123456",
  "txhash": "ABC...XYZ",
  "events": [
    {
      "type": "wasm",
      "attributes": [
        {
          "key": "method",
          "value": "say_hello"
        }
      ]
    }
  ]
}

---

Line range hint `1-424`: **Improve formatting consistency**

The document has some minor formatting inconsistencies.

1. Standardize spacing after code blocks (currently varies between 1-2 lines)
2. Ensure consistent indentation in all code blocks
3. Consider adding a table of contents at the start for better navigation

 Overall, the documentation is well-structured and provides clear instructions for deploying WASM contracts.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary><blockquote>

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</blockquote></details>

</details>

</blockquote></details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (2)</summary><blockquote>

`295-295`: **Enhance the Chiado availability tip with more specific information.**

Consider adding a link to track Chiado updates or specify an estimated timeline for availability.

```diff
-Axelar GMP will be soon available on our new testnet – [Chiado](/operate-a-node/chiado-testnet/join-chiado). Stay tuned in for updates!
+Axelar GMP will be available on our new testnet – [Chiado](/operate-a-node/chiado-testnet/join-chiado) in Q4 2024. Subscribe to our [announcements channel](link-to-announcements) for updates!

622-622: Add explanations for gas parameters.

The deployment commands use specific gas prices and amounts without explaining how these values were determined. Consider adding explanations about:

  • How to determine appropriate gas prices
  • When to adjust the gas adjustment value
  • Minimum and recommended gas amounts

Add a tip section before the deployment commands:

:::tip
The gas parameters used in these commands are examples:
- `gas-prices`: Current minimum is 0.025uward
- `gas-adjustment`: Use 1.5 for standard transactions, may need adjustment for complex operations
- `amount`: Ensure you have sufficient AXL tokens for cross-chain operations
:::
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a23c4b2 and 6f7da8e.

📒 Files selected for processing (3)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (3 hunks)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (8 hunks)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (5 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
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/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...gs, the chain ID is warden_1337-1. ::: ### Option 2. Connect to Chiado 1. ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~126-~126: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

🪛 Markdownlint
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md

195-195: null
Bare URL used

(MD034, no-bare-urls)


214-214: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (2)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)

128-128: Fix preposition usage in the instruction.

The previous review comment about changing "in" to "from" is still valid.

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (1)

622-622: Verify if v0.4.1 is the recommended version.

The guide specifies Warden v0.4.1, but this might be outdated. Please verify if this is still the recommended version for deployment on Buenavista testnet.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (3)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (3)

295-295: Consider adding a note about development environment setup.

Before the contract creation steps, it would be helpful to add a note about setting up a development environment with the required dependencies (cargo-generate, rust-optimizer, etc.).


622-622: Enhance security warnings and best practices.

Consider adding the following security-related notes:

  • Warning about storing private keys and mnemonics securely
  • Recommendation to use environment variables for sensitive values
  • Reminder to verify contract addresses before deployment

Line range hint 408-622: Add error handling examples and testing instructions.

The documentation would benefit from:

  1. Examples of handling common errors during deployment
  2. Instructions for testing the contract locally before deployment
  3. Guidelines for monitoring and verifying cross-chain transactions
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6f7da8e and a9879cb.

📒 Files selected for processing (1)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md (3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
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"

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (7)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (3)

38-42: Add step numbers to section headings for better navigation.

Consider adding step numbers to the main section headings for consistency with the rest of the document:

-## 1. Prepare the chain
+## Step 1: Prepare the chain

-### Option 1. Run a local chain
+### Option 1: Run a local chain

191-192: Add a security warning for private key handling.

Similar to the mnemonic phrase warning, consider adding a prominent warning about private key security:

 // Keep your private key confidential, DO NOT commit to version control!
 const PRIVATE_KEY = "your_private_key";
+
+// ⚠️ WARNING: Never commit your private key to version control or share it.
+// Doing so will compromise your account security and may result in loss of funds.

Line range hint 341-391: Add a troubleshooting section.

Consider adding a troubleshooting section before the closing note to help users resolve common issues:

## Troubleshooting

### Common Issues and Solutions

1. **Connection Errors**
   - Error: `Error: Invalid JSON RPC response: ""`
   - Solution: Verify that your chain is running and the RPC URL is correct

2. **Deployment Failures**
   - Error: `Error: Returned error: insufficient funds`
   - Solution: Ensure your account has sufficient WARD tokens

3. **Gas Issues**
   - Error: `Error: Returned error: exceeds block gas limit`
   - Solution: Try reducing the gas limit in your Truffle configuration

4. **Network ID Mismatch**
   - Error: `Error: The network id specified in the truffle config does not match`
   - Solution: Update the network_id in truffle-config.js to match your chain

For additional support, please reach out to us in [Discord](https://discord.com/invite/warden) or [Twitter](https://twitter.com/wardenprotocol).
🧰 Tools
🪛 LanguageTool

[uncategorized] ~338-~338: Loose punctuation mark.
Context: ... currency – WARD, denominated in award. ::: ## 8. Interact with the contract 1....

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (4)

55-68: Add example output for balance query

Consider adding an example of the expected output when checking the balance. This would help users verify if their setup is correct.

Add something like:

   ```bash
   wardend query bank balances shulgin
+  
+  # Expected output:
+  balances:
+  - amount: "100000000"
+    denom: "award"

---

Line range hint `380-380`: **Fix typo in command description**

There's a typo in the word "exectute".

```diff
-Use the command below to exectute your contract.
+Use the command below to execute your contract.
🧰 Tools
🪛 LanguageTool

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 419-421: Add Chiado configuration for query command

For consistency with other commands, consider adding a tab for Chiado configuration in the query section.

Add:

 ```bash
 wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}'

+When querying on Chiado, add the node URL:
+
+```bash
+wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}' \


<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>

---

Line range hint `251-287`: **Add explanation for gas prices**

Consider adding a note explaining the gas price configuration (`100000000000award`). This would help users understand the cost implications and how to adjust it if needed.

Add a note explaining:
- Why this specific gas price is used
- How users can adjust it based on network conditions
- What the `award` denomination represents

</details>

</details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Files that changed from the base of the PR and between a9879cbb48a3064ca9bd13913564383f30bc2d5e and f3e68215ff9865bdc7fa2ba4f32c44433310cc6c.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (7 hunks)
* docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (5 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (2)</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>

</details><details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md</summary>

[uncategorized] ~53-~53: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~102-~102: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary>

[uncategorized] ~52-~52: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~92-~92: Loose punctuation mark.
Context: ...gs, the chain ID is `warden_1337-1`.    :::  ### Option 2. Connect to Chiado  1. ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~118-~118: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~126-~126: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>
<details>
<summary>🪛 Markdownlint</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary>

195-195: null
Bare URL used

(MD034, no-bare-urls)

---

214-214: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (6)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (4)

16-18: Consolidate duplicate warnings about Chiado deployment.

The warning about Chiado deployment availability is repeated in two places. Consider keeping only the warning in the overview section and removing the duplicate in the "Connect to Chiado" section to avoid confusion.

Also applies to: 102-104

🧰 Tools
🪛 LanguageTool

[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ble only after the next Chiado upgrade. ::: ## Prerequisites Before you start, ...

(UNLIKELY_OPENING_PUNCTUATION)


48-48: Add version compatibility information.

Consider adding a note about version compatibility requirements between Go 1.22.3 and Warden v0.5.2 to help users avoid potential issues.


Line range hint 353-397: Add error handling guidance for contract interactions.

Consider adding examples of how to handle common errors during contract interactions, such as:

  • Transaction failures
  • Network connectivity issues
  • Gas estimation errors
🧰 Tools
🪛 LanguageTool

[uncategorized] ~350-~350: Loose punctuation mark.
Context: ... currency – WARD, denominated in award. ::: ## 8. Interact with the contract 1....

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 397-397: Add a troubleshooting section.

Consider adding a "Troubleshooting" section before the conclusion to help users resolve common deployment and interaction issues. This would complement the existing support channels mentioned.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ble only after the next Chiado upgrade. ::: ## Prerequisites Before you start, ...

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (2)

95-97: Consider enhancing the security warning visibility

While the warning about the seed phrase is correct, consider making it more prominent by:

  1. Adding emojis (e.g., ⚠️ or 🔒) to draw attention
  2. Emphasizing the irreversible nature of loss
-   :::warning
-   The seed phrase is the only way to restore your keys. Losing it can result in the irrecoverable loss of WARD tokens.
-   :::
+   :::warning ⚠️
+   CRITICAL SECURITY: The seed phrase is the ONLY way to restore your keys. Losing it will result in PERMANENT and IRREVERSIBLE loss of access to your WARD tokens. Store it securely offline!
+   :::
🧰 Tools
🪛 LanguageTool

[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 424-427: Add node flag for Chiado queries

The query command should include the --node flag when querying the Chiado network.

-wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}'
+wardend query wasm contract-state smart my-contract-address '{"get_greeting":{}}' \
+  --node https://rpc.chiado.wardenprotocol.org:443
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between f3e6821 and bebd953.

📒 Files selected for processing (2)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (8 hunks)
  • docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (6 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)

Pattern **/*.md: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"

🪛 LanguageTool
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md

[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md

[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...ble only after the next Chiado upgrade. ::: ## Prerequisites Before you start, ...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~58-~58: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~98-~98: Loose punctuation mark.
Context: ...gs, the chain ID is warden_1337-1. ::: ### Option 2. Connect to Chiado :::...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~103-~103: Loose punctuation mark.
Context: ...ble only after the next Chiado upgrade. ::: To deploy an EVM contract on [Chiado...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~138-~138: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

🪛 Markdownlint
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md

207-207: null
Bare URL used

(MD034, no-bare-urls)


226-226: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

🔇 Additional comments (3)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)

203-204: Enhance private key security guidance.

Consider adding a recommendation to use environment variables for private keys:

-const PRIVATE_KEY = "your_private_key";
+const PRIVATE_KEY = process.env.PRIVATE_KEY || "your_private_key";

Also, add a note about creating a .env file and adding it to .gitignore.
[security]

Also applies to: 232-233

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (2)

Line range hint 12-39: LGTM! Clear introduction and comprehensive prerequisites.

The introduction clearly states the purpose and the prerequisites section provides accurate installation commands with specific version requirements.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...the local account name is shulgin. ::: 3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens. ::: :::tip You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)


[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...ys show my-key-name --address ``` ::: 5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)


Line range hint 124-230: LGTM! Well-structured contract code examples.

The contract code examples are clear, well-formatted, and follow Rust/CosmWasm best practices.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)

Line range hint 341-343: Enhance clarity of the currency note.

The note about currency denomination could be clearer.

Consider updating the note to:

-Due to Evmos default settings, this log displays prices in ETH and gwei. However, the contract itself uses Warden's currency – WARD, denominated in award.
+Due to Evmos default settings, this log displays prices in ETH and gwei. However, the actual transactions use Warden's native currency (WARD) with award as the base denomination (similar to how gwei is for ETH).
🧰 Tools
🪛 LanguageTool

[uncategorized] ~342-~342: Loose punctuation mark.
Context: ... currency – WARD, denominated in award. ::: ## 8. Interact with the contract 1....

(UNLIKELY_OPENING_PUNCTUATION)

docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (2)

111-113: Add verification step for Chiado connection

Consider adding a verification step to confirm successful connection to Chiado before proceeding.

Add the following note after the balance check command:

If you see your balance, you've successfully connected to Chiado testnet. If you encounter connection issues, ensure your node URL is correct and the network is operational.

233-241: Add compilation verification step

Consider adding instructions to verify the successful compilation.

Add the following after the compilation command:

You can verify the successful compilation by checking the generated Wasm file:
```bash
ls -l target/wasm32-unknown-unknown/release/hello_world.wasm

The command should show the newly created Wasm file with a non-zero size.


</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used: .coderabbit.yaml**
**Review profile: CHILL**

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between bebd9539733361d35cac23f7828a620c9af29ff1 and 43af51fe6a92f2ad5d59780fd80b760853402fb9.

</details>

<details>
<summary>📒 Files selected for processing (2)</summary>

* `docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md` (8 hunks)
* `docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md` (6 hunks)

</details>

<details>
<summary>🧰 Additional context used</summary>

<details>
<summary>📓 Path-based instructions (2)</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (1)</summary>

Pattern `**/*.md`: "Assess the documentation for misspellings, grammatical errors, missing documentation and correctness"


</details>

</details><details>
<summary>🪛 LanguageTool</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md</summary>

[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~97-~97: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~105-~105: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary>

[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...gs, the chain ID is `warden_1337-1`.    :::  ### Option 2. Connect to Chiado  To ...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>
<details>
<summary>🪛 Markdownlint</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md</summary>

199-199: null
Bare URL used

(MD034, no-bare-urls)

---

218-218: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

</details>

<details>
<summary>🔇 Additional comments (8)</summary>

<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md (5)</summary>

`12-14`: **LGTM! Clear and concise overview.**

The overview effectively explains the EVM contract deployment capabilities and available options.

---

`38-95`: **LGTM! Well-structured local chain setup instructions.**

The instructions are clear, properly organized with tabs for different configurations, and include helpful tips.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[uncategorized] ~54-~54: Loose punctuation mark.
Context: ...the local account name is `shulgin`.    :::  3. Check the local account balance t...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~94-~94: Loose punctuation mark.
Context: ...gs, the chain ID is `warden_1337-1`.    :::  ### Option 2. Connect to Chiado  To ...

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>

---

`96-144`: **LGTM! Clear Chiado connection instructions.**

The instructions provide a comprehensive guide with proper emphasis on key recovery and balance verification.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[uncategorized] ~122-~122: Loose punctuation mark.
Context: ...e irrecoverable loss of WARD tokens.    :::     :::tip    You can always check yo...

(UNLIKELY_OPENING_PUNCTUATION)

---

[uncategorized] ~130-~130: Loose punctuation mark.
Context: ...ys show my-key-name --address    ```    :::  5. Fund your key using [Chiado fauce...

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>

---

`186-256`: **LGTM! Clear configuration instructions with environment-specific details.**

The configuration section effectively covers both local and Chiado deployments with proper explanations of each parameter.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 Markdownlint</summary>

199-199: null
Bare URL used

(MD034, no-bare-urls)

---

218-218: null
Fenced code blocks should have a language specified

(MD040, fenced-code-language)

</details>

</details>

---

Line range hint `345-394`: **LGTM! Comprehensive contract interaction guide.**

The instructions provide a clear step-by-step guide with proper verification steps and helpful community support links.

<details>
<summary>🧰 Tools</summary>

<details>
<summary>🪛 LanguageTool</summary>

[uncategorized] ~342-~342: Loose punctuation mark.
Context: ... currency – WARD, denominated in award. :::  ## 8. Interact with the contract  1....

(UNLIKELY_OPENING_PUNCTUATION)

</details>

</details>

</details>
<details>
<summary>docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-wasm-contract.md (3)</summary>

`12-14`: **Well-structured introduction!**

The introduction clearly states the purpose and scope of the guide, mentioning both local chain and Chiado testnet deployment options.

---

`402-413`: **Well-structured Chiado integration!**

The Chiado-specific commands are consistently formatted and include all necessary parameters.

---

`287-288`: _:warning: Potential issue_

**Update chain ID for Chiado testnet**

The chain ID `chain_123-1` appears to be incorrect for Chiado testnet deployment.

```diff
-  --chain-id chain_123-1 \
+  --chain-id warden-chiado-1 \

Likely invalid or redundant comment.

@ijonele ijonele merged commit cdb7699 into main Nov 5, 2024
13 checks passed
@ijonele ijonele deleted the docs-deploy-on-chiado branch November 5, 2024 09:28
@coderabbitai coderabbitai bot mentioned this pull request Nov 15, 2024
@coderabbitai coderabbitai bot mentioned this pull request Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Explain how to deploy contracts on Chiado
2 participants