Feat/15886093 reputation cancel #3322

CzarekDryl · 2024-10-14T11:34:49Z

Description

This PR introduces options for penalizing or not penalizing the cancellation of staked payments. It also implements a reputation method for canceling after the locked state and the handling of multiple cancellation requests.

Testing

Install Reputation Weighted extension
Create advanced payment using both permissions and staking method
Lock it and then cancel the payment

Main issue - #2256

jakubcolony · 2024-10-17T22:06:13Z

@CzarekDryl looks like it needs another rebase on master

CzarekDryl · 2024-10-23T08:23:07Z

@jakubcolony @arrenv Branch rebased and ready to review

arrenv

@CzarekDryl Thank you for the work on this, and your patience. I have noticed a couple of things.

This translation error appeared when the Advanced payment was created.
Two cancelled pills appeared, there should be only one pill in the timeline.
The staking decision method does not trigger the transaction to create the payment.
Cancelling with Reputation after the Funding step resulted in the following, you should still be able to cancel after funding and the cancel pill should appear after the funding step.

iamsamgibbs

Nice start of this, I'm able to get through the entire flow.

There is an issue that if you reject the first motion and start another one, when the cancel step reappears it loads into the first motion rather than the staking stage of the second one, so it looks like it is in a broken state.

And I'm experiencing the same issue as Arren when attempting to cancel after the funding stage.

It also seemed odd that the cancel motion step completely disappears if you reject the motion, I think you should still be able to access the failed motions and the step should remain visible, especially if there are unclaimed stakes / rewards.

arrenv

@CzarekDryl Thank you for your hard work on this. I noticed a few things while testing:

Canceling with Permissions after the Review stage resulted in the first incomplete action timeline, and if after funding, the second screenshot.
Can these have a hover state when there are multiple cancellation requests:
In this case I created a motion to cancel the action, then while voting I used Permissions to cancel it right away. It cancelled correctly but stayed in this view. Is it possible to remove all the following steps in the timeline and show a message in this case. Something like this Figma link.
I saw this error in console when revealing a vote:
It seems if there are any still running motions then the extra steps in the timeline persists, despite a motion already passing and being finalized and the action being cancelled. It should remove all steps if the action has been cancelled.
Claiming staked tokens shows this broken pending button, however, is it possible to auto return this stakes when cancelling?
Cancelling with permissions with no penalty showed this timeline, it should have the step label be "Cancel", as the stakes have already be returned, the text should be "The action was canceled and cannot be executed."

Figma link showing expected designs

While testing, I noticed that we a missing the indicator as to whether the cancellation motion is penalising or not, can we add a pill to a motion item like this design? Figma link.

CzarekDryl · 2024-12-11T14:25:48Z

@arrenv Everything should be fixed now, please check it again. Penalty badge added to cancel request item.

jakubcolony

Thanks for your work on this PR @CzarekDryl, generally most of the functionality is there, but I spotted a few issues.

There appears to be regression around how cancel in review step is displayed:

master for comparison:

The note in the Cancel modal should display the actual role held by the user instead of hardcoded Payer:

I was able to get into a broken state by quickly funding or releasing a payment while the funding motion was loading. The UI should be disabled during that period:

Screen.Recording.2024-12-11.at.23.02.55.mov

When cancelling a staked expenditure with penalise option, the modal gets stuck in Pending. There are errors in the console which are most likely due to the fact the UI is trying to reclaim stake (which has been forfeited) - I commented on where I think it happens in code.

The same thing happens with cancelling via motions, on motion finalization.

Penalise badge has a border that is not in the designs:

Figma

- UI

Other flows tested which mostly work well:

Cancelling via permissions, non-staked expenditure:

At Funding:

At Release:

Cancelling via reputation, non-staked expenditure:

Cancelling via permissions, staked:

Cancelling via reputation, staked expenditure:

jakubcolony · 2024-12-11T23:09:34Z

...nents/v5/common/CompletedAction/partials/PaymentBuilder/partials/CancelModal/CancelModal.tsx

+        if (penalise) {
+          await cancelStakedExpenditureViaMotion(stakedMotionPayload);
+        } else {
+          await cancelExpenditureViaMotion(motionPayload);
+        }


Which saga to use should not depend on penalise but rather on the expenditure type - if staked, cancelStakedExpenditureViaMotion should always be used. You can pass the penalise as shouldPunish param to the saga.

jakubcolony · 2024-12-11T23:10:32Z

...nents/v5/common/CompletedAction/partials/PaymentBuilder/partials/CancelModal/CancelModal.tsx

+      } else if (penalise) {
+        await cancelStakedExpenditure(stakedPayload);
+        await reclaimExpenditureStake(reclaimPayload);
+      } else {


Similarly here, cancelStakedExpenditure should always be used for staked expenditure regardless of penalise value.

Also, if creator was penalised, they lost their stake, so there is nothing to claim.

jakubcolony · 2024-12-11T23:21:46Z

...common/CompletedAction/partials/PaymentBuilder/partials/CancelRequests/CancelRequestItem.tsx

@@ -0,0 +1,80 @@
+import clsx from 'clsx';


Is there a way to reuse code from similar components? Composition via props could be used for elements specific to this type of action, e.g. the penalise badges.

@jakubcolony Can we do this in other issue and refactor all request items?

jakubcolony · 2024-12-11T23:41:21Z

Just a note this PR will most likely have a conflict with #3922 as the designs have been updated (as per #3776).

CzarekDryl · 2024-12-12T12:10:01Z

@jakubcolony Everything should be fixed, please check it :)

arrenv

Nice one @CzarekDryl, it is looking and working really well.

I did still run into a couple of things, not sure if they should be tackled in this PR.

If created using staking, and when finalizing a cancelation or using permissions to cancel I received this transaction error in the console.
If cancelling with Permissions and penalising, or not, it does not show which option was selected in the card, where it has been added when you use Reputation.
I received this error in the console when trying to stake, despite having more then enough tokens to stake.

CzarekDryl · 2024-12-17T13:19:14Z

@arrenv I've added badge while using permissions and it's in finalize pill

And I'm not able to replicate console errors:

Screen.Recording.2024-12-17.at.13.44.48.mov

Screen.Recording.2024-12-13.at.14.47.47.mov

arrenv

Thank you @CzarekDryl, looking great, tested all scenarios I could think of and all works as expected.

An active motion with a cancelled motion

Cancelling working correctly

Reputation and cancel, penalise and not

arrenv · 2024-12-18T12:19:36Z

I have just seen this @CzarekDryl, is this related to this PR?

CzarekDryl · 2024-12-18T14:40:14Z

@arrenv I've checked and all descriptions work fine for me

arrenv

Re-approving after a rebase

jakubcolony

Thanks for another round of changes @CzarekDryl, mostly looking good but I'm still seeing some issues with staked expenditure.

When cancelling using permissions, the cards are different depending on whether the creator was punished or not.

If punished, no label is displayed informing of this:

If not punished, an extra Finalize step is added to the stepper:

It appears that the UI is still trying to reclaim the stake even though the payment creator was penalised, leading to some errors in the console:

I am still able to click around the UI while the cancel modal is in pending state. That's how I got the "Paid" label as well as a cancellation request in progress:

Otherwise, things are working well:

fix after rebase fix: translations, duplicated steps fix: cancel step fixes after rebase fix: auto claim, stepper Feat: Add willPunishExpenditureStaker field to colony motion feat: add penalty badge fix: pending buttons, penalise saga fix: types fix: permission badge

CzarekDryl · 2024-12-20T14:12:10Z

@jakubcolony All fixed

CzarekDryl self-assigned this Oct 14, 2024

CzarekDryl requested review from a team as code owners October 14, 2024 11:34

CzarekDryl changed the base branch from master to feat/advanced-payments October 14, 2024 11:36

jakubcolony force-pushed the feat/advanced-payments branch from c0099a8 to c60c833 Compare October 14, 2024 22:02

Base automatically changed from feat/advanced-payments to master October 14, 2024 22:14

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch from 87e902e to f782dda Compare October 21, 2024 07:44

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch 2 times, most recently from 4113c5c to 255d868 Compare October 29, 2024 14:37

arrenv requested changes Nov 6, 2024

View reviewed changes

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch from 255d868 to b0a6149 Compare November 12, 2024 12:32

iamsamgibbs requested changes Nov 14, 2024

View reviewed changes

CzarekDryl requested review from iamsamgibbs and arrenv November 18, 2024 12:55

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch 2 times, most recently from 957a3a5 to d01637e Compare November 29, 2024 12:46

arrenv requested changes Dec 3, 2024

View reviewed changes

This was referenced Dec 10, 2024

Feat: Add willPunishExpenditureStaker field to colony motion JoinColony/block-ingestor#302

Open

Feat: Add willPunishExpenditureStaker field to colony motion #3915

Merged

CzarekDryl requested a review from arrenv December 11, 2024 14:25

jakubcolony requested changes Dec 11, 2024

View reviewed changes

CzarekDryl requested a review from jakubcolony December 12, 2024 12:10

arrenv requested changes Dec 13, 2024

View reviewed changes

CzarekDryl requested a review from arrenv December 17, 2024 13:20

jakubcolony mentioned this pull request Dec 18, 2024

Fix styling for a single finalize expenditure motion #3967

Open

arrenv previously approved these changes Dec 18, 2024

View reviewed changes

CzarekDryl dismissed arrenv’s stale review via 6263a83 December 18, 2024 13:47

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch from 22e07b0 to 6263a83 Compare December 18, 2024 13:47

CzarekDryl requested a review from arrenv December 18, 2024 14:40

arrenv previously approved these changes Dec 18, 2024

View reviewed changes

jakubcolony requested changes Dec 19, 2024

View reviewed changes

CzarekDryl dismissed arrenv’s stale review via 0b9ce27 December 20, 2024 11:45

CzarekDryl force-pushed the feat/15886093-reputation-cancel branch from 6263a83 to 0b9ce27 Compare December 20, 2024 11:45

fix: reclaim, badge

8747f5f

CzarekDryl requested a review from jakubcolony December 20, 2024 14:12

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/15886093 reputation cancel #3322

Feat/15886093 reputation cancel #3322

CzarekDryl commented Oct 14, 2024

jakubcolony commented Oct 17, 2024

CzarekDryl commented Oct 23, 2024

arrenv left a comment •

edited

Loading

iamsamgibbs left a comment

arrenv left a comment

CzarekDryl commented Dec 11, 2024

jakubcolony left a comment

jakubcolony Dec 11, 2024

jakubcolony Dec 11, 2024

jakubcolony Dec 11, 2024

CzarekDryl Dec 12, 2024

jakubcolony commented Dec 11, 2024

CzarekDryl commented Dec 12, 2024

arrenv left a comment

CzarekDryl commented Dec 17, 2024 •

edited

Loading

arrenv left a comment

arrenv commented Dec 18, 2024

CzarekDryl commented Dec 18, 2024

arrenv left a comment

jakubcolony left a comment

CzarekDryl commented Dec 20, 2024

Feat/15886093 reputation cancel #3322

Are you sure you want to change the base?

Feat/15886093 reputation cancel #3322

Conversation

CzarekDryl commented Oct 14, 2024

Description

Testing

jakubcolony commented Oct 17, 2024

CzarekDryl commented Oct 23, 2024

arrenv left a comment • edited Loading

Choose a reason for hiding this comment

iamsamgibbs left a comment

Choose a reason for hiding this comment

arrenv left a comment

Choose a reason for hiding this comment

CzarekDryl commented Dec 11, 2024

jakubcolony left a comment

Choose a reason for hiding this comment

Other flows tested which mostly work well:

jakubcolony Dec 11, 2024

Choose a reason for hiding this comment

jakubcolony Dec 11, 2024

Choose a reason for hiding this comment

jakubcolony Dec 11, 2024

Choose a reason for hiding this comment

CzarekDryl Dec 12, 2024

Choose a reason for hiding this comment

jakubcolony commented Dec 11, 2024

CzarekDryl commented Dec 12, 2024

arrenv left a comment

Choose a reason for hiding this comment

CzarekDryl commented Dec 17, 2024 • edited Loading

arrenv left a comment

Choose a reason for hiding this comment

arrenv commented Dec 18, 2024

CzarekDryl commented Dec 18, 2024

arrenv left a comment

Choose a reason for hiding this comment

jakubcolony left a comment

Choose a reason for hiding this comment

CzarekDryl commented Dec 20, 2024

arrenv left a comment •

edited

Loading

CzarekDryl commented Dec 17, 2024 •

edited

Loading