feature: targets and standardized proposal #99

novaknole · 2024-08-14T09:07:55Z

Description

A couple of things remaining:

Code of targets and execute functions are duplicated in abstract contracts. Either:

We leave it as it is
We use free function utils
We design another abstract contract and inherit from it in those - be careful with storage clashes in inheritance.

Revert happens inside _execute functions but it might be desirable to leave this choice to consumer, but if we do so, consumer will have to do this decode stuff manually which is also not ideal. Considering how OZ does such stuff, the current way seems better than others.

Task ID: OS-1481

Checklist:

I have selected the correct base branch.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have made corresponding changes to the documentation.
My changes generate no new warnings.
Any dependent changes have been merged and published in downstream modules.
I created tasks to update dependent repositories (OSx, Plugins)
I ran all tests with success and extended them if necessary.
I have updated the CHANGELOG.md file in the root folder.

* feat: add test for checking the ExecuteFailed is properly emitted * feat: add new case in mock executor to simulate the tests * feat: refactor code to avoid duplications * ci: fix solhint warnings * ci: fix lint issues

nivida · 2024-08-26T12:18:41Z

contracts/src/plugin/extensions/proposal/Proposal.sol

-    function proposalCount() public view override returns (uint256) {
-        return proposalCounter.current();
+    function proposalCount() public pure override returns (uint256) {
+        return type(uint256).max;


We probably should add here a comment to explain why we are doing this now.

Description is added in IProposal which is clear as this function has inheritdoc above which dev should go and check in IProposal anyways.

Even if we added a @dev comment, this function would be returning a 100% incorrect value. Any contract/UI depending on it would incorrectly assume that things are still working while getting 2^256-1 can lead to unpredictable consequences.

In terms of reliability, I would either:

Remove the function

Make it revert() to signal that this function is no longer valid

This is a breaking change anyway

nivida · 2024-08-26T12:19:31Z

contracts/src/plugin/PluginUUPSUpgradeable.sol

+    /// @param _allowFailureMap Bitmap-encoded number. TODO:
+    /// @return execResults address of the implementation contract.
+    /// @return failureMap address of the implementation contract.
+    function _execute(


We have quite some code duplication over all different Plugin* contracts.. probably worth refactoring it to have those methods only in one place..

contracts/src/plugin/Plugin.sol

clauBv23

LGTM!

* add params byte approach * add simple executor (#103) * add simple executor * action as free level export

brickpop · 2024-10-04T10:58:40Z

contracts/src/executors/Executor.sol

+/// Most useful use-case is to deploy as non-upgradeable and call from another contract via delegatecall.
+/// If used with delegatecall, DO NOT add state variables in sequential slots, otherwise this will overwrite
+/// the storage of the calling contract.
+contract Executor is IExecutor {


Shouldn't this contract be abstract?

brickpop · 2024-10-04T11:21:48Z

contracts/src/executors/Executor.sol

+    error TooManyActions();
+
+    /// @notice Thrown if an action has insufficient gas left.
+    error InsufficientGas();


Suggested change

error InsufficientGas();

error InsufficientGasLeft();

We're already using InsufficientGas name in DAO.sol so better to stick with this name.

contracts/src/executors/IExecutor.sol

brickpop · 2024-10-04T14:02:15Z

contracts/src/plugin/Plugin.sol

-    /// @notice Checks if this or the parent contract supports an interface by its ID.
+    /// @notice Returns the currently set target contract.
+    /// @return TargetConfig The currently set target.
+    function getCurrentTargetConfig() public view virtual returns (TargetConfig memory) {


Suggested change

function getCurrentTargetConfig() public view virtual returns (TargetConfig memory) {

function getRawTargetConfig() public view virtual returns (TargetConfig memory) {

Another alternative:

getTargetConfig() (raw)

getEffectiveTargetConfig()

contracts/src/plugin/extensions/proposal/IProposal.sol

contracts/src/plugin/extensions/proposal/Proposal.sol

brickpop · 2024-10-04T15:34:57Z

contracts/src/plugin/extensions/proposal/Proposal.sol

+            type(IProposal).interfaceId ^
+                IProposal.createProposal.selector ^
+                IProposal.canExecute.selector ^
+                IProposal.createProposalId.selector ^
+                IProposal.createProposalParamsABI.selector ||


Shouldn't this be a versioned IProposalv1 and IProposalv2 interface?
It makes little sense that we are checking 2 different subsets of one interface

brickpop · 2024-10-04T15:40:23Z

contracts/src/plugin/extensions/proposal/ProposalUpgradeable.sol

+            _interfaceId ==
+            type(IProposal).interfaceId ^
+                IProposal.createProposal.selector ^
+                IProposal.canExecute.selector ^
+                IProposal.createProposalId.selector ^
+                IProposal.createProposalParamsABI.selector ||
+            _interfaceId == type(IProposal).interfaceId ||


Same (versioned)

* metadata contracts * rename * diamond storage for metadata * remove revert

brickpop · 2024-10-09T08:36:26Z

contracts/src/plugin/extensions/proposal/Proposal.sol

-    function proposalCount() public view override returns (uint256) {
-        return proposalCounter.current();
+    function proposalCount() public pure override returns (uint256) {
+        return type(uint256).max;


Even if we added a @dev comment, this function would be returning a 100% incorrect value. Any contract/UI depending on it would incorrectly assume that things are still working while getting 2^256-1 can lead to unpredictable consequences.

In terms of reliability, I would either:

Remove the function

Make it revert() to signal that this function is no longer valid

This is a breaking change anyway

brickpop · 2024-10-09T09:10:47Z

contracts/src/executors/Executor.sol

+    uint256 internal constant MAX_ACTIONS = 256;
+
+    // keccak256("osx-commons.storage.Executor")
+    bytes32 private constant ReentrancyGuardStorageLocation =


Could this value be computed? We are doing this for permission ID's

It can but then assembly's sstore fails with:

TypeError: Only direct number constants and references to such constants are supported by inline assembly.

brickpop · 2024-10-09T09:16:28Z

contracts/src/executors/Executor.sol

+            if (!hasBit(_allowFailureMap, uint8(i))) {
+                // Check if the call failed.
+                if (!success) {
+                    revert ActionFailed(i);
+                }
+            } else {
+                // Check if the call failed.
+                if (!success) {
+                    // Make sure that the action call did not fail because 63/64 of `gasleft()` was insufficient to execute the external call `.to.call` (see [ERC-150](https://eips.ethereum.org/EIPS/eip-150)).
+                    // In specific scenarios, i.e. proposal execution where the last action in the action array is allowed to fail, the account calling `execute` could force-fail this action by setting a gas limit
+                    // where 63/64 is insufficient causing the `.to.call` to fail, but where the remaining 1/64 gas are sufficient to successfully finish the `execute` call.
+                    if (gasAfter < gasBefore / 64) {
+                        revert InsufficientGas();
+                    }
+
+                    // Store that this action failed.
+                    failureMap = flipBit(failureMap, uint8(i));
+                }


Saving an "if" check when successful

Suggested change

if (!hasBit(_allowFailureMap, uint8(i))) {

// Check if the call failed.

if (!success) {

revert ActionFailed(i);

}

} else {

// Check if the call failed.

if (!success) {

// Make sure that the action call did not fail because 63/64 of `gasleft()` was insufficient to execute the external call `.to.call` (see [ERC-150](https://eips.ethereum.org/EIPS/eip-150)).

// In specific scenarios, i.e. proposal execution where the last action in the action array is allowed to fail, the account calling `execute` could force-fail this action by setting a gas limit

// where 63/64 is insufficient causing the `.to.call` to fail, but where the remaining 1/64 gas are sufficient to successfully finish the `execute` call.

if (gasAfter < gasBefore / 64) {

revert InsufficientGas();

}

// Store that this action failed.

failureMap = flipBit(failureMap, uint8(i));

}

// Check if the call failed.

if (!success) {

if (!hasBit(_allowFailureMap, uint8(i))) {

revert ActionFailed(i);

}

// Make sure that the action call did not fail because 63/64 of `gasleft()` was insufficient to execute the external call `.to.call` (see [ERC-150](https://eips.ethereum.org/EIPS/eip-150)).

// In specific scenarios, i.e. proposal execution where the last action in the action array is allowed to fail, the account calling `execute` could force-fail this action by setting a gas limit

// where 63/64 is insufficient causing the `.to.call` to fail, but where the remaining 1/64 gas are sufficient to successfully finish the `execute` call.

if (gasAfter < gasBefore / 64) {

revert InsufficientGas();

}

// Store that this action failed.

failureMap = flipBit(failureMap, uint8(i));

done in 2f31a61

brickpop · 2024-10-09T09:23:03Z

contracts/src/plugin/Plugin.sol

+    event TargetSet(TargetConfig newTargetConfig);
+
+    /// @notice Thrown when `delegatecall` fails.
+    error ExecuteFailed();


Suggested change

error ExecuteFailed();

error DelegateCallFailed();

done in 2f31a61

brickpop · 2024-10-09T09:26:50Z

contracts/src/plugin/Plugin.sol

+    enum Operation {
+        Call,
+        DelegateCall
+    }
+
+    struct TargetConfig {
+        address target;
+        Operation operation;
+    }


Move to IPlugin. They produce no code when not used

done in 2f31a61

brickpop · 2024-10-09T09:28:55Z

contracts/src/plugin/Plugin.sol

-    /// @notice Checks if this or the parent contract supports an interface by its ID.
+    /// @notice Returns the currently set target contract.
+    /// @return TargetConfig The currently set target.
+    function getCurrentTargetConfig() public view virtual returns (TargetConfig memory) {


Another alternative:

getTargetConfig() (raw)

getEffectiveTargetConfig()

brickpop · 2024-10-09T11:55:36Z

contracts/src/utils/metadata/MetadataExtension.sol

+
+    /// @notice Allows to update only the metadata.
+    /// @param _metadata The utf8 bytes of a content addressing cid that stores plugin's information.
+    function updateMetadata(


Suggesting setMetadata() unless it brings breaking changes on existing code

done in 2f31a61

Co-authored-by: Jør∂¡ <[email protected]>

…ithub.com/aragon/osx-commons into feature/targets-and-standardized-proposal

* create proposal id not enforced * new changes

novaknole added 2 commits August 14, 2024 13:06

proposal and plugins interfaces changes with backwards compatibility

27e6088

add artifacts folder in gitignore

f6f5f3d

novaknole changed the base branch from main to develop August 14, 2024 09:08

github-actions bot added the contracts label Aug 14, 2024

novaknole added 3 commits August 14, 2024 14:16

fix calldata to memory

b233838

add tests

decd4ff

add operation type for target

918763d

clauBv23 requested review from clauBv23 and nivida August 21, 2024 19:19

clauBv23 mentioned this pull request Aug 21, 2024

feat: add tests and refactor #100

Merged

9 tasks

clauBv23 changed the title ~~Feature/targets and standardized proposal~~ feature: targets and standardized proposal Aug 21, 2024

feat: add tests and refactor (#100)

045a403

* feat: add test for checking the ExecuteFailed is properly emitted * feat: add new case in mock executor to simulate the tests * feat: refactor code to avoid duplications * ci: fix solhint warnings * ci: fix lint issues

nivida reviewed Aug 26, 2024

View reviewed changes

novaknole added 5 commits August 26, 2024 16:54

remove previous target from targetset event

f4dc570

add get proposalid in the interface

5306a73

rename function

6def9f4

from calldata to memory

9b799db

improved target config and virtual functions

23c73bd

clauBv23 reviewed Sep 20, 2024

View reviewed changes

contracts/src/plugin/Plugin.sol Show resolved Hide resolved

clauBv23 previously approved these changes Sep 23, 2024

View reviewed changes

add params byte approach (#102)

db446f5

* add params byte approach * add simple executor (#103) * add simple executor * action as free level export

novaknole dismissed clauBv23’s stale review via db446f5 September 27, 2024 08:08

novaknole added 3 commits September 27, 2024 15:38

executor added with reentrancy guard

21ccec8

call initialization only

d1feeeb

add comments

55a0cc6

brickpop reviewed Oct 4, 2024

View reviewed changes

novaknole added 2 commits October 7, 2024 15:45

fallback to dao as a target if no target set (#104)

2476aa2

metadata contracts (#105)

db06fde

* metadata contracts * rename * diamond storage for metadata * remove revert

brickpop requested changes Oct 9, 2024

View reviewed changes

brickpop reviewed Oct 9, 2024

View reviewed changes

novaknole and others added 7 commits October 9, 2024 16:44

Update contracts/src/executors/IExecutor.sol

409c90c

Co-authored-by: Jør∂¡ <[email protected]>

review changes

2f31a61

Merge branch 'feature/targets-and-standardized-proposal' of https://g…

8916046

…ithub.com/aragon/osx-commons into feature/targets-and-standardized-proposal

unused import remove

cf6cdc5

remove unusued import

2cc8ea5

from memory to calldata in metadataextension

8a23aea

create proposal id not enforced (#106)

ef42b24

* create proposal id not enforced * new changes

clauBv23 mentioned this pull request Oct 14, 2024

feature: new multisig version aragon/multisig-plugin#19

Open

9 tasks

remove unusued function

2016e23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature: targets and standardized proposal #99

feature: targets and standardized proposal #99

novaknole commented Aug 14, 2024 •

edited by clauBv23

Loading

nivida Aug 26, 2024

novaknole Aug 26, 2024

brickpop Oct 9, 2024 •

edited

Loading

nivida Aug 26, 2024

clauBv23 left a comment

brickpop Oct 4, 2024

brickpop Oct 4, 2024

novaknole Oct 9, 2024

brickpop Oct 4, 2024

brickpop Oct 9, 2024

brickpop Oct 4, 2024

brickpop Oct 4, 2024

brickpop Oct 9, 2024 •

edited

Loading

brickpop Oct 9, 2024

novaknole Oct 9, 2024

brickpop Oct 9, 2024

novaknole Oct 9, 2024

brickpop Oct 9, 2024

novaknole Oct 9, 2024

brickpop Oct 9, 2024

novaknole Oct 9, 2024

brickpop Oct 9, 2024

brickpop Oct 9, 2024

novaknole Oct 9, 2024

	function getCurrentTargetConfig() public view virtual returns (TargetConfig memory) {
	function getRawTargetConfig() public view virtual returns (TargetConfig memory) {

feature: targets and standardized proposal #99

Are you sure you want to change the base?

feature: targets and standardized proposal #99

Conversation

novaknole commented Aug 14, 2024 • edited by clauBv23 Loading

Description

Checklist:

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brickpop Oct 9, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

clauBv23 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

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

brickpop Oct 9, 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

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

novaknole commented Aug 14, 2024 •

edited by clauBv23

Loading

brickpop Oct 9, 2024 •

edited

Loading

brickpop Oct 9, 2024 •

edited

Loading