Skip to content

Enable benchmarks for pallet_xcm_benchmarks #3330

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

Draft
wants to merge 16 commits into
base: master
Choose a base branch
from

Conversation

TarekkMA
Copy link
Contributor

@TarekkMA TarekkMA commented Jun 26, 2025

⚠️ Breaking Changes ⚠️

Xcm instructions are now benchmarked and as a result the wights are now different than before

Copy link

coderabbitai bot commented Jun 26, 2025

Important

Review skipped

Auto reviews are limited to specific labels.

🏷️ Labels to auto review (1)
  • agent-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

Comment on lines 425 to 439
let weight = actual_weight.min(self.0);
let amount: u128 =
Self::compute_amount_to_charge(&weight, &location).unwrap_or(u128::MAX);
let amount_to_refund = initial_amount.saturating_sub(amount);
self.0 -= weight;
self.1 = Some(Asset {
fun: Fungibility::Fungible(amount_to_refund),
id: XcmAssetId(location.clone()),
});
log::trace!(
target: "xcm-weight-trader",
"refund_weight amount to refund: {:?}",
amount_to_refund
);
if amount > 0 {
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Make the implementation the same as https://paritytech.github.io/polkadot-sdk/master/staging_xcm_builder/struct.UsingComponents.html

This resulted in fixing refund_surplus instruction benchmark test which was failing before.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Just replace amount by amount_to_refund lines 439 and 441.
The amount is not what we refund, it's what the user actually have to pay

@RomarQ RomarQ added B7-runtimenoteworthy Changes should be noted in any runtime-upgrade release notes D9-needsaudit👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited labels Jun 26, 2025
Copy link
Contributor

github-actions bot commented Jun 27, 2025

WASM runtime size check:

Compared to target branch

Moonbase runtime: 2348 KB (-8 KB) ✅

Moonbeam runtime: 2500 KB (no changes) 🚨

Moonriver runtime: 2504 KB (+4 KB) 🚨

Compared to latest release (runtime-3800)

Moonbase runtime: 2348 KB (+304 KB compared to latest release) ⚠️

Moonbeam runtime: 2500 KB (+336 KB compared to latest release) 🚨

Moonriver runtime: 2504 KB (+340 KB compared to latest release) 🚨

@TarekkMA TarekkMA added the breaking Needs to be mentioned in breaking changes label Jun 27, 2025
@RomarQ RomarQ added the A8-mergeoncegreen Pull request is reviewed well. label Jun 30, 2025
Copy link
Contributor

github-actions bot commented Jul 3, 2025

Moonbase Weight Difference Report

File Extrinsic Old New Change Percent

Moonriver Weight Difference Report

File Extrinsic Old New Change Percent

Moonbeam Weight Difference Report

File Extrinsic Old New Change Percent

Copy link
Collaborator

@librelois librelois left a comment

Choose a reason for hiding this comment

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

About the very high cost for some XCM instructions, like WithdrawAsset:

I think it’s expected because these instructions can read an EVM contract and therefore add up to 24 KB of proof size—but in 99% of cases, that cost is too high for the user.

The ideal solution would be to have dynamic weight computation for XCM instructions that can read AccountCodesMetadata and charge accordingly.

If we can’t have dynamic weight computation, we could add a check in the pallet-ethereum-xcm to read AccountCodesMetadata and fail—without reading the actual bytecode—if the size exceeds a threshold. That threshold should be high enough to accommodate any legitimate ERC-20 (probably around 12 KB), so the cost will still be high for users.

If pallet-xcm benchmarks don’t support dynamic weight computation for XCM instructions, it may be a good reason to maintain a custom benchmarking pallet on our side.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A8-mergeoncegreen Pull request is reviewed well. B7-runtimenoteworthy Changes should be noted in any runtime-upgrade release notes breaking Needs to be mentioned in breaking changes D9-needsaudit👮 PR contains changes to fund-managing logic that should be properly reviewed and externally audited
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants