remove storage getters in FRAME #13365

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

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

@@ -362,7 +362,6 @@ pub mod pallet {

 	/// 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 <[email protected]>

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 kianenigma, acatangiu and andresilva as code owners February 11, 2023 17:50

muraca force-pushed the issue/13259 branch 7 times, most recently from 5538376 to e66328e Compare February 11, 2023 21:01

kianenigma added the A0-please_review label Feb 11, 2023

muraca force-pushed the issue/13259 branch from e66328e to c4d8ef4 Compare February 13, 2023 09:42

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

muraca force-pushed the issue/13259 branch 2 times, most recently from ef77421 to 2450e79 Compare February 20, 2023 20:59

muraca force-pushed the issue/13259 branch from 2450e79 to cf76115 Compare February 20, 2023 21:31

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

atenjin reviewed Apr 12, 2023

View reviewed changes

muraca force-pushed the issue/13259 branch from 6cd25b4 to 3af83a5 Compare April 12, 2023 15:08

xlc reviewed Apr 12, 2023

View reviewed changes

liamaharon reviewed Apr 13, 2023

View reviewed changes

muraca force-pushed the issue/13259 branch from 3af83a5 to a65c223 Compare April 13, 2023 09:28

liamaharon approved these changes Apr 13, 2023

View reviewed changes

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

aa6b084

Signed-off-by: muraca <[email protected]>

muraca force-pushed the issue/13259 branch from a65c223 to aa6b084 Compare April 19, 2023 11:06

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

remove storage getters in FRAME #13365

remove storage getters in FRAME #13365

muraca commented Feb 11, 2023 •

edited by juangirini

Loading

muraca commented Feb 11, 2023

xlc commented Feb 11, 2023

kianenigma commented Feb 11, 2023

muraca commented Feb 12, 2023

muraca commented Feb 13, 2023 •

edited

Loading

shawntabrizi left a comment

shawntabrizi commented Feb 20, 2023

atenjin Apr 12, 2023

muraca Apr 12, 2023

atenjin Apr 14, 2023

atenjin Apr 14, 2023

muraca Apr 14, 2023

atenjin Apr 17, 2023 •

edited

Loading

xlc commented Apr 12, 2023

muraca commented Apr 12, 2023

xlc commented Apr 12, 2023

bkchr commented Apr 12, 2023

muraca commented Apr 12, 2023

bkchr commented Apr 12, 2023

xlc left a comment

xlc Apr 12, 2023

muraca Apr 13, 2023

paritytech-cicd-pr commented Apr 19, 2023

stale bot commented Jul 12, 2023

juangirini commented Jul 12, 2023

muraca commented Jul 12, 2023

stale bot commented Aug 11, 2023

remove storage getters in FRAME #13365

Are you sure you want to change the base?

remove storage getters in FRAME #13365

Conversation

muraca commented Feb 11, 2023 • edited by juangirini Loading

muraca commented Feb 11, 2023

xlc commented Feb 11, 2023

kianenigma commented Feb 11, 2023

muraca commented Feb 12, 2023

muraca commented Feb 13, 2023 • edited Loading

shawntabrizi left a comment

Choose a reason for hiding this comment

shawntabrizi commented Feb 20, 2023

atenjin Apr 12, 2023

Choose a reason for hiding this comment

muraca Apr 12, 2023

Choose a reason for hiding this comment

atenjin Apr 14, 2023

Choose a reason for hiding this comment

atenjin Apr 14, 2023

Choose a reason for hiding this comment

muraca Apr 14, 2023

Choose a reason for hiding this comment

atenjin Apr 17, 2023 • edited Loading

Choose a reason for hiding this comment

xlc commented Apr 12, 2023

muraca commented Apr 12, 2023

xlc commented Apr 12, 2023

bkchr commented Apr 12, 2023

muraca commented Apr 12, 2023

bkchr commented Apr 12, 2023

xlc left a comment

Choose a reason for hiding this comment

xlc Apr 12, 2023

Choose a reason for hiding this comment

muraca Apr 13, 2023

Choose a reason for hiding this comment

paritytech-cicd-pr commented Apr 19, 2023

stale bot commented Jul 12, 2023

juangirini commented Jul 12, 2023

muraca commented Jul 12, 2023

stale bot commented Aug 11, 2023

muraca commented Feb 11, 2023 •

edited by juangirini

Loading

muraca commented Feb 13, 2023 •

edited

Loading

atenjin Apr 17, 2023 •

edited

Loading