remove storage getters in FRAME by muraca · Pull Request #13365 · paritytech/substrate

muraca · 2023-02-11T17:50:39Z

I added the deprecation message, removed every usage of #[pallet::getter] and refactored everything accordingly.
Since a few getters for non-public maps were used in runtime or other situations, I manually wrote those functions and removed the getter.
I generally used the pallet_name::StorageItem::<T>::get() syntax, I don't like the use pallet_name::StorageItem; because it's less explicit.
I removed the getters from the examples, because since we don't want users to use them anymore, I think it's a better UX if we just don't mention them.

Companions:
Cumulus paritytech/substrate#2216
Polkadot TBD

muraca · 2023-02-11T17:55:17Z

I'm sure I missed something, I'll let the tests run to see if there's any errors in pallets.
I also think I need to add some info about the deprecation in the docs of the procedural macro. Any hints?

@shawntabrizi @kianenigma

xlc · 2023-02-11T22:08:24Z

Do we really want to do this like this? This is a big breaking change and will add significantly amount of work to downstream projects for no benefits.

It makes some sense to deprecate the getter syntax, but please don't remove the getters from pallets immediately.

kianenigma · 2023-02-11T22:24:05Z

Do we really want to do this like this? This is a big breaking change and will add significantly amount of work to downstream projects for no benefits.

It makes some sense to deprecate the getter syntax, but please don't remove the getters from pallets immediately.

Indeed, as per the original issue:

... for now mark them as deprecated, and just remove all usage in substrate.

muraca · 2023-02-12T10:05:06Z

No problem then, I'll revert those changes!

muraca · 2023-02-13T21:18:20Z

Polkadot and Cumulus tests fail because of a missing SetMembersOrigin in pallet collective. It was added yesterday in PR #13159. I rebased and will let the checks tell me if something has broken.

shawntabrizi

looks like the right direction to me

shawntabrizi · 2023-02-20T21:37:32Z

... for now mark them as deprecated, and just remove all usage in substrate.

I think this is how @muraca already approached this problem, but better to just manually implement all the getters on existing pallets, and no need to really mark anything as deprecated. Basically, this is just some legacy debt that probably will stick around, but has little impact.

frame/support/procedural/src/pallet/expand/storage.rs

kianenigma · 2023-03-10T15:25:12Z

Please don't close the linked issue with this PR, as we still need to revisit this and make sure we remove the code after some time has passed.

Polkadot-Forum · 2023-03-10T15:40:36Z

This pull request has been mentioned on Polkadot Forum. There might be relevant details there:

https://forum.polkadot.network/t/less-magic-in-frame-good-or-bad/2287/1

kianenigma · 2023-03-19T02:15:31Z

@muraca rebase please?

altaua · 2023-03-29T18:16:27Z

this needs to be rebased on current master, there have been breaking changes to the check-crate-publishing job.

kianenigma · 2023-04-11T09:07:29Z

@liamaharon / @gupnik if @muraca does not show up, can either of you push this to the finish line? Seems like it is mostly done.

We can mark PR as "made with ❤️ by PBA students" :))

liamaharon · 2023-04-11T09:39:49Z

@liamaharon / @gupnik if @muraca does not show up, can either of you push this to the finish line? Seems like it is mostly done.

We can mark PR as "made with ❤️ by PBA students" :))

I just spoke with @gupnik, I can take it on if we don't hear from @muraca before next week

atenjin · 2023-04-12T09:46:07Z

frame/sudo/src/lib.rs

Hi for the pallet-sudo, the definition for the Key is under super scope limitation.
Maybe you forget to remove the getter for the key, but all in all, if you plan to remove getter for the storage Key, please at least make the Key to be pub. Because in many projects including our, we use the sudo key to check something in other pallets. So that for this pr modification, we need to let the sudo key can be accessed from outside, I advise you to choose the following two way:

let the storage Key to be public;

write a function key() to return this storage, impl same logic as getter function.

The key function is not going to be removed as of now, but the auto-generated getter is being deprecated.
I can speculate about what might happen in the future, I think that somebody will "manually" implement such getters, and remove the pallet::getter from the pallets, but from what I understood it's going to take a while.
cc @kianenigma

Yes, I mean when remove the getter for Key, please do not forget to let it be pub or implement the getter manually, otherwise we need to create another pr to add it.
Thanks

@muraca I see that this pallet-sudo already remove this getter, so please do not forget to add this getter by manual or let the Key be pub

I have not removed the #[pallet::getter(fn key)] line. See here.

so can you add this function in this pallet-sudo? otherwise it will breaking many thing in our projects ? @muraca

pub fn key() -> Option<T::AccountId>{ Key::<T>::get() }

I think it's very necessary! otherwise there is no way to get the sudo key from this pallet!

xlc · 2023-04-12T15:39:27Z

why is this removing getters instead of deprecate them?

muraca · 2023-04-12T15:47:49Z

@xlc as per request, I added a deprecation message and removed every usage of the auto-generated functions

xlc · 2023-04-12T15:53:12Z

But the getter is still removed? There shouldn't be any companions PR required for this PR.

bkchr · 2023-04-12T15:58:38Z

But the getter is still removed? There shouldn't be any companions PR required for this PR.

Ahh yeah good point, we should first deprecate the usage before removing the actual calls.

muraca · 2023-04-12T20:12:48Z

But the getter is still removed?

@xlc I'm not sure I understood what you're asking. I'm not actually removing any of the getter functions, it just shows a warning message if you try to use one.

I was told I should not leave any warning behind, so I removed all the calls to said auto-generated functions in the FRAME pallets, and I did the same for the Cumulus repository.
For the same reason, I had to replace some of the auto-generated getters, for example Aura's fn authorities, because it is used somewhere you can't call pallet_aura::Authorities::<T>::get().

bkchr · 2023-04-12T21:24:19Z

Ahh yeah, thank you @muraca!

xlc

ok I think you do the correct thing for most of the pallets but may have missed a few others.

My suggestion: always avoid hugh PR if possible. This is no reason that you need to update every pallet in a single PR. This makes review impossible (Github struggling to render diff and very time comsuming for reviews).

xlc · 2023-04-12T23:35:16Z

frame/balances/src/lib.rs


 	/// The total units issued in the system.
 	#[pallet::storage]
-	#[pallet::getter(fn total_issuance)]


this is still removed?

A method with the same name and return value is implemented in Currency and fungible::Inspect

frame/alliance/src/tests.rs

frame/aura/src/lib.rs

frame/babe/src/lib.rs

frame/system/src/lib.rs

frame/treasury/src/lib.rs

Signed-off-by: muraca <mmuraca247@gmail.com>

paritytech-cicd-pr · 2023-04-19T11:11:23Z

The CI pipeline was cancelled due to failure one of the required jobs.
Job name: test-linux-stable
Logs: https://gitlab.parity.io/parity/mirrors/substrate/-/jobs/2702142

stale · 2023-07-12T11:15:12Z

Hey, is anyone still working on this? Due to the inactivity this issue has been automatically marked as stale. It will be closed if no further activity occurs. Thank you for your contributions.

juangirini · 2023-07-12T12:36:21Z

@muraca unfortunately this got behind master massively, would you take this over?

muraca · 2023-07-12T12:43:03Z

Hey @juangirini as far as I remember it was decided not to proceed with this deprecation at the moment.
If you're sure that this should be done right now, please let me know, and I'll go through the code again in the next few days.

stale · 2023-08-11T13:50:09Z

Hey, is anyone still working on this? Due to the inactivity this issue has been automatically marked as stale. It will be closed if no further activity occurs. Thank you for your contributions.

muraca requested review from acatangiu, andresilva and kianenigma as code owners February 11, 2023 17:50

kianenigma added the A0-please_review label Feb 11, 2023

the-right-joyce added A0-please_review Pull request needs code review. and removed A0-please_review labels Feb 13, 2023

shawntabrizi approved these changes Feb 20, 2023

View reviewed changes

shawntabrizi reviewed Feb 20, 2023

View reviewed changes

frame/support/procedural/src/pallet/expand/storage.rs Outdated Show resolved Hide resolved

muraca mentioned this pull request Feb 20, 2023

remove every usage of #[pallet::getter] paritytech/cumulus#2216

Closed

muharem mentioned this pull request Mar 16, 2023

feat: pallet asset-rate #13608

Merged

4 tasks

muraca requested a review from a team March 19, 2023 10:18

muharem mentioned this pull request Mar 23, 2023

Pallets: Treasury spend() should use Pay trait #13607

Closed

1 task

koushiro mentioned this pull request Mar 31, 2023

chore: remove deprecated storage getter for all pallets polkadot-evm/frontier#1034

Merged

atenjin reviewed Apr 12, 2023

View reviewed changes

xlc reviewed Apr 12, 2023

View reviewed changes

liamaharon reviewed Apr 13, 2023

View reviewed changes

liamaharon approved these changes Apr 13, 2023

View reviewed changes

deprecate and remove every usage of #[pallet::getter]

aa6b084

Signed-off-by: muraca <mmuraca247@gmail.com>

ggwpez mentioned this pull request Aug 24, 2023

Vision: Pallet syntax improvement paritytech/polkadot-sdk#187

Open

7 tasks

juangirini assigned juangirini and muraca and unassigned juangirini May 22, 2023

Dinonard mentioned this pull request Jun 6, 2023

[DO NOT MERGE] Update to polkadot-v0.9.40 AstarNetwork/astar-frame#159

Closed

2 tasks

juangirini added the T1-runtime This PR/Issue is related to the topic “runtime”. label Jun 12, 2023

kianenigma mentioned this pull request Jun 19, 2023

Parameters pallet paritytech/polkadot-sdk#169

Closed

stale bot added the A3-stale label Jul 12, 2023

stale bot removed the A3-stale label Jul 12, 2023

stale bot added the A3-stale label Aug 11, 2023

stale bot removed the A3-stale label Aug 24, 2023

muraca closed this by deleting the head repository Aug 26, 2025

Conversation

muraca commented Feb 11, 2023 • edited by juangirini Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

muraca commented Feb 11, 2023

Uh oh!

xlc commented Feb 11, 2023

Uh oh!

kianenigma commented Feb 11, 2023

Uh oh!

muraca commented Feb 12, 2023

Uh oh!

muraca commented Feb 13, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

shawntabrizi left a comment

Choose a reason for hiding this comment

Uh oh!

shawntabrizi commented Feb 20, 2023

Uh oh!

Uh oh!

kianenigma commented Mar 10, 2023

Uh oh!

Polkadot-Forum commented Mar 10, 2023

Uh oh!

kianenigma commented Mar 19, 2023

Uh oh!

altaua commented Mar 29, 2023

Uh oh!

kianenigma commented Apr 11, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

liamaharon commented Apr 11, 2023

Uh oh!

atenjin Apr 12, 2023

Choose a reason for hiding this comment

Uh oh!

muraca Apr 12, 2023

Choose a reason for hiding this comment

Uh oh!

atenjin Apr 14, 2023

Choose a reason for hiding this comment

Uh oh!

atenjin Apr 14, 2023

Choose a reason for hiding this comment

Uh oh!

muraca Apr 14, 2023

Choose a reason for hiding this comment

Uh oh!

atenjin Apr 17, 2023 • 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!

xlc commented Apr 12, 2023

Uh oh!

muraca commented Apr 12, 2023

Uh oh!

xlc commented Apr 12, 2023

Uh oh!

bkchr commented Apr 12, 2023

Uh oh!

muraca commented Apr 12, 2023

Uh oh!

bkchr commented Apr 12, 2023

Uh oh!

xlc left a comment

Choose a reason for hiding this comment

Uh oh!

xlc Apr 12, 2023

Choose a reason for hiding this comment

Uh oh!

muraca Apr 13, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

muraca commented Feb 11, 2023 •

edited by juangirini

Loading

muraca commented Feb 13, 2023 •

edited

Loading

kianenigma commented Apr 11, 2023 •

edited

Loading

atenjin Apr 17, 2023 •

edited

Loading