feat: implement arbitrary transactions via reputation

[Nortsova]

Description

This issue covers the reputation (motions) flow of creating arbitrary transaction.

New saga needs to be added that should accept a target contract address and a list of arbitrary transactions, consisting of function name and a list of arguments. It should create a motion to call makeArbitraryTransactions on the Colony contract.

To get the value for action, it can use the contract ABI to create an ethers interface and then encode the call with encodeFunctionData (note there will be "2 layers" of encoding, one for the makeArbitraryTransactions's actions and the other for motion's action).

The existing block-ingestor motion handler might need to be modified to store additional data in the database.

The saga should be wired in with the action form.

Tip

Block ingestor PR: JoinColony/block-ingestor#304

Testing

Step 1. Update src/components/v5/common/ActionSidebar/partials/forms/ArbitraryTxsForm/partials/AddTransactionModal/useGenerateABI.ts line 21 to return; (Unfortunately, we can't get a local contract from arbiscan, so we will put it manually 🙌 )

Step 2. Enable Reputation Weighted extension (with "Testing governance" settings)
Step 3. "Manage colony" -> "Custom transactions"

Step 4. Create transaction with:
Contract address: 0xeF841fe1611ce41bFCf0265097EFaf50486F5111
ABI:

[{"type":"constructor","payable":false,"inputs":[{"type":"string","name":"_name"},{"type":"string","name":"_symbol"},{"type":"uint8","name":"_decimals"}]},{"type":"event","anonymous":false,"name":"Approval","inputs":[{"type":"address","name":"src","indexed":true},{"type":"address","name":"guy","indexed":true},{"type":"uint256","name":"wad","indexed":false}]},{"type":"event","anonymous":false,"name":"Burn","inputs":[{"type":"address","name":"guy","indexed":true},{"type":"uint256","name":"wad","indexed":false}]},{"type":"event","anonymous":false,"name":"LogSetAuthority","inputs":[{"type":"address","name":"authority","indexed":true}]},{"type":"event","anonymous":false,"name":"LogSetOwner","inputs":[{"type":"address","name":"owner","indexed":true}]},{"type":"event","anonymous":false,"name":"MetaTransactionExecuted","inputs":[{"type":"address","name":"user","indexed":false},{"type":"address","name":"relayerAddress","indexed":false},{"type":"bytes","name":"functionSignature","indexed":false}]},{"type":"event","anonymous":false,"name":"Mint","inputs":[{"type":"address","name":"guy","indexed":true},{"type":"uint256","name":"wad","indexed":false}]},{"type":"event","anonymous":false,"name":"Transfer","inputs":[{"type":"address","name":"src","indexed":true},{"type":"address","name":"dst","indexed":true},{"type":"uint256","name":"wad","indexed":false}]},{"type":"function","name":"DOMAIN_SEPARATOR","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"bytes32"}]},{"type":"function","name":"PERMIT_TYPEHASH","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"bytes32"}]},{"type":"function","name":"allowance","constant":true,"stateMutability":"view","payable":false,"inputs":[{"type":"address","name":"src"},{"type":"address","name":"guy"}],"outputs":[{"type":"uint256"}]},{"type":"function","name":"approve","constant":false,"payable":false,"inputs":[{"type":"address","name":"guy"},{"type":"uint256","name":"wad"}],"outputs":[{"type":"bool"}]},{"type":"function","name":"authority","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"address"}]},{"type":"function","name":"balanceOf","constant":true,"stateMutability":"view","payable":false,"inputs":[{"type":"address","name":"src"}],"outputs":[{"type":"uint256"}]},{"type":"function","name":"burn","constant":false,"payable":false,"inputs":[{"type":"uint256","name":"wad"}],"outputs":[]},{"type":"function","name":"burn","constant":false,"payable":false,"inputs":[{"type":"address","name":"guy"},{"type":"uint256","name":"wad"}],"outputs":[]},{"type":"function","name":"decimals","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"uint8"}]},{"type":"function","name":"executeMetaTransaction","constant":false,"stateMutability":"payable","payable":true,"inputs":[{"type":"address","name":"_user"},{"type":"bytes","name":"_payload"},{"type":"bytes32","name":"_sigR"},{"type":"bytes32","name":"_sigS"},{"type":"uint8","name":"_sigV"}],"outputs":[{"type":"bytes"}]},{"type":"function","name":"getMetatransactionNonce","constant":true,"stateMutability":"view","payable":false,"inputs":[{"type":"address","name":"_user"}],"outputs":[{"type":"uint256","name":"nonce"}]},{"type":"function","name":"locked","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"bool"}]},{"type":"function","name":"mint","constant":false,"payable":false,"inputs":[{"type":"address","name":"guy"},{"type":"uint256","name":"wad"}],"outputs":[]},{"type":"function","name":"mint","constant":false,"payable":false,"inputs":[{"type":"uint256","name":"wad"}],"outputs":[]},{"type":"function","name":"name","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"string"}]},{"type":"function","name":"nonces","constant":true,"stateMutability":"view","payable":false,"inputs":[{"type":"address","name":"_user"}],"outputs":[{"type":"uint256","name":"nonce"}]},{"type":"function","name":"owner","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"address"}]},{"type":"function","name":"permit","constant":false,"payable":false,"inputs":[{"type":"address","name":"owner"},{"type":"address","name":"spender"},{"type":"uint256","name":"value"},{"type":"uint256","name":"deadline"},{"type":"uint8","name":"v"},{"type":"bytes32","name":"r"},{"type":"bytes32","name":"s"}],"outputs":[]},{"type":"function","name":"setAuthority","constant":false,"payable":false,"inputs":[{"type":"address","name":"authority_"}],"outputs":[]},{"type":"function","name":"setOwner","constant":false,"payable":false,"inputs":[{"type":"address","name":"owner_"}],"outputs":[]},{"type":"function","name":"symbol","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"string"}]},{"type":"function","name":"totalSupply","constant":true,"stateMutability":"view","payable":false,"inputs":[],"outputs":[{"type":"uint256"}]},{"type":"function","name":"transfer","constant":false,"payable":false,"inputs":[{"type":"address","name":"dst"},{"type":"uint256","name":"wad"}],"outputs":[{"type":"bool"}]},{"type":"function","name":"transferFrom","constant":false,"payable":false,"inputs":[{"type":"address","name":"src"},{"type":"address","name":"dst"},{"type":"uint256","name":"wad"}],"outputs":[{"type":"bool"}]},{"type":"function","name":"unlock","constant":false,"payable":false,"inputs":[],"outputs":[]},{"type":"function","name":"verify","constant":true,"stateMutability":"view","payable":false,"inputs":[{"type":"address","name":"_user"},{"type":"uint256","name":"_nonce"},{"type":"uint256","name":"_chainId"},{"type":"bytes","name":"_payload"},{"type":"bytes32","name":"_sigR"},{"type":"bytes32","name":"_sigS"},{"type":"uint8","name":"_sigV"}],"outputs":[{"type":"bool"}]}]

Step 5. Create Action with two transactions (to check that multiple transactions are working), one of transactions should be mint
Step 6. Submit action with Decision method "Reputation"

Step 7. Check that in console you can see Motion with Arbitrary transactions:

Step 8. On the finance page (http://localhost:9091/planex/incoming) check that there are no incoming funds (this means that transactions weren't called)

Step 9. Fully support motion:

Step 10. Run npm run forward-time 1 in console

Step 11. Refresh page and Finalize motion

Step 12. Check finance page http://localhost:9091/planex/incoming that mint function was called and you can see incoming funds:

Step 13. Repeat Step 3 - Step 8.
Step 14. Fully reject motion:

Step 15. Verify that functions weren't called and that there is nothing new on http://localhost:9091/planex/incoming

Any other tests are welcome 🙌

Contributes to #3536

[jakubcolony]

If this PR is not ready for review, can you move it back to draft please?

[Nortsova]

This part of the code almost a duplication of the Root Motion Saga; I tried to reuse the Saga but faced types issues. Any ideas on better solution are welcome :)

[mmioana]

@Nortsova I left the needed changes in my PR review comment 🙌

[mmioana]

Impressive work on this one @Nortsova 🙌

It all works as expected 💯

Added the early-return

Installed the Reputation extension

Started creating some transactions for the given contract address

Could see the motion got created in the logs

The incoming funds page before the mint operation got executed

Finalised, but realised I didn't use the right transaction for minting the tokens - actually didn't use the right address parameter for the other mint method

So here we go again

And after the motion was Supported and Finalised, could see the incoming funds

Tried the scenario of rejecting a motion

And the incoming funds page didn't change after the motion was Rejected and Finalised

Refactoring to use the root motion saga

@Nortsova if you want to make use of the ROOT_MOTION saga you can try out these changes.
Save the below in a .diff and run git apply .diff

diff --git a/src/components/v5/common/ActionSidebar/partials/forms/ArbitraryTxsForm/hooks.ts b/src/components/v5/common/ActionSidebar/partials/forms/ArbitraryTxsForm/hooks.ts
index bce215888..e5f3474c6 100644
--- a/src/components/v5/common/ActionSidebar/partials/forms/ArbitraryTxsForm/hooks.ts
+++ b/src/components/v5/common/ActionSidebar/partials/forms/ArbitraryTxsForm/hooks.ts
@@ -1,11 +1,14 @@
 import { Id } from '@colony/colony-js';
+import { Interface } from 'ethers/lib/utils';
 import { useMemo } from 'react';
 import { useWatch } from 'react-hook-form';
 
 import { useColonyContext } from '~context/ColonyContext/ColonyContext.ts';
 import { ActionTypes } from '~redux/index.ts';
+import { RootMotionMethodNames } from '~redux/types/actions/motion.ts';
 import { DecisionMethod } from '~types/actions.ts';
 import { mapPayload } from '~utils/actions.ts';
+import { extractColonyRoles } from '~utils/colonyRoles.ts';
 import { extractColonyDomains } from '~utils/domains.ts';
 import { sanitizeHTML } from '~utils/strings.ts';
 import { DECISION_METHOD_FIELD_NAME } from '~v5/common/ActionSidebar/consts.ts';
@@ -30,7 +33,7 @@ export const useCreateArbitraryTxs = (
     actionType:
       decisionMethod === DecisionMethod.Permissions
         ? ActionTypes.CREATE_ARBITRARY_TRANSACTION
-        : ActionTypes.MOTION_ARBITRARY_TRANSACTION,
+        : ActionTypes.ROOT_MOTION,
     validationSchema,
     getFormOptions,
     defaultValues: useMemo(
@@ -45,18 +48,38 @@ export const useCreateArbitraryTxs = (
       const commonPayload = {
         annotationMessage: safeDescription,
         customActionTitle: payload.title,
-        transactions: payload.transactions,
         colonyAddress,
       };
 
       if (payload.decisionMethod === DecisionMethod.Reputation) {
+        const contractAddresses: string[] = [];
+        const methodsBytes: string[] = [];
+
+        payload.transactions.forEach(({ contractAddress, ...item }) => {
+          try {
+            const encodedFunction = new Interface(
+              item.jsonAbi,
+            ).encodeFunctionData(
+              item.method,
+              item.args?.map((arg) => arg.value),
+            );
+            contractAddresses.push(contractAddress);
+            methodsBytes.push(encodedFunction);
+          } catch (e) {
+            console.error(e);
+          }
+        });
+
         return {
           ...commonPayload,
+          motionParams: [contractAddresses, methodsBytes, true],
+          operationName: RootMotionMethodNames.MakeArbitraryTransaction,
           colonyDomains: extractColonyDomains(colony.domains),
+          colonyRoles: extractColonyRoles(colony.roles),
         };
       }
 
-      return commonPayload;
+      return { ...commonPayload, transactions: payload.transactions };
     }),
   });
 };
diff --git a/src/redux/types/actions/motion.ts b/src/redux/types/actions/motion.ts
index adb7f8e8d..3de7c0a85 100644
--- a/src/redux/types/actions/motion.ts
+++ b/src/redux/types/actions/motion.ts
@@ -39,6 +39,7 @@ export enum RootMotionMethodNames {
   MoveFunds = 'moveFunds',
   Upgrade = 'upgrade',
   UnlockToken = 'unlockToken',
+  MakeArbitraryTransaction = 'makeArbitraryTransactions',
 }
 
 export interface ExpenditureFundMotionPayload extends ExpenditureFundPayload {

And this should do the trick 🙌

However, I'm okay even with using a separate saga for this, so I'll approve your PR. Nice work! 🥇

[Nortsova]

Thanks, @mmioana 🙌 Me and @jakubcolony discussed a couple of solutions, and this one as well; we decided that we don't want to overcomplicate UI logic and want to leave transformation inside Saga. But now, with new changes that @jakubcolony did in #3966, it has become more complicated to reuse ROOT_MOTION. ❤️

The base branch was changed.

[mmioana]

@Nortsova it makes sense and I think it's even more clear to keep the sagas separate. Just noticed your previous comment and wanted to try it out 🙌

Awesome work, it still works as expected after the rebase

Installed the extension

Created a Custom transactions using Reputation

Incoming page before finalising the staked motion

Incoming page after finalising the staked motion

Created another Custom transactions with Repuation

Rejected it

And the Incoming funds page remained unchanged 👍

Really cool work on this one @Nortsova 🥇

[bassgeta]

Really nice and straightforward 💯
I actually fully support this new arbitratyTx saga, I wouldn't merge it with rootMotion, since that one is already doing 6 different things 😅 But if this turns out super simple, we can merge them down the line.
Filled out the form nicely ✔️

Motion data is logged ✔️


Fully supported it and finalized ✔️


Incoming funds 👀

When rejecting, nothing happens 👌


Just the previous funds incoming 👀

[iamsamgibbs]

Nice job getting this working so nicely! It works exactly as expected when creating a motion in the root domain:

Screen.Recording.2025-01-09.at.16.39.33.mov

No incoming funds:

Then after finalising the funds appear:

Screen.Recording.2025-01-09.at.16.41.45.mov

Only one very minor change, the Created in field should be readonly as it is only possible to create an arbitrary transaction in the root domain.

[iamsamgibbs]

I'm not sure if this comment is still relevant, might be worth moving the arbitrary motion above the expenditure ones just in case.

[jakubcolony]

Smashing work @Nortsova! Apart from the Created in field mentioned by Sam, everything looks & works great 💯

[jakubcolony]

Seems unused

[Nortsova]

Thanks guys! Fixed 🙌

[iamsamgibbs]

Great, thanks for the changes!

[bassgeta]

Reapproving after rebase, let's go 🚢