Add Governor component #1180

ericnordelo · 2024-10-11T12:42:27Z

Fixes #294

PR Checklist

Tests
Documentation
Added entry to CHANGELOG.md
Tried the feature on a public network

…eleased-package-#1141

…emove-dual-dispatchers

…eat/remove-mocks-from-released-package-#1141

* feat: remove modules * fix: mock * fix: linter * fix: tests * fix: mock * feat: apply review suggestions

…om-released-package-#1141

…eat/remove-mocks-from-released-package-#1141

…contracts into feat/governance2-#294

immrsd

Great job, Eric! That wasn't an easy walkthrough, the feature is really complex. It's looking good, I left several comments

packages/governance/src/governor/interface.cairo

packages/governance/src/governor/proposal_core.cairo

packages/utils/src/bytearray.cairo

packages/governance/src/governor/extensions/governor_settings.cairo

packages/governance/src/governor/extensions/governor_votes_quorum_fraction.cairo

immrsd · 2024-11-13T20:40:26Z

packages/governance/src/governor/governor.cairo

+            self
+                .validate_state(
+                    proposal_id, array![ProposalState::Succeeded, ProposalState::Queued].span()
+                );


It seems to be overkill for checking the state: we have to create an array and iterate through it. Maybe a more direct approach would be better

Suggested change

self

.validate_state(

proposal_id, array![ProposalState::Succeeded, ProposalState::Queued].span()

);

match self.state(proposal_id) {

ProposalState::Succeeded => (),

ProposalState::Queued => (),

_ => panic_with_felt252(Errors:: UNEXPECTED_PROPOSAL_STATE),

This is probably more efficient, but the validate_state helper can be used by users as well. We can refactor it into bitmap operations to avoid looping or matching, which should be even more efficient, and also usable by users. Let's keep the thread opened until the pending stuff is finished and I will work on that then.

packages/governance/src/governor/extensions/governor_counting_simple.cairo

Co-authored-by: immrsd <[email protected]>

…contracts into feat/governance2-#294

…eat/governance2-#294

packages/governance/src/governor/extensions/governor_counting_simple.cairo

packages/governance/src/governor/extensions/governor_timelock_execution.cairo

packages/governance/src/governor/extensions/governor_votes_quorum_fraction.cairo

immrsd · 2024-11-15T15:31:09Z

packages/governance/src/governor/governor.cairo

+            ref self: ComponentState<TContractState>, calls: Span<Call>, description_hash: felt252
+        ) -> felt252 {
+            let proposal_id = self._hash_proposal(calls, description_hash);
+            self.validate_state(proposal_id, array![ProposalState::Pending].span());


Is it possible to cancel a queued proposal?

Shouldn't be possible, why?

packages/governance/src/governor/governor.cairo

andrew-fleming

Fantastic job with the first iteration of tests! I left some comments

packages/governance/src/governor/governor.cairo

packages/utils/src/bytearray.cairo

packages/governance/src/tests/governor/test_governor.cairo

packages/governance/src/governor/governor.cairo

andrew-fleming · 2024-11-16T02:59:52Z

packages/governance/src/governor/governor.cairo

+        /// Temporary defined as a function since constant ByteArray is not supported yet.
+        fn DEFAULT_PARAMS() -> Span<felt252>;


We should adjust the comment. Maybe test this with a non-empty span, WDYT?

Comment adjusted. Will revisit tests after finishing tests for extensions.

…eat/governance2-#294

ericnordelo added 30 commits September 13, 2024 18:12

feat: add features

8277877

feat: remove access dual dispatchers (OpenZeppelin#1154)

14b4b96

feat: bump scarb

485512f

feat: update CHANGELOG

e9cd67d

Merge branch 'feat/bump-scarb-to-2.8.3' into feat/remove-mocks-from-r…

762d9c9

…eleased-package-#1141

feat: add features

21b31d9

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into r…

3ad8c7f

…emove-dual-dispatchers

feat: remove account dual dispatchers (OpenZeppelin#1168)

b8a3ed5

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

a4d5d77

…eat/remove-mocks-from-released-package-#1141

feat: move mocks to test_common

d44754c

Remove token dual dispatchers (OpenZeppelin#1175)

094081c

* feat: remove modules * fix: mock * fix: linter * fix: tests * fix: mock * feat: apply review suggestions

feat: update docs

e738107

feat: update CHANGELOG

75974fd

fix: typo

586357a

fix: mod

b2ba912

feat: remove unused imports

fe6d846

fix: README

de11d9b

Merge branch 'docs/remove-dual-dispatchers' into feat/remove-mocks-fr…

57c9003

…om-released-package-#1141

feat: move mocks into test_common

55225bc

feat: remove mocks from release target

72451fa

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

fda9095

…eat/remove-mocks-from-released-package-#1141

fix: mock

f575ba8

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

86508c6

…eat/remove-mocks-from-released-package-#1141

fix: imports

1c5c522

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

420d364

…eat/remove-mocks-from-released-package-#1141

feat: bumo scarb and remove assert_macros from manifest

f14f635

feat: re-add assert_macros

8a763e0

feat: add test target names

46fd0ac

docs: update index

182f470

feat: add interface

6d68bd0

ericnordelo added 4 commits November 12, 2024 17:08

Merge branch 'feat/governance2-#294' of github.com:ericnordelo/cairo-…

502389f

…contracts into feat/governance2-#294

fix: linter

70a2785

fix: bytearray

3c67aac

feat: add more tests

81aced2

immrsd reviewed Nov 13, 2024

View reviewed changes

ericnordelo and others added 10 commits November 14, 2024 16:28

feat: add more tests

85b032c

Update packages/utils/src/bytearray.cairo

8d96ff2

Co-authored-by: immrsd <[email protected]>

feat: apply review updates

b43bc0d

Merge branch 'feat/governance2-#294' of github.com:ericnordelo/cairo-…

f080f95

…contracts into feat/governance2-#294

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

4936537

…eat/governance2-#294

feat: add cast vote by sig

bdcdec4

feat: add more tests

ffaac53

feat: add more tests

cd52a53

fix: remove import

bbe27a9

feat: add yet more tests

4944d6d

ericnordelo requested review from immrsd and andrew-fleming November 14, 2024 23:51

feat: update CHANGELOG

92cd728

ericnordelo marked this pull request as ready for review November 15, 2024 00:05

immrsd reviewed Nov 15, 2024

View reviewed changes

andrew-fleming reviewed Nov 16, 2024

View reviewed changes

ericnordelo added 9 commits November 18, 2024 14:48

Merge branch 'main' of github.com:OpenZeppelin/cairo-contracts into f…

4140510

…eat/governance2-#294

feat: apply review updates

8d727db

feat: add tests for governor core execution

a3ed66b

feat: add more tests

0cdb5bd

feat: add more tests

003046a

feat: add more tests

77049d1

fix: linter

784fac8

feat: add more tests

bb21021

feat: add more tests

e613e48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Governor component #1180

Add Governor component #1180

ericnordelo commented Oct 11, 2024

immrsd left a comment

immrsd Nov 13, 2024

ericnordelo Nov 14, 2024

immrsd Nov 15, 2024

ericnordelo Nov 18, 2024

andrew-fleming left a comment

andrew-fleming Nov 16, 2024

ericnordelo Nov 18, 2024

-            self
-                .validate_state(
-                    proposal_id, array![ProposalState::Succeeded, ProposalState::Queued].span()
-                );
+  match self.state(proposal_id) {
+    ProposalState::Succeeded => (),
+    ProposalState::Queued => (),
+    _ => panic_with_felt252(Errors:: UNEXPECTED_PROPOSAL_STATE),

		/// Temporary defined as a function since constant ByteArray is not supported yet.
		fn DEFAULT_PARAMS() -> Span<felt252>;

Add Governor component #1180

Are you sure you want to change the base?

Add Governor component #1180

Conversation

ericnordelo commented Oct 11, 2024

PR Checklist

immrsd left a comment

Choose a reason for hiding this comment

immrsd Nov 13, 2024

Choose a reason for hiding this comment

ericnordelo Nov 14, 2024

Choose a reason for hiding this comment

immrsd Nov 15, 2024

Choose a reason for hiding this comment

ericnordelo Nov 18, 2024

Choose a reason for hiding this comment

andrew-fleming left a comment

Choose a reason for hiding this comment

andrew-fleming Nov 16, 2024

Choose a reason for hiding this comment

ericnordelo Nov 18, 2024

Choose a reason for hiding this comment