Update BTC deposit fee docs

[fadeev]

Update the BTC deposit formula to: zeta-chain/node#2765

Summary by CodeRabbit

• New Features

  • Added a detailed section on "Deposit Fee" for Bitcoin transactions in the ZetaChain documentation, explaining the fee structure and providing a calculation formula.

• Documentation

  • Streamlined the ZRC-20 documentation by simplifying the explanation of Bitcoin deposit fees and linking to related information for clarity.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 27, 2024 8:59am

[coderabbitai]

Walkthrough

Walkthrough

The changes involve the addition of a "Deposit Fee" section in the Bitcoin transaction documentation on ZetaChain, detailing the fee structure and calculation for Bitcoin deposits. Concurrently, the ZRC-20 documentation simplifies the explanation of Bitcoin deposit fees by removing detailed calculations and instead providing a reference to another section for further information.

Changes

Files	Change Summary
src/pages/developers/chains/bitcoin.mdx	Introduced a new section on "Deposit Fee," outlining the fee structure for Bitcoin deposits, including a calculation formula.
src/pages/developers/tokens/zrc20.mdx	Removed detailed explanations of Bitcoin deposit fees, simplifying the content and referencing another section for more information.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[coderabbitai]

Actionable comments posted: 0

Outside diff range, codebase verification and nitpick comments (2)

src/pages/developers/chains/bitcoin.mdx (2)

90-94: Clarify the fee structure explanation.

The explanation of the fee structure could be clearer. Consider rephrasing to explicitly state that the fee is shared between the depositor and the withdrawer, and that it is charged in advance as a deposit fee.

Consider rephrasing to:

-Unlike EVM-based chains, each deposited Bitcoin output incurs a fee when it is spent. To address this, both the depositor and the withdrawer share the cost of the spend. This fee is charged in advance as a deposit fee.
+Unlike EVM-based chains, each deposited Bitcoin output incurs a fee when it is spent. To address this, the cost is shared between the depositor and the withdrawer. This fee is charged in advance as a deposit fee.

---

96-105: Ensure the formula is clear and accurate.

The formula and its explanation are clear, but consider adding more context to ensure accuracy and understanding. For example, explain why 68vB is used and what it represents.

Consider adding an explanation for 68vB:

-The Bitcoin deposit fee is calculated with the following formula:
+The Bitcoin deposit fee is calculated using the following formula, where `68vB` represents the average size of a Bitcoin transaction input:

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d94c067 and 076fda9.

Files selected for processing (2)

• src/pages/developers/chains/bitcoin.mdx (1 hunks)
• src/pages/developers/tokens/zrc20.mdx (1 hunks)

Files skipped from review due to trivial changes (1)

• src/pages/developers/tokens/zrc20.mdx

[GMaiolo]

utACK