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

Add docs for gas fee refunds #555

Merged
merged 7 commits into from
Jul 8, 2024
Merged

Add docs for gas fee refunds #555

merged 7 commits into from
Jul 8, 2024

Conversation

sketsdever
Copy link
Collaborator

@sketsdever sketsdever commented Jul 5, 2024

Changes:

  • Add a new page in both the builder and protect sections which describes the new gas fee refunds feature
  • Update multiplexing instructions to include eth_sendBundle (which now supports multiplexing)
  • Update Protect overview and quick start guides to mention gas fee refunds in addition to MEV refunds
  • Update the eth_sendBundle API spec to explain smart bundles

Follow ups:

  • Add API spec for flashbots_getSbundleStats in a separate PR

Copy link

vercel bot commented Jul 5, 2024

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

Name Status Preview Comments Updated (UTC)
flashbots-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 8, 2024 9:00am

@sketsdever sketsdever changed the title [WIP] Add docs for gas fee refunds Add docs for gas fee refunds Jul 5, 2024
Copy link
Member

@bertmiller bertmiller left a comment

Choose a reason for hiding this comment

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

reviewed, i didn't look for nits but mostly lgtm with two comments

docs/flashbots-auction/advanced/gas-fee-refunds.md Outdated Show resolved Hide resolved

## Who receives refunds

The refund recipient is the signer used on the `eth_sendBundle`, `mev_sendBundle`, or `eth_sendPrivateTransaction` request.
Copy link
Member

Choose a reason for hiding this comment

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

I thought we were defaulting to msg.sender unless there was an override?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

That's true for protect (tx.origin not msg.sender to be precise). For anything sent directly to the bundle relay it's the signer because signer is always provided and this allows for separating eg. bot address from refund recipient which affords more privacy.

@odysseus0 odysseus0 merged commit bee8702 into main Jul 8, 2024
3 checks passed
@odysseus0 odysseus0 deleted the sheak/gasfeerefunds branch July 8, 2024 09:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants