Subsidize adding an Ethereum compatible control key #2403

shannonwells · 2025-05-12T23:24:13Z

Goal

The goal of this PR is to allow adding a second key to be a ~~free~~ subsidized capacity transaction under specific circumstances. This change reduces the capacity fee by about 70% when there is one key, and the new key is Ethereum-compatible.

Most of #2286

Discussion

Note on something easy to miss: the expiration block will default to 0, which means this feature is off by default, until the value is set to a block in the future. There is no on-chain monitoring of the usage of this feature.

Checklist

As Sudo or Council, can set the expiration block for the ~~free~~ subsidized key addition period.
Updated frequency-tx-payment SignedExtension to use a filter for the specific call
frequency-tx-payment uses an Msa call to determine eligibility
Updated Pallet Readme?
Unit Tests added?
e2e Tests added?
Benchmarks added?
Spec version incremented?

not applicable

~~- [ ] Design doc(s) updated?~~

shannonwells · 2025-05-13T00:43:57Z

e2e/package.json

@@ -46,5 +46,8 @@
    "tsx": "^4.19.3",
    "typescript": "^5.8.3",
    "typescript-eslint": "^8.30.1"
+  },
+  "optionalDependencies": {


Needed for running e2e tests locally on Ubuntu

pallets/frequency-tx-payment/src/lib.rs

codecov · 2025-05-13T03:34:38Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Files with missing lines	Coverage Δ
common/primitives/src/msa.rs	`87.95% <ø> (ø)`
common/primitives/src/signatures.rs	`77.94% <100.00%> (+0.82%)`	⬆️
pallets/frequency-tx-payment/src/lib.rs	`87.81% <100.00%> (+1.14%)`	⬆️
pallets/msa/src/lib.rs	`92.74% <100.00%> (+0.49%)`	⬆️

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

e2e/msa/msaKeyManagement.test.ts

e2e/msa/msaTokens.test.ts

e2e/msa/msaKeyManagement.test.ts

e2e/scaffolding/helpers.ts

JoeCap08055 · 2025-05-21T14:00:48Z

pallets/frequency-tx-payment/src/types.rs

+
+/// Filters calls that match Msa::add_public_key_to_msa
+pub trait GetAddKeyData<RuntimeCall, AccountId, MessageSourceId> {
+	/// If the xall matches Msa::add_public_key_to_msa, return the owner account id and msa id


Suggested change

/// If the xall matches Msa::add_public_key_to_msa, return the owner account id and msa id

/// If the call matches Msa::add_public_key_to_msa, return the owner account id and msa id

runtime/frequency/src/lib.rs

shannonwells · 2025-05-21T23:22:49Z

pallets/frequency-tx-payment/src/lib.rs

+		if eligible_call_weight.is_zero() {
+			0u32.into()
+		} else {
+			let reduction: Permill = Permill::from_percent(70u32);


See e2e test for how much this reduces cost.

nit: I think it might be helpful to have a comment about the weight reductions or percentages and such in here.

Overall is it fair to say that this reduces the fee to around 0.3 or a bit more for subsidized?

Yes, that's about right

aramikm · 2025-05-21T23:43:19Z

e2e/msa/addKeyLowCost.ethereum.test.ts

+  signPayloadSr25519,
+  stakeToProvider,
+} from '../scaffolding/helpers';
+import { getUnifiedAddress, getUnifiedPublicKey } from '../scaffolding/ethereum';


nit: Unfortunately my pr merge caused a conflict here and you should use @frequency-chain/ethereum-utils for these functions

aramikm · 2025-05-22T00:06:06Z

pallets/frequency-tx-payment/src/tests/pallet_tests.rs

+			let withdraw_fee = ChargeFrqTransactionPayment::<Test>::from(0u64)
+				.withdraw_fee(&owner_id, &pay_with_capacity_add_public_key_call, &dispatch_info, 10)
+				.unwrap();
+			assert!(withdraw_fee.0.lt(&106_000_000u64));


nit: Might worth comparing the non-ethereum vs ethereum weights for the same call instead of using a magic number which might change in feature.

aramikm · 2025-05-22T00:11:09Z

pallets/msa/src/weights.rs

if no additional functions are added or removed then maybe this should not get committed!?

oversight, thanks

aramikm · 2025-05-22T00:25:13Z

pallets/frequency-tx-payment/src/lib.rs

+		if eligible_call_weight.is_zero() {
+			0u32.into()
+		} else {
+			let reduction: Permill = Permill::from_percent(70u32);


nit: I think it might be helpful to have a comment about the weight reductions or percentages and such in here.

Overall is it fair to say that this reduces the fee to around 0.3 or a bit more for subsidized?

mattheworris

Read through changes.
🚢 it!

bug fixed, tests passing

Update e2e/scaffolding/helpers.ts remove backticks Co-authored-by: Joe Caputo <[email protected]>

…gibility * Pay for 2nd key w/ capacity if ethereum is a low cost transaction. * e2e tests for same.

* Rename eligibility function * extract rust tests to own file

…omments

JoeCap08055

Nice work, approved.

shannonwells commented May 13, 2025

View reviewed changes

github-actions bot added metadata-changed Metadata has changed since the latest full release and removed metadata-changed Metadata has changed since the latest full release labels May 13, 2025

shannonwells commented May 13, 2025

View reviewed changes

pallets/frequency-tx-payment/src/lib.rs Outdated Show resolved Hide resolved

github-actions bot added the metadata-changed Metadata has changed since the latest full release label May 13, 2025

shannonwells marked this pull request as ready for review May 13, 2025 16:27

shannonwells requested a review from wilwade as a code owner May 13, 2025 16:27

shannonwells requested review from a team, mattheworris, enddynayn, aramikm, claireclark1 and JoeCap08055 and removed request for a team May 13, 2025 20:04

JoeCap08055 reviewed May 13, 2025

View reviewed changes

e2e/msa/msaKeyManagement.test.ts Outdated Show resolved Hide resolved

JoeCap08055 reviewed May 13, 2025

View reviewed changes

e2e/msa/msaTokens.test.ts Outdated Show resolved Hide resolved

JoeCap08055 reviewed May 13, 2025

View reviewed changes

e2e/msa/msaKeyManagement.test.ts Outdated Show resolved Hide resolved

JoeCap08055 reviewed May 13, 2025

View reviewed changes

e2e/scaffolding/helpers.ts Outdated Show resolved Hide resolved

shannonwells force-pushed the feat/free-add_key-#2286 branch from ca3b553 to 844f53e Compare May 13, 2025 22:06

shannonwells requested a review from JoeCap08055 May 13, 2025 22:39

github-actions bot added the metadata-changed Metadata has changed since the latest full release label May 21, 2025

JoeCap08055 reviewed May 21, 2025

View reviewed changes

runtime/frequency/src/lib.rs Outdated Show resolved Hide resolved

github-actions bot removed the metadata-changed Metadata has changed since the latest full release label May 21, 2025

shannonwells marked this pull request as ready for review May 21, 2025 19:03

github-actions bot added the metadata-changed Metadata has changed since the latest full release label May 21, 2025

shannonwells changed the title ~~Add ability to adding an Ethereum compatible control key for free~~ Subsidize adding an Ethereum compatible control key May 21, 2025

shannonwells commented May 21, 2025

View reviewed changes

aramikm reviewed May 22, 2025

View reviewed changes

mattheworris approved these changes May 22, 2025

View reviewed changes

shannonwells and others added 15 commits May 22, 2025 17:25

Add ability to set the expiration block for adding a key for free

4d4caf2

bug fixed, tests passing

benchmarks, spec_version

337edb1

update readme, linting

35e9691

PR clean up: rustdocs, remove unused imports & code.

0a9947d

more cleanup

1589995

please the linter

edccb98

Update e2e/scaffolding/helpers.ts remove backticks Co-authored-by: Joe Caputo <[email protected]>

updates after rebase

bf6b5e3

* use new trait fn is_ethereum_address to help determine free txn eli…

a0c3686

…gibility * Pay for 2nd key w/ capacity if ethereum is a low cost transaction. * e2e tests for same.

* Remove README changes

74b2a17

* Rename eligibility function * extract rust tests to own file

change some wording, undo changes that are no longer needed

3a7f5d0

linting, plus upgrade eslint due to crashing/maybe bug

a10f9e7

remove unnecessary benchmark feature config

8f6d7f3

reduce capacity fee instead of weight

68139e9

don't need this check any more b/c we don't have a free extrinsic case

502283c

update to use new ethereum utils library in e2e test. respond to PR c…

0ff2ee2

…omments

shannonwells force-pushed the feat/free-add_key-#2286 branch from 2d60894 to 0ff2ee2 Compare May 23, 2025 01:39

github-actions bot added metadata-changed Metadata has changed since the latest full release and removed metadata-changed Metadata has changed since the latest full release labels May 23, 2025

aramikm approved these changes May 23, 2025

View reviewed changes

JoeCap08055 approved these changes May 23, 2025

View reviewed changes

	/// If the xall matches Msa::add_public_key_to_msa, return the owner account id and msa id
	/// If the call matches Msa::add_public_key_to_msa, return the owner account id and msa id

Subsidize adding an Ethereum compatible control key #2403

Are you sure you want to change the base?

Subsidize adding an Ethereum compatible control key #2403

Uh oh!

Conversation

shannonwells commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Goal

Discussion

Checklist

not applicable

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

codecov bot commented May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

shannonwells May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattheworris left a comment

Choose a reason for hiding this comment

Uh oh!

JoeCap08055 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shannonwells commented May 12, 2025 •

edited

Loading

codecov bot commented May 13, 2025 •

edited

Loading

shannonwells May 22, 2025 •

edited

Loading