Fix DryRunApi client-facing XCM versions #7438
Conversation
| @@ -2513,6 +2513,7 @@ impl<T: Config> Pallet<T> { | |||
| /// Meant to be used in the `xcm_runtime_apis::dry_run::DryRunApi` runtime API. | |||
| pub fn dry_run_call<Runtime, Router, OriginCaller, RuntimeCall>( | |||
| origin: OriginCaller, | |||
| xcms_version: XcmVersion, | |||
| call: RuntimeCall, | |||
There was a problem hiding this comment.
I am just wondering why do we pass RuntimeCall parameter to dry_run_call and VersionedXcm<RuntimeCall> parameter to dry_run_xcm function?
Using let xcm_version = xcm.identify_version(); looks cleaner...
There was a problem hiding this comment.
What do you mean? :)
The RuntimeCall is necessary for dry_run_call since it expects an encoded call to dispatch it and record its effects.
The VersionedXcm<RuntimeCall> for dry_run_xcm is also necessary since it needs to dry-run the supplied program.
| fn dry_run_reserve_asset_transfer_latest() { | ||
| dry_run_reserve_asset_transfer_common(XCM_VERSION); | ||
| } | ||
|
|
||
| #[test] | ||
| fn dry_run_reserve_asset_transfer_v5() { | ||
| dry_run_reserve_asset_transfer_common(5); | ||
| } | ||
|
|
||
| #[test] | ||
| fn dry_run_reserve_asset_transfer_v4() { | ||
| dry_run_reserve_asset_transfer_common(4); | ||
| } | ||
|
|
||
| #[test] | ||
| fn dry_run_reserve_asset_transfer_v3() { | ||
| dry_run_reserve_asset_transfer_common(3); | ||
| } |
There was a problem hiding this comment.
You can utilise table-driven tests for this matter
#[test]
fn dry_run_reserve_asset_transfer_versions() {
let test_cases = [XCM_VERSION, 5, 4, 3];
for &version in &test_cases {
dry_run_reserve_asset_transfer_common(version);
}
}
same below
There was a problem hiding this comment.
Done.
Note: this uncovered another bug (although I'm not sure it can be easily reproduced in production): the Router's messages weren't cleared before XCM dry-running in the dry_run_xcm.
See this commit: 1d77746
Description
Fixes #7413
Integration
This PR makes breaking changes to the
DryRunApi. The signature of thedry_run_callis changed, and the XCM version of the return values ofdry_run_xcmnow follows the version of the input XCM program.If needed, this PR can be reworked so that the Runtime API is assigned a new version by adding a
changed_inattribute to thedry_run_call.Review Notes
DryRunApiis modifiedRouter::clear_messagestodry_run_xcmcommon implementationpallet-xcmis modified accordinglyDryRunApitests are modified to account for testing old XCM versionspallet-xcmis used where it was not used (including theDryRunApitests)