Allow to use evm foreign assets to pay XCM fees #2908

librelois · 2024-08-20T17:55:48Z

What does it do?

Create a new pallet that register all supported asset for XCM fees with their price relative to the native asset (MOVR or GLMR).

This PR completes several goals at once:

Prepares the ground for the future removal of the asset-manager pallet by moving the management of data related to assets supported to pay XCM fees into a new pallet.
Adapt the design of the new pallet for potential future support of dynamic XCM fees (store a price relative to the native asset rather than a number of units to be paid per second of execution).
Provide a new WeightTrader implementation to support new evm foreign assets (and still support old ones)
Adds functionality to pause/resume asset support without deleting their data
Adds more granularity to the origin that can perform each operation (for example, it becomes possible to authorize a specific origin to modify the price of an asset, without being able to do anything else).

⚠️ breaking changes ⚠️

The way to add/edit/remove XCM fees support for a given asset has changed.

New way to register an asset price (formerly units per second)

Call: xcmWeightTrader.addAsset(location, relative_price)

Allowed origins: GeneralAdmin, 5/9 of OpenTechCommittee, Root

Parameters

location: Location scale encoded xcm v4 location of asset reserve relative to moonbeam
relative_price: u128 18 decimals balance needed to equal 1 unit of native asset (MOVR for moonriver and GLMR for moonbeam). For example, if the asset price is twice as low as the GLMR price, enter 500_000_000_000_000_000.

Substrate event

xcmWeightTrader.SupportedAssetAdded(location, relativePrice)

New way to update an asset price (formerly units per second)

Call: xcmWeightTrader.editAsset(location, relative_price)

Allowed origins: FastGeneralAdmin, 5/9 of OpenTechCommittee, Root

Parameters

location: Location scale encoded xcm v4 location of asset reserve relative to moonbeam
relative_price: u128 18 decimals balance needed to equal 1 unit of native asset (MOVR for moonriver and GLMR for moonbeam). For example, if the asset price is twice as low as the GLMR price, enter 500_000_000_000_000_000.

Substrate event

xcmWeightTrader.SupportedAssetEdited(location, relativePrice)

New feature: pause fee support for a given asset

Call: xcmWeightTrader.pauseAssetSupport(location)

Allowed origins: FastGeneralAdmin, 5/9 of OpenTechCommittee, Root

Parameters

location: Location scale encoded xcm v4 location of asset reserve relative to moonbeam

Substrate event

xcmWeightTrader.PauseAssetSupport(location)

New feature: resume fee support for a given asset

Call: xcmWeightTrader.resumeAssetSupport(location)

Allowed origins: 5/9 of OpenTechCommittee, Root_

Parameters

location: Location scale encoded xcm v4 location of asset reserve relative to moonbeam

Substrate event

xcmWeightTrader.ResumeAssetSupport(location)

New way to remove fee support for a given asset

Call: xcmWeightTrader.removeAsset(location)

Allowed origins: 5/9 of OpenTechCommittee, Root_

Parameters

location: Location scale encoded xcm v4 location of asset reserve relative to moonbeam

Substrate event

xcmWeightTrader.SupportedAssetRemoved(location)

What important points reviewers should know?

TODO

Refactor XCM runtime api to use the new pallet
Add rust tests for trader implementation
Add pallet to moonbase runtime config
Add rust integration tests for moonbase runtime
Add some dev-tests

primitives/xcm/src/fee_handlers.rs

github-actions · 2024-08-21T15:47:26Z

Coverage Report

@@                    Coverage Diff                     @@
##           master   elois-evm-foreign-fees      +/-   ##
==========================================================
+ Coverage   78.70%                   79.33%   +0.63%     
+ Files         294                      298       +4     
+ Lines       84425                    87119    +2694     
==========================================================
+ Hits        66440                    69114    +2674     
+ Misses      17985                    18005      +20

Files Changed	Coverage
/pallets/asset-manager/src/lib.rs	78.18% (-6.59%)	🔽
/pallets/moonbeam-xcm-benchmarks/src/weights/generic.rs	4.26% (+1.30%)	🔼
/pallets/moonbeam-xcm-benchmarks/src/weights/mod.rs	13.61% (+1.57%)	🔼
/runtime/common/src/apis.rs	29.83% (+1.60%)	🔼
/runtime/common/src/migrations.rs	72.20% (-25.75%)	🔽
/runtime/moonbase/src/lib.rs	52.85% (-0.08%)	🔽
/runtime/moonbase/src/xcm_config.rs	58.65% (-5.35%)	🔽
/runtime/moonbase/tests/xcm_mock/parachain.rs	60.85% (+0.63%)	🔼
/runtime/moonbase/tests/xcm_mock/statemint_like.rs	63.38% (+1.62%)	🔼
/runtime/moonbase/tests/xcm_tests.rs	99.91% (-0.01%)	🔽
/runtime/moonbeam/src/lib.rs	46.77% (-0.08%)	🔽
/runtime/moonbeam/src/xcm_config.rs	47.47% (-5.16%)	🔽
/runtime/moonbeam/tests/xcm_mock/parachain.rs	60.85% (+0.63%)	🔼
/runtime/moonbeam/tests/xcm_mock/statemint_like.rs	63.38% (+1.62%)	🔼
/runtime/moonbeam/tests/xcm_tests.rs	99.93% (-0.01%)	🔽
/runtime/moonriver/src/lib.rs	46.99% (-0.08%)	🔽
/runtime/moonriver/src/xcm_config.rs	45.45% (-5.08%)	🔽
/runtime/moonriver/tests/xcm_mock/parachain.rs	61.57% (+0.62%)	🔼
/runtime/moonriver/tests/xcm_mock/statemine_like.rs	63.38% (+1.62%)	🔼
/runtime/moonriver/tests/xcm_tests.rs	99.93% (-0.02%)	🔽

Coverage generated Fri Sep 13 15:08:38 UTC 2024

…rader

runtime/common/src/migrations.rs

github-actions · 2024-08-28T13:32:57Z

WASM runtime size check:

Compared to target branch

Moonbase runtime: 2192 KB (no changes) ✅

Moonbeam runtime: 2144 KB (no changes) ✅

Moonriver runtime: 2140 KB (no changes) ✅

Compared to latest release (runtime-3102)

Moonbase runtime: 2192 KB (+252 KB compared to latest release) ⚠️

Moonbeam runtime: 2144 KB (+244 KB compared to latest release) ⚠️

Moonriver runtime: 2140 KB (+240 KB compared to latest release) ⚠️

pallets/xcm-weight-trader/src/lib.rs

gonzamontiel

Changes are great, also good coverage! I left some comments, maybe we could add a missing test (even though there are many), other than that LGTM.

pallets/xcm-weight-trader/src/lib.rs

gonzamontiel · 2024-08-30T09:37:58Z

runtime/common/src/migrations.rs

+
+		//***** Start mutate storage *****//
+
+		// Write asset metadat in new pallet_xcm_weight_trader


Suggested change

// Write asset metadat in new pallet_xcm_weight_trader

// Write asset metadata in new pallet_xcm_weight_trader

runtime/moonbeam/src/lib.rs

runtime/moonbeam/tests/xcm_tests.rs

runtime/common/src/apis.rs

RomarQ

Added some remarks

runtime/common/src/migrations.rs

pallets/xcm-weight-trader/src/lib.rs

Co-authored-by: Agustín Rodriguez <[email protected]>

librelois · 2024-09-06T13:21:10Z

ts dev-tests suceed locally, there is something wrong with the dev-test CI job

RomarQ · 2024-09-06T15:03:49Z

ts dev-tests suceed locally, there is something wrong with the dev-test CI job

There are still 2 todos!() in the migrations file.

RomarQ · 2024-09-06T15:06:27Z

Apart from the todo!(), the changes look good 👍

RomarQ · 2024-09-09T07:57:19Z

The zombienet tests are failing with:

ERROR tokio-runtime-worker pallet_migrations::pallet: [🌗] Migration MM_MigrateXcmFeesAssetsMetadata consumed more weight than it was given! (Weight(ref_time: 18446744073709551615, proof_size: 18446744073709551615) > Weight(ref_time: 1999918717000, proof_size: 5242880))

librelois · 2024-09-09T11:06:28Z

Migration MM_MigrateXcmFeesAssetsMetadata consumed more weight than it was given

This log make no sense anymore since we pause xcm and extrinsics at the block that execute migrations, so we do'nt care how many weights the migration consume as long as if fit in a block. That's why the migration return Weight::MAX

create pallet xcm-weight-trader

84b1d32

librelois added B7-runtimenoteworthy Changes should be noted in any runtime-upgrade release notes D5-nicetohaveaudit⚠️ PR contains trivial changes to logic that should be properly reviewed. breaking Needs to be mentioned in breaking changes labels Aug 20, 2024

RomarQ reviewed Aug 21, 2024

View reviewed changes

primitives/xcm/src/fee_handlers.rs Outdated Show resolved Hide resolved

add rust unit tests for trader fix trader impl

7c7212d

librelois and others added 13 commits August 22, 2024 13:02

add functions for runtime api xcm-fee-payment

27b51cf

add rust test scenario: unpause and edit asset price

3d9c721

add pallet-xcm-weight-trader to all runtimes & migrate assets fees data

83157cd

avoid div by zero

2499887

refactor moonbase rust tests to use new pallet xcm-weight-trader

2492d89

refactor moonbeam/moonriver rust tests to use new pallet xcm-weight-t…

d6ff588

…rader

Merge branch 'master' into elois-evm-foreign-fees

9532086

fix pallet compilation with feature runtime-benchmark and tests

90537cb

fix rust tests

9a399e3

add weight info for pallet_xcm_weight_trader

1678021

fix migration formula

a1e7004

fix pallet tests

fd30cb7

fix linting

af305a0

pLabarta reviewed Aug 27, 2024

View reviewed changes

runtime/common/src/migrations.rs Outdated Show resolved Hide resolved

librelois added 2 commits August 28, 2024 15:20

fix typo

01c317d

configure origins for xcmWeightTrader

87dd277

librelois changed the title ~~WIP: Allow to use evm foreign assets to pay XCM fees~~ Allow to use evm foreign assets to pay XCM fees Aug 28, 2024

librelois marked this pull request as ready for review August 29, 2024 15:21

librelois commented Aug 29, 2024

View reviewed changes

pallets/xcm-weight-trader/src/lib.rs Outdated Show resolved Hide resolved

fix: edit asset should not unpause asset

871626d

gonzamontiel previously approved these changes Aug 30, 2024

View reviewed changes

Merge branch 'master' into elois-evm-foreign-fees

35f2b1b

RomarQ reviewed Sep 4, 2024

View reviewed changes

runtime/common/src/apis.rs Outdated Show resolved Hide resolved

RomarQ requested changes Sep 4, 2024

View reviewed changes

Agusrodri reviewed Sep 4, 2024

View reviewed changes

runtime/common/src/migrations.rs Show resolved Hide resolved

Agusrodri reviewed Sep 4, 2024

View reviewed changes

pallets/xcm-weight-trader/src/lib.rs Outdated Show resolved Hide resolved

noandrea added the A8-mergeoncegreen Pull request is reviewed well. label Sep 5, 2024

librelois and others added 4 commits September 6, 2024 11:55

Update pallets/xcm-weight-trader/src/lib.rs

6d7be3b

Co-authored-by: Agustín Rodriguez <[email protected]>

Merge branch 'master' into elois-evm-foreign-fees

8fc6346

fix rust compilation

86f837e

benchmarks: use evm foreign assets for worst_case_holding

a6bdc47

librelois requested review from RomarQ and Agusrodri September 6, 2024 14:34

RomarQ and others added 3 commits September 10, 2024 14:45

Merge branch 'master' into elois-evm-foreign-fees

0916c9d

impl post-upgrade

7cd1b35

fix migration code

3c772e5

RomarQ previously approved these changes Sep 12, 2024

View reviewed changes

Merge branch 'master' into elois-evm-foreign-fees

dd9040e

librelois dismissed RomarQ’s stale review via dd9040e September 12, 2024 17:03

Agusrodri previously approved these changes Sep 12, 2024

View reviewed changes

fix rust test

58a5b40

librelois dismissed Agusrodri’s stale review via 58a5b40 September 13, 2024 13:51

librelois added 2 commits September 13, 2024 15:57

rustfmt

6c02815

remove unused import

c8d8a7f

Agusrodri approved these changes Sep 13, 2024

View reviewed changes

librelois merged commit dd3a4a4 into master Sep 13, 2024
38 of 39 checks passed

librelois deleted the elois-evm-foreign-fees branch September 13, 2024 15:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow to use evm foreign assets to pay XCM fees #2908

Allow to use evm foreign assets to pay XCM fees #2908

librelois commented Aug 20, 2024 •

edited by RomarQ

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 28, 2024 •

edited

Loading

gonzamontiel left a comment

gonzamontiel Aug 30, 2024

RomarQ left a comment

librelois commented Sep 6, 2024

RomarQ commented Sep 6, 2024

RomarQ commented Sep 6, 2024

RomarQ commented Sep 9, 2024

librelois commented Sep 9, 2024


		//*** Start mutate storage ***//

		// Write asset metadat in new pallet_xcm_weight_trader

	// Write asset metadat in new pallet_xcm_weight_trader
	// Write asset metadata in new pallet_xcm_weight_trader

Allow to use evm foreign assets to pay XCM fees #2908

Allow to use evm foreign assets to pay XCM fees #2908

Conversation

librelois commented Aug 20, 2024 • edited by RomarQ Loading

What does it do?

⚠️ breaking changes ⚠️

New way to register an asset price (formerly units per second)

Parameters

Substrate event

New way to update an asset price (formerly units per second)

Parameters

Substrate event

New feature: pause fee support for a given asset

Parameters

Substrate event

New feature: resume fee support for a given asset

Parameters

Substrate event

New way to remove fee support for a given asset

Parameters

Substrate event

What important points reviewers should know?

github-actions bot commented Aug 21, 2024 • edited Loading

Coverage Report

github-actions bot commented Aug 28, 2024 • edited Loading

WASM runtime size check:

Compared to target branch

Compared to latest release (runtime-3102)

gonzamontiel left a comment

Choose a reason for hiding this comment

gonzamontiel Aug 30, 2024

Choose a reason for hiding this comment

RomarQ left a comment

Choose a reason for hiding this comment

librelois commented Sep 6, 2024

RomarQ commented Sep 6, 2024

RomarQ commented Sep 6, 2024

RomarQ commented Sep 9, 2024

librelois commented Sep 9, 2024

librelois commented Aug 20, 2024 •

edited by RomarQ

Loading

github-actions bot commented Aug 21, 2024 •

edited

Loading

github-actions bot commented Aug 28, 2024 •

edited

Loading