Full Unbond in Staking #3811

dharjeezy · 2024-03-24T14:56:49Z

closes #414

Polkadot address: 12GyGD3QhT4i2JJpNzvMf96sxxBLWymz4RdGCxRH5Rj5agKW

test and benchmark

dharjeezy · 2024-03-24T15:22:21Z

@Ank4n according to @kianenigma we want to fully unbond everything after chilling. Therefore, the extrinsic don't need to take any value, also there will be no need to add a check for minimum active bond which you suggested earlier here. #3629 (comment)

Also, if we want to do a chill also when we expect a value, we can definitely do that in the unbond extrinsic. should i go ahead and include that?

Ank4n · 2024-03-27T18:57:02Z

@kianenigma wdyt about call::unbond doing chill implicitly if it is a full unbond (unbond value == ledger.total)?

kianenigma · 2024-03-31T09:41:36Z

@kianenigma wdyt about call::unbond doing chill implicitly if it is a full unbond (unbond value == ledger.total)?

This is also fine with me, no strong opinion. I like your idea better as it improves UX without wallets needing to do much.

dharjeezy · 2024-03-31T13:15:09Z

OK. So, should we still keep the full unbond extrinsic and also implement the implicit one that @Ank4n is suggesting?

# Conflicts: # polkadot/runtime/westend/src/weights/pallet_staking.rs # substrate/frame/staking/src/benchmarking.rs # substrate/frame/staking/src/pallet/impls.rs # substrate/frame/staking/src/pallet/mod.rs # substrate/frame/staking/src/weights.rs

# Conflicts: # Cargo.lock

dharjeezy · 2024-04-10T12:15:36Z

@Ank4n @kianenigma
I have implicitly added the chill for unbonding

please help review again

…re unbonding all amount

kianenigma

Looks good, needs more tests (for unbond fully calling chill) and better prdoc and bench etc.

Ank4n

Looking good. I am happy to approve once you fix the default pallet::weight for fn unbond. Few other suggestions but those are just nits.

Ank4n · 2024-09-18T12:02:05Z

substrate/frame/staking/src/pallet/mod.rs

@@ -1094,86 +1094,21 @@ pub mod pallet {
 			#[pallet::compact] value: BalanceOf<T>,
 		) -> DispatchResultWithPostInfo {
 			let controller = ensure_signed(origin)?;
-			let unlocking =


github doesn't allow me to add comment on the non changed line 1090 so adding here.

Add chill weight to the call so in worst case it always adds chill weight.

#[pallet::call_index(2)] #[pallet::weight( T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()) .saturating_add(T::WeightInfo::Chill())) ]

Additional info: Before any transaction this fund is reserved, and any difference in the PostInfo is refunded. So this should always contain the worst case weight.

Ank4n · 2024-09-18T12:04:22Z

substrate/frame/staking/src/pallet/mod.rs

-				Self::deposit_event(Event::<T>::Unbonded { stash, amount: value });
+			if value >= ledger.total {
+				Self::chill_stash(&ledger.stash);
+				total_weight = total_weight.saturating_add(T::WeightInfo::chill());


nit

Suggested change

total_weight = total_weight.saturating_add(T::WeightInfo::chill());

total_weight.saturating_accrue(T::WeightInfo::chill());

Ank4n · 2024-09-18T12:08:23Z

substrate/frame/staking/src/tests.rs

+		assert_eq!(*staking_events().last().unwrap(), Event::Unbonded { stash: 11, amount: 1000 });
+		assert_eq!(
+			*staking_events().get(staking_events().len() - 2).unwrap(),
+			Event::Chilled { stash: 11 }
+		);
+	})


nit: would be lot nicer to assert against all events (see this) or do a match (see this)

Ank4n · 2024-10-08T18:01:03Z

bot fmt

command-bot · 2024-10-08T18:01:08Z

@Ank4n https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7537093 was started for your command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh". Check out https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/pipelines?page=1&scope=all&username=group_605_bot to know what else is being executed currently.

Comment bot cancel 27-5680a312-e6a2-4dde-a768-20aeb25c933c to cancel this command or bot cancel to cancel all commands in this pull request.

Ank4n · 2024-10-08T18:01:48Z

cc: @gpestana

command-bot · 2024-10-08T18:05:12Z

@Ank4n Command "$PIPELINE_SCRIPTS_DIR/commands/fmt/fmt.sh" has finished. Result: https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7537093 has finished. If any artifacts were generated, you can download them from https://gitlab.parity.io/parity/mirrors/polkadot-sdk/-/jobs/7537093/artifacts/download.

gpestana

I left a few nits and suggestions which when included should wrap up this PR, thanks!

gpestana · 2024-10-25T11:36:29Z

substrate/frame/staking/src/pallet/mod.rs

@@ -1087,93 +1087,28 @@ pub mod pallet {
 		/// See also [`Call::withdraw_unbonded`].
 		#[pallet::call_index(2)]
 		#[pallet::weight(
-            T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()))
+            T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()).saturating_add(T::WeightInfo::chill()))


Suggested change

T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()).saturating_add(T::WeightInfo::chill()))

T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS)

.saturating_add(T::WeightInfo::unbond())

.saturating_add(T::WeightInfo::chill()))

Or something along these lines. Have you ran rustfmt against the current code? At least the clippy CI job seems to be failing.

I actually ran cargo +nightly fmt before pushing.

gpestana · 2024-10-25T11:44:20Z

substrate/frame/staking/src/pallet/mod.rs

+			if value >= ledger.total {
+				Self::chill_stash(&ledger.stash);
+				total_weight.saturating_accrue(T::WeightInfo::chill());


Suggested change

if value >= ledger.total {

Self::chill_stash(&ledger.stash);

total_weight.saturating_accrue(T::WeightInfo::chill());

let mut total_weight = if value >= ledger.total {

Self::chill_stash(&ledger.stash);

T::WeightInfo::chill()

} else {

Zero::zero()

};

nit but how about this? then we can remove let mut total_weight instantiation from line 1100 (but do not forget to saturate_accrue the weight of unbound at the end (line 1111).

gpestana · 2024-10-25T11:51:55Z

substrate/frame/staking/src/tests.rs

+#[test]
+fn unbond_with_chill_works() {
+	// Should test:
+	// * Given an account being bonded [and chosen as a validator](not mandatory)


Suggested change

// * Given an account being bonded [and chosen as a validator](not mandatory)

// * Given a abounded account,

gpestana · 2024-10-25T11:53:34Z

substrate/frame/staking/src/pallet/mod.rs

@@ -1087,93 +1087,28 @@ pub mod pallet {
 		/// See also [`Call::withdraw_unbonded`].
 		#[pallet::call_index(2)]
 		#[pallet::weight(
-            T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()))
+            T::WeightInfo::withdraw_unbonded_kill(SPECULATIVE_NUM_SPANS).saturating_add(T::WeightInfo::unbond()).saturating_add(T::WeightInfo::chill()))


Could you also update the rustdoc of this callable and mention that the stash may be chilled if the ledger total amount falls to 0 after unbonding?

gpestana · 2024-10-25T11:55:04Z

substrate/frame/staking/src/tests.rs

+		let res = Staking::unbond(RuntimeOrigin::signed(11), 1000);
+		assert!(res.is_ok());


Suggested change

let res = Staking::unbond(RuntimeOrigin::signed(11), 1000);

assert!(res.is_ok());

assert_ok!(Staking::unbond(RuntimeOrigin::signed(11), 1000));

This is cleaner and common practice in frame.

gpestana · 2024-10-25T11:57:52Z

substrate/frame/staking/src/tests.rs

+				Event::Unbonded { stash: 11, amount: 1000 }
+			]
+		));
+	})


One last check is to ensure that the stash is actually chilled instead of only relying on the events above. e.g.

assert!(Nominators::<Test>::get(11).is_none()); assert!(Validators::<Test>::get(11).is_none());

i have done this

gpestana · 2024-10-25T11:59:25Z

prdoc/pr_3811.prdoc

+      Modifies the `unbond` extrinsic by forcefully chilling and unbonding the full value
+      if the value to be unbonded is the total of what is bonded


Suggested change

Modifies the `unbond` extrinsic by forcefully chilling and unbonding the full value

if the value to be unbonded is the total of what is bonded

Modifies the `unbond` extrinsic to forcefully chill stash when unbonding

if the value to be unbonded is the total of what is bonded.

# Conflicts: # substrate/frame/staking/src/pallet/mod.rs

dharjeezy · 2024-11-23T13:44:01Z

@gpestana can you please help with review so this can be closed out?

dharjeezy added 5 commits March 24, 2024 15:54

force unbond in staking

c6e4c93

check to see if controller wants to fully unbond

12e62a9

test and benchmark

comment

345b2fa

unimplemented force_unbond

0b8ef9e

full unbond instead

df5c186

dharjeezy changed the title ~~Dami/full unbond~~ Full Unbond in Staking Mar 24, 2024

dharjeezy mentioned this pull request Mar 24, 2024

force unbond in staking #3629

Closed

dharjeezy requested review from athei, acatangiu, andresilva, sorpaas, cheme, a team and koute as code owners April 9, 2024 09:13

paritytech-review-bot bot requested a review from a team April 9, 2024 09:14

dharjeezy force-pushed the dami/full_unbond branch from f6032b7 to df5c186 Compare April 9, 2024 09:17

dharjeezy added 4 commits April 9, 2024 16:13

implicit chill when unbonding

66d9b61

fmt

0292c5f

Merge remote-tracking branch 'origin/master' into dami/full_unbond

9db89f3

# Conflicts: # Cargo.lock

no need for outright chill since unbond does chilling implicitly befo…

4d449bf

…re unbonding all amount

kianenigma reviewed Apr 11, 2024

View reviewed changes

Ank4n and others added 3 commits September 16, 2024 21:53

Merge branch 'master' into dami/full_unbond

30015c7

revert

4536363

fmt

06e8563

Ank4n reviewed Sep 18, 2024

View reviewed changes

Ank4n requested a review from gpestana September 18, 2024 12:14

dharjeezy added 2 commits October 3, 2024 18:48

code review changes

2fc715a

fmt

766458c

dharjeezy requested a review from Ank4n October 3, 2024 17:49

Merge branch 'master' into dami/full_unbond

16f6535

Ank4n approved these changes Oct 8, 2024

View reviewed changes

Merge branch 'master' into dami/full_unbond

280c3a1

Merge branch 'master' into dami/full_unbond

bcc222d

Ank4n requested review from gpestana and removed request for andresilva and gpestana October 24, 2024 11:53

gpestana reviewed Oct 25, 2024

View reviewed changes

dharjeezy added 4 commits October 26, 2024 09:16

nits

9c62abc

Merge branch 'master' into dami/full_unbond

1ea562f

nit

30b23d1

nit

05f25f9

dharjeezy requested a review from gpestana October 26, 2024 11:21

kianenigma removed their request for review October 30, 2024 19:15

dharjeezy added 3 commits November 23, 2024 11:39

Merge remote-tracking branch 'origin/master' into dami/full_unbond

d7e3cac

# Conflicts: # substrate/frame/staking/src/pallet/mod.rs

fix merge conflicts

c47d381

fmt

67034ab

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Full Unbond in Staking #3811

Full Unbond in Staking #3811

dharjeezy commented Mar 24, 2024 •

edited

Loading

dharjeezy commented Mar 24, 2024

Ank4n commented Mar 27, 2024

kianenigma commented Mar 31, 2024

dharjeezy commented Mar 31, 2024

dharjeezy commented Apr 10, 2024 •

edited

Loading

kianenigma left a comment

Ank4n left a comment

Ank4n Sep 18, 2024

Ank4n Sep 18, 2024

Ank4n Sep 18, 2024

Ank4n commented Oct 8, 2024

command-bot bot commented Oct 8, 2024 •

edited

Loading

Ank4n commented Oct 8, 2024

command-bot bot commented Oct 8, 2024

gpestana left a comment

gpestana Oct 25, 2024

dharjeezy Oct 26, 2024 •

edited

Loading

gpestana Oct 25, 2024

gpestana Oct 25, 2024

gpestana Oct 25, 2024

gpestana Oct 25, 2024

gpestana Oct 25, 2024

dharjeezy Oct 26, 2024

gpestana Oct 25, 2024

dharjeezy commented Nov 23, 2024

	total_weight = total_weight.saturating_add(T::WeightInfo::chill());
	total_weight.saturating_accrue(T::WeightInfo::chill());

	// * Given an account being bonded [and chosen as a validator](not mandatory)
	// * Given a abounded account,

		let res = Staking::unbond(RuntimeOrigin::signed(11), 1000);
		assert!(res.is_ok());

	let res = Staking::unbond(RuntimeOrigin::signed(11), 1000);
	assert!(res.is_ok());
	assert_ok!(Staking::unbond(RuntimeOrigin::signed(11), 1000));

		Modifies the `unbond` extrinsic by forcefully chilling and unbonding the full value
		if the value to be unbonded is the total of what is bonded

Full Unbond in Staking #3811

Are you sure you want to change the base?

Full Unbond in Staking #3811

Conversation

dharjeezy commented Mar 24, 2024 • edited Loading

dharjeezy commented Mar 24, 2024

Ank4n commented Mar 27, 2024

kianenigma commented Mar 31, 2024

dharjeezy commented Mar 31, 2024

dharjeezy commented Apr 10, 2024 • edited Loading

kianenigma left a comment

Choose a reason for hiding this comment

Ank4n left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Ank4n commented Oct 8, 2024

command-bot bot commented Oct 8, 2024 • edited Loading

Ank4n commented Oct 8, 2024

command-bot bot commented Oct 8, 2024

gpestana left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dharjeezy Oct 26, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dharjeezy commented Nov 23, 2024

dharjeezy commented Mar 24, 2024 •

edited

Loading

dharjeezy commented Apr 10, 2024 •

edited

Loading

command-bot bot commented Oct 8, 2024 •

edited

Loading

dharjeezy Oct 26, 2024 •

edited

Loading