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

specified that part of the bounty gets burned and the remainder awarded to the validator #13136

Merged
merged 1 commit into from
Jun 26, 2024

Conversation

mcmoodoo
Copy link
Contributor

@mcmoodoo mcmoodoo commented Jun 11, 2024

…ded to the verifier

Description

Related Issue

Summary by CodeRabbit

  • Documentation
    • Updated the "Intro to Ethereum" documentation to reflect changes in the bounty handling mechanism in Ethereum transactions. Now, a portion of the bounty is burned, and the rest is awarded to the participant.

@github-actions github-actions bot added the content 🖋️ This involves copy additions or edits label Jun 11, 2024
Copy link

netlify bot commented Jun 11, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit d665522
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/6667e289e59ac8000851a1d4
😎 Deploy Preview https://deploy-preview-13136--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
7 paths audited
Performance: 42 (🟢 up 4 from production)
Accessibility: 92 (no change from production)
Best Practices: 89 (🔴 down 3 from production)
SEO: 93 (no change from production)
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@mcmoodoo
Copy link
Contributor Author

@coderabbitai review

Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent changes to the Ethereum documentation involve an update to the bounty handling mechanism in Ethereum transactions. Previously, the entire bounty was awarded to the participant who verified and executed the transaction. Now, a portion of the bounty is burned, and the remaining part is awarded to the participant. This update aims to refine the incentive structure within the Ethereum network.

Changes

File Path Change Summary
public/content/developers/docs/intro-to-ethereum/index.md Updated documentation to reflect the new bounty handling mechanism in Ethereum transactions.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant EthereumNetwork
    participant Verifier

    User->>EthereumNetwork: Submit Transaction
    EthereumNetwork->>Verifier: Request Verification
    Verifier->>EthereumNetwork: Verify and Execute Transaction
    EthereumNetwork->>Verifier: Award Partial Bounty
    EthereumNetwork->>EthereumNetwork: Burn Portion of Bounty
    Verifier->>User: Confirmation of Transaction Execution
Loading

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d70c495 and d665522.

Files selected for processing (1)
  • public/content/developers/docs/intro-to-ethereum/index.md (1 hunks)
Additional context used
LanguageTool
public/content/developers/docs/intro-to-ethereum/index.md

[style] ~43-~43: To make your writing clearer, consider a more direct alternative. (AS_A_MEANS_TO)
Context: ...twork in three main ways: 1) it is used as a means to reward validators who propose blocks or call o...


[typographical] ~53-~53: Do not use a colon (:) before a series that is introduced by a preposition (‘as’). Remove the colon or add a noun or a noun phrase after the preposition. (RP_COLON)
Context: ...plex user-facing apps and services such as: marketplaces, financial instruments, ga...


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:

‼️ IMPORTANT
Auto-reply has been disabled for this repository in the CodeRabbit settings. The CodeRabbit bot will not respond to your replies unless it is explicitly tagged.

  • 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 Configration 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.

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 (2)
public/content/developers/docs/intro-to-ethereum/index.md (2)

Line range hint 43-43: Consider rephrasing for directness.

- it is used as a means to reward validators
+ it rewards validators

This change simplifies the language and makes the sentence more direct, improving readability.


Line range hint 53-53: Remove the colon after "such as".

- services such as: marketplaces, financial instruments, games, etc.
+ services such as marketplaces, financial instruments, games, etc.

The colon is unnecessary here and removing it improves grammatical correctness.

@@ -36,7 +36,7 @@ Cryptographic mechanisms ensure that once transactions are verified as valid and

**Ether (ETH)** is the native cryptocurrency of Ethereum. The purpose of ETH is to allow for a market for computation. Such a market provides an economic incentive for participants to verify and execute transaction requests and provide computational resources to the network.

Any participant who broadcasts a transaction request must also offer some amount of ETH to the network as a bounty. The network will award this bounty to whoever eventually does the work of verifying the transaction, executing it, committing it to the blockchain, and broadcasting it to the network.
Any participant who broadcasts a transaction request must also offer some amount of ETH to the network as a bounty. The network will burn part of the bounty and award the rest to whoever eventually does the work of verifying the transaction, executing it, committing it to the blockchain, and broadcasting it to the network.
Copy link
Contributor

Choose a reason for hiding this comment

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

Clarify the proportion of the bounty that is burned and awarded.

The text states that part of the bounty is burned and the rest awarded, but it doesn't specify the proportions or the conditions under which these actions occur. It would enhance clarity and user understanding to specify these details.

Copy link
Member

Choose a reason for hiding this comment

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

Agree with this code rabbit comment, but I'm not sure it's worth getting into that on this page. There is an entire separate gas page that can get into the details.

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

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

Thanks @mcmoodoo! Looks good

@@ -36,7 +36,7 @@ Cryptographic mechanisms ensure that once transactions are verified as valid and

**Ether (ETH)** is the native cryptocurrency of Ethereum. The purpose of ETH is to allow for a market for computation. Such a market provides an economic incentive for participants to verify and execute transaction requests and provide computational resources to the network.

Any participant who broadcasts a transaction request must also offer some amount of ETH to the network as a bounty. The network will award this bounty to whoever eventually does the work of verifying the transaction, executing it, committing it to the blockchain, and broadcasting it to the network.
Any participant who broadcasts a transaction request must also offer some amount of ETH to the network as a bounty. The network will burn part of the bounty and award the rest to whoever eventually does the work of verifying the transaction, executing it, committing it to the blockchain, and broadcasting it to the network.
Copy link
Member

Choose a reason for hiding this comment

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

Agree with this code rabbit comment, but I'm not sure it's worth getting into that on this page. There is an entire separate gas page that can get into the details.

@wackerow wackerow merged commit 41468ea into ethereum:dev Jun 26, 2024
6 checks passed
This was referenced Jul 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content 🖋️ This involves copy additions or edits
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants