Creating staked expenditure #994

jakubcolony · 2023-08-23T13:41:33Z

Description

This PR adds the functionality of creating a staked expenditure.

For context, you can only create an expenditure if you have the Administration permissions in the colony. Staked Expenditure extension allows anyone to create an expenditure, as long as they stake it. The required stake amount is a fraction of the total domain reputation that an expenditure is created in, which is configured when enabling the extension.

Testing

Creating a regular (non-staked) expenditure

Before installing any extensions, try creating a new expenditure. It should work exactly the same as previously.

Creating a staked expenditure

Enable reputation auto mining: http://localhost:3001/reputation/monitor/toggle
Mint some tokens, pay yourself and wait for the mining cycle to finish (you can do step 3 while you're waiting).
Install and enable Staked Expenditure extension. Enter the desired stake fraction.
Activate all your tokens.
Create an expenditure. You should see a dialog appear with the required stake amount. Since at this point you're the only user with reputation, the amount should be roughly equal to the fraction percentage times the amount of tokens you've paid yourself:

The saga with 3 transactions (approve stake, make expenditure, and set expenditure values) should go through and you should be redirected to the expenditure page.
Check the token popover to confirm the stake amount is shown there.

Not enough active tokens

Deactivate all your tokens and try to create an expenditure. The stake dialog should inform you you don't have enough active tokens:

Editing, locking, funding & finalizing

Should work exactly as previously.

Claiming a payout

The function determining which payouts are claimable now uses the block time instead of machine time. If you disable auto mining, you should see the correct time until next claim (relative to the machine time):

Note this will only be correct straight after reload, as the machine time advances while the dev blockchain time doesn't. In the example above you can advance the time by 60 seconds using the approach from #925.

Creating an expenditure as a non-admin user

Try paying some tokens to another dev wallet/metamask, then follow the steps above to confirm you can create a staked expenditure even if you don't have the Administration permissions. You should also be able to edit, lock and finalize, but not fund (since you're missing permissions to move funds).

Resolves #952

…Expenditure saga

jakubcolony · 2023-08-24T12:27:46Z

...ltMotion/MotionPhaseWidget/StakingWidget/StakingInput/StakingControls/useStakingControls.tsx

@@ -25,7 +28,7 @@ const useStakingControls = (limitExceeded: boolean) => {

  const {
    userActivatedTokens,
-    enoughTokensToStakeMinimum,
+    hasEnoughTokens: enoughTokensToStakeMinimum,
    loadingUserTokenBalance,
  } = useEnoughTokensForStaking(


@willm30 I nicked your hook and made it more generic to use for staking expenditures too.

jakubcolony · 2023-08-24T12:29:03Z

src/components/common/Expenditures/ExpenditureForm/CreateExpenditureForm.tsx

+      {({ watch }) => {
+        const formValues = watch();


It looks like Dialogs can't access the form context since they're rendered in a different place in the DOM.

jakubcolony · 2023-08-24T12:34:57Z

src/components/common/Expenditures/StakeExpenditureDialog/StakeExpenditureDialog.tsx

+import styles from './StakeExpenditureDialog.module.css';
+
+const useRequiredStakeAmount = (colony: Colony, selectedDomainId: number) => {
+  const { data } = useGetUserReputationQuery({


We might want to get rid of the getUserReputation lambda altogether. All it does it uses colonyJS to call the reputation oracle endpoint, without any on-chain interaction. It's probably faster just to call that endpoint directly from the front end instead of going through a GQL query.

jakubcolony · 2023-08-24T12:37:09Z

src/components/common/Extensions/ExtensionSetup/utils.ts

-  if (extensionId === Extension.VotingReputation) {
-    return initializationParams?.reduce((formattedPayload, { paramName }) => {
-      if (paramName.endsWith('Period')) {
-        return {
-          ...formattedPayload,
-          [paramName]: new Decimal(payload[paramName])
-            .mul(3600)
-            .toFixed(0, Decimal.ROUND_HALF_UP),
-        };
-      }


I found it non-obvious so I moved the control over transforming the params to the params configuration in ~constants/extensions. Now this function simply applies pre-defined transformations.

jakubcolony · 2023-08-24T12:38:49Z

src/hooks/useCurrentBlockTime.ts

+    const fetchCurrentBlockTime = async () => {
+      const { ethersProvider } = wallet;
+
+      const block = await ethersProvider?.getBlock('latest');
+      if (!block) {
+        return;
+      }
+
+      setCurrentBlockTime(block.timestamp * 1000);
+    };


I'm not sure it's worth having a lambda to do just this but would be good to know your thoughts @rdig

jakubcolony · 2023-08-24T12:40:54Z

src/redux/sagas/expenditures/createExpenditure.ts

+    const [permissionDomainId, childSkillIndex] = yield getPermissionProofs(
+      colonyClient,
+      createdInDomain.nativeId,
+      ColonyRole.Administration,
+    );


This is pretty much all that's needed to replace the withProofs functions. And in case of motions it will be quicker, since we have the motion domain cached, whereas colonyJS makes an additional contract call to get it.

jakubcolony · 2023-08-24T12:42:37Z

src/redux/sagas/wallet/index.ts

@@ -85,6 +85,7 @@ export const getBasicWallet = async (lastWallet: LastWallet) => {
      address: lastWallet.address,
      label: lastWallet.type,
      chains: [{ id: getChainIdAsHex(network.chainId), namespace: 'evm' }],
+      ethersProvider: provider,


Adding this property to the wallet object to be able to call getBlock in useCurrentBlockTime.

willm30 · 2023-08-29T14:20:03Z

src/components/common/Expenditures/ExpenditureForm/CreateExpenditureForm.tsx

+  }
+
+  /**
+   * @TODO: This should include a permissions check as users with


getUserRolesFromDomain should serve you here (in src/transformers/index.ts)

willm30

LGTM, aside from a couple of observations:

Claiming the funds is not removing them from "staked" in the token activation popover
I believe the wrong slots are being shown in expenditures.

E.g. Expenditure 3 UI:

Versus Expenditure 3 DB:

The recipient address and amount are actually from expenditure 2:

Possibly caused by slots not having unique ids and apollo mixing them up? That would be my first guess.

There's definitely something funky going on since when I click back on expenditure 3, it has the correct slot:

Let me know if you want to address these elsewhere and I can approve this PR, or if you'll address them here.

jakubcolony · 2023-08-29T22:21:13Z

@willm30

Claiming the funds is not removing them from "staked" in the token activation popover
There's a separate issue for that: Reclaiming staked expenditure stake #1006

I couldn't reproduce the wrong slots issue myself but indeed all the slots were being cached under a single cache entry. I disabled caching of that type entirely which should hopefully fix the problem.

Refactor: Extension init params transformation

cb54fda

jakubcolony self-assigned this Aug 23, 2023

jakubcolony added 11 commits August 23, 2023 16:48

Feat: Get actual permission domain id and child skill index in create…

29d5433

…Expenditure saga

Add nativeSkillId to Domain GraphQL fragment

139c75b

Refactor: Split ExpenditureForm into create and edit form components

4e63eaf

Fix: DomainDropdown after Domain fragment change

6b47750

Refactor: Make useEnoughTokensForStaking more generic hook

9e6ef6f

Feat: Add StakeExpenditureDialog component

1250dfe

Feat: StakeExpenditureDialog passing stakeAmount to saga

6cbf6a1

Feat: createStakedExpenditure saga

7461abc

Refactor: Expose ethersProvider property on wallet object

7165b8c

Feat: useCurrentBlockTime hook

45c0ab9

Use current block time when determining claimable payouts

2515fe7

jakubcolony linked an issue Aug 24, 2023 that may be closed by this pull request

Creating staked expenditures #952

Closed

Show time until next expenditure claim relative to machine time

91d985f

jakubcolony commented Aug 24, 2023

View reviewed changes

jakubcolony marked this pull request as ready for review August 24, 2023 13:13

jakubcolony requested review from rdig and willm30 August 24, 2023 13:13

willm30 reviewed Aug 29, 2023

View reviewed changes

jakubcolony requested a review from willm30 August 29, 2023 22:21

Disable caching of ExpenditureSlot type

a552fa3

willm30 approved these changes Aug 30, 2023

View reviewed changes

jakubcolony merged commit 494a045 into feat/advanced-payments Aug 30, 2023

jakubcolony deleted the feat/925-creating-staked-expenditure branch August 30, 2023 08:46

jakubcolony mentioned this pull request Aug 31, 2023

Reclaiming staked expenditure stake #1024

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Creating staked expenditure #994

Creating staked expenditure #994

jakubcolony commented Aug 23, 2023 •

edited

Loading

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

jakubcolony Aug 24, 2023

willm30 Aug 29, 2023 •

edited

Loading

willm30 left a comment •

edited

Loading

jakubcolony commented Aug 29, 2023

Creating staked expenditure #994

Creating staked expenditure #994

Conversation

jakubcolony commented Aug 23, 2023 • edited Loading

Description

Testing

Creating a regular (non-staked) expenditure

Creating a staked expenditure

Not enough active tokens

Editing, locking, funding & finalizing

Claiming a payout

Creating an expenditure as a non-admin user

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

jakubcolony Aug 24, 2023

Choose a reason for hiding this comment

willm30 Aug 29, 2023 • edited Loading

Choose a reason for hiding this comment

willm30 left a comment • edited Loading

Choose a reason for hiding this comment

jakubcolony commented Aug 29, 2023

jakubcolony commented Aug 23, 2023 •

edited

Loading

willm30 Aug 29, 2023 •

edited

Loading

willm30 left a comment •

edited

Loading