Migrate to multiple packages (workspace) #1065

ericnordelo · 2024-07-26T18:04:10Z

Fixes #734

PR Checklist

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

* feat: migrate event tests * feat: update workflow * feat: add foundry utils * feat: finish erc20 and erc20votes migration * feat: remove dual case tests * refactor: format files * refactor: variable name * Update src/tests/token.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/utils/foundry.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20/test_erc20_votes.cairo Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates --------- Co-authored-by: Andrew Fleming <[email protected]>

* Update gitignore with snfoundry cache dir * Delete foundry utils file * Add snfoundry-related test utils, comment out previous utils * Update ERC20 event helpers * Update ERC20 tests * Update ERC20Votes tests * Run linter * Add util function to drop single event * Fix review issues * Make Github workflow run on every PR * Fix review issues * Bump snforge version * Support snforge 0.26 in test utils * Update ERC20 tests to support snforge upgrade * Run linter

* feat: migrate event tests * feat: update workflow * feat: add foundry utils * feat: finish erc20 and erc20votes migration * feat: remove dual case tests * refactor: format files * refactor: variable name * Update src/tests/token.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/utils/foundry.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20/test_erc20_votes.cairo Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * feat: readd dual20 tests * refactor: remove unnecessary import * feat: add dual20 import --------- Co-authored-by: Andrew Fleming <[email protected]>

* migrate pausable and initializable tests * migrate reentrancy guard tests * clean up tests * fix fmt * add event trait to pausable, fix tests * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * fix fmt --------- Co-authored-by: Eric Nordelo <[email protected]>

* feat: update common module * feat: migrate dual modules * feat: finish component test migration * refactor: remove unnecessary imports * feat: apply review updates

* feat: migrate event tests * feat: update workflow * feat: add foundry utils * feat: finish erc20 and erc20votes migration * feat: remove dual case tests * refactor: format files * refactor: variable name * Update src/tests/token.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/utils/foundry.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/token/erc20/test_erc20_votes.cairo Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates * feat: migrate erc721 components tests * refactor: remove extra line * feat: apply review updates * feat: update utilities * feat: apply review updates * fix: ignore tests --------- Co-authored-by: Andrew Fleming <[email protected]>

* test: check ignored tests and add reason * feat: apply review updates

* Update ERC20Votes tests * Run linter * Add test helpers for Ownable tests * Migrate Ownable tests * Migrate OwnableTwoStep tests * Migrate Ownable Dual Dispatcher tests * Support event changes in snforge 0.26 * Resolve review issues * Address review comments

* Migrate Upgrades tests to Foundry * Update src/tests/upgrades/test_upgradeable.cairo Co-authored-by: Andrew Fleming <[email protected]> * Update src/tests/upgrades/test_upgradeable.cairo Co-authored-by: Andrew Fleming <[email protected]> --------- Co-authored-by: Eric Nordelo <[email protected]> Co-authored-by: Andrew Fleming <[email protected]>

* feat: include erc20 preset tests * feat: tests updated * feat: remove unused imports * feat: add deployments * Update src/tests/utils/common.cairo Co-authored-by: Andrew Fleming <[email protected]> * feat: apply review updates --------- Co-authored-by: Andrew Fleming <[email protected]>

* feat: update tests * refactor: remove unnecessary import

* fix import name * migrate cryptography tests * migrate udc tests * fix fmt * fix impl name * fix event assertions * re-add class hash helper

* feat: update dual_eth_account tests * feat: update eth_account tests * refactor: remove unused helpers * refactor: some inconsistencies * Update src/tests/account/ethereum/test_eth_account.cairo Co-authored-by: immrsd <[email protected]> * feat: apply review updates * refactor: format files * Update src/tests/account/ethereum/test_eth_account.cairo Co-authored-by: Andrew Fleming <[email protected]> --------- Co-authored-by: immrsd <[email protected]> Co-authored-by: Andrew Fleming <[email protected]>

* feat: update dual_eth_account tests * feat: update eth_account tests * refactor: remove unused helpers * feat: update eth account preset tests * Update src/tests/account/ethereum/test_eth_account.cairo Co-authored-by: immrsd <[email protected]> * Update src/tests/presets/test_eth_account.cairo Co-authored-by: immrsd <[email protected]> * feat: apply review updates --------- Co-authored-by: immrsd <[email protected]>

* Migrate AccessControl tests * Migrate AccessControl Dual Dispatcher tests * Fix imports * Address review comments * Update error messages * Bring back separator line * Fix ignore reasons in access module * Fix review issues

…orkspace-conversion

* Update test utils and helpers * Update signature tests * Update account tests * Update dual account tests * Run linter * Run linter * Fix review issues * Update ignore reason messages * Run linter * Support eth account tests changes * Run linter * Improve setup functions, remove unused imports * Remove unnecessary accept_ownership step, make use of serialized_sign fn

…tracts into workspace-conversion

ericnordelo · 2024-07-29T11:53:39Z

The temporary Universal Sierra Compiler installation in the workflow should be removed before merging.
Depends on the snforge-migration branch.
Documentation is still missing.

* Update test utils and helpers * Update signature tests * Update account tests * Update dual account tests * Run linter * Run linter * Fix review issues * Update ignore reason messages * Run linter * Support eth account tests changes * Run linter * Improve setup functions, remove unused imports * Remove unnecessary accept_ownership step, make use of serialized_sign fn * Migrate Starknet Account Preset tests, make some code improvements * Run linter * Remove unnecessary clone * Update the comment for assert_entrypoint_not_found_error function * Minor review fixes

…n#1076) * Remove unnecessary `mut`, minor fixes (OpenZeppelin#1032) * clean up code * change array syntax * fix fmt * Improve SNIP12 examples (OpenZeppelin#1036) * docs: improve examples * refactor: remove empty line * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> --------- Co-authored-by: Andrew Fleming <[email protected]> * Release v0.15.0-rc.0 (OpenZeppelin#1039) * feat: update CHANGELOG * Bump version to 0.15.0-rc.0 * docs: add missing header * feat: apply review suggestions --------- Co-authored-by: ericnordelo <[email protected]> * Bump cairo to 2.7.0-rc.1 (OpenZeppelin#1025) * feat: migrate modules * feat: delete cairo_project.toml * feat: update tests * feat: apply review updates * fix: remove extra line * feat: add CHANGELOG entry * fix: CHANGELOG * Bump Scarb to 2.7.0-rc.2 (OpenZeppelin#1052) * bump scarb to 2.7.0-rc.2 * add changelog entry * update changelog entry * bump scarb in installation page * Add timelock component (OpenZeppelin#996) * start timelock comp draft * move timelock to own dir, finish drafting component * tmp: add utility impls * add timelock mock * add test mod for timelock * fix commnet * add constructor to timelock mock * set min_delay in initializer * start tests * fix fmt * fix schedule assertion * add schedule tests * fix fmt * remove unused import * fix errs, _before_call * start execute tests * fix fmt * fix after_call * add execute tests * add abi interface * add reentrancy mock for timelock * add tests for cancel and update_delay * fix hash_op test * add execute with predecessor test * add timelock utils, add operation_state debug impl * fix fmt * improve imports * improve _execute * add basic mock for tests * add tmp call struct * add batch fns to interface * add batch fns * refactor tests to use dedicated mock, add batch tests * fix fmt * remove use clause * add timelock mixin * fix interface name * improve event assertions * fix execute and schedule events * fix fmt * add safe token transfer tests * fix fmt * tidy up code * add descriptions to events * clean up code * inline CallPartialEq fns * start fn descriptions * remove comments * remove comment * fix fmt * add changelog entries * improve spacing * add line break to hash test * clean up tests * clean up tests * fix constants in attacker impl * add initializer helper, register access control support * add _before_call and _after_call tests * fix reentrant batch mock call * add _schedule and _execute tests * add timelock description * fix formatting * fix comments * fix comment * fmt * tidy up tests * remove batch helper fn * remove event from mocks * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * update spdx * remove token receiver support * add additional cancel tests * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * initializer: remove mut, use while loop * fix fmt * add assert_only_self fn * fix getter comments re: pending/waiting * add assert_only_role * add specific op errors * make event names consistent * fix test * remove serialization from HashCallImpl * remove unused components from mock * clean up code * update to 2.7.0-rc.1 * fix fmt * import Call from corelib * update spdx * fix fmt * move OperationState, derive debug * fix fmt * fix hash impls * add for loops * fix PartialEq, add tests * fix fmt * simplify mixin fns * switch Poseidon to Pedersen * make admin a req in initializer * update tests with admin * fix fmt * fix comment * undo changes * add no admin initializer test --------- Co-authored-by: Eric Nordelo <[email protected]> * bump scarb to 2.7.0-rc.4 (OpenZeppelin#1064) * bump scarb to 2.7.0-rc.4 * add changelog * bump scarb in installation page * feat: update workflow and fix warning (OpenZeppelin#1066) * Add actionlint (OpenZeppelin#1067) * add actionlint for workflows * remove codecov and gitmodules * bump checkout to v4, add double quotes, fmt * bump md lint * re-add cairo version * group redirects * fix link in security * add local actionlint matcher json * re-add changelog entry * add tmp usc install to ci * fix ci --------- Co-authored-by: Eric Nordelo <[email protected]> Co-authored-by: ericnordelo <[email protected]> Co-authored-by: JChoy <[email protected]>

andrew-fleming

Very nice work on this! Structure-wise, I think this is good to go. I didn't take a deep look at the tests as I assume they match the snforge migration branch. Something tells me that the old testing pattern with common/ might not be the best approach since we have multiple packages now, but that can be reassessed in the future. Aside from that, I left some comments :)

README.md

docs/modules/ROOT/pages/components.adoc

andrew-fleming · 2024-07-29T20:42:24Z

docs/modules/ROOT/pages/api/utilities.adoc

Omitting the issues in this doc because we're handling utils documentation in another PR

packages/access/src/accesscontrol/dual_accesscontrol.cairo

packages/account/src/tests.cairo

packages/governance/src/tests.cairo

packages/presets/src/tests/mocks/account_mocks.cairo

packages/token/src/erc1155/erc1155.cairo

andrew-fleming · 2024-08-01T00:22:51Z

packages/token/src/tests/erc1155.cairo

-pub(crate) mod common;
+pub mod common;


It might be worth rethinking if we should have a public common/ specifically for tests given the new structure. Not a pressing issue ATM though

I agree, let's just not delay merging this PR because of it, and we can revisit it in the future.

* Remove unnecessary `mut`, minor fixes (OpenZeppelin#1032) * clean up code * change array syntax * fix fmt * Improve SNIP12 examples (OpenZeppelin#1036) * docs: improve examples * refactor: remove empty line * Update docs/modules/ROOT/pages/guides/snip12.adoc Co-authored-by: Andrew Fleming <[email protected]> --------- Co-authored-by: Andrew Fleming <[email protected]> * Release v0.15.0-rc.0 (OpenZeppelin#1039) * feat: update CHANGELOG * Bump version to 0.15.0-rc.0 * docs: add missing header * feat: apply review suggestions --------- Co-authored-by: ericnordelo <[email protected]> * Bump cairo to 2.7.0-rc.1 (OpenZeppelin#1025) * feat: migrate modules * feat: delete cairo_project.toml * feat: update tests * feat: apply review updates * fix: remove extra line * feat: add CHANGELOG entry * fix: CHANGELOG * Bump Scarb to 2.7.0-rc.2 (OpenZeppelin#1052) * bump scarb to 2.7.0-rc.2 * add changelog entry * update changelog entry * bump scarb in installation page * Add timelock component (OpenZeppelin#996) * start timelock comp draft * move timelock to own dir, finish drafting component * tmp: add utility impls * add timelock mock * add test mod for timelock * fix commnet * add constructor to timelock mock * set min_delay in initializer * start tests * fix fmt * fix schedule assertion * add schedule tests * fix fmt * remove unused import * fix errs, _before_call * start execute tests * fix fmt * fix after_call * add execute tests * add abi interface * add reentrancy mock for timelock * add tests for cancel and update_delay * fix hash_op test * add execute with predecessor test * add timelock utils, add operation_state debug impl * fix fmt * improve imports * improve _execute * add basic mock for tests * add tmp call struct * add batch fns to interface * add batch fns * refactor tests to use dedicated mock, add batch tests * fix fmt * remove use clause * add timelock mixin * fix interface name * improve event assertions * fix execute and schedule events * fix fmt * add safe token transfer tests * fix fmt * tidy up code * add descriptions to events * clean up code * inline CallPartialEq fns * start fn descriptions * remove comments * remove comment * fix fmt * add changelog entries * improve spacing * add line break to hash test * clean up tests * clean up tests * fix constants in attacker impl * add initializer helper, register access control support * add _before_call and _after_call tests * fix reentrant batch mock call * add _schedule and _execute tests * add timelock description * fix formatting * fix comments * fix comment * fmt * tidy up tests * remove batch helper fn * remove event from mocks * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * update spdx * remove token receiver support * add additional cancel tests * Apply suggestions from code review Co-authored-by: Eric Nordelo <[email protected]> * initializer: remove mut, use while loop * fix fmt * add assert_only_self fn * fix getter comments re: pending/waiting * add assert_only_role * add specific op errors * make event names consistent * fix test * remove serialization from HashCallImpl * remove unused components from mock * clean up code * update to 2.7.0-rc.1 * fix fmt * import Call from corelib * update spdx * fix fmt * move OperationState, derive debug * fix fmt * fix hash impls * add for loops * fix PartialEq, add tests * fix fmt * simplify mixin fns * switch Poseidon to Pedersen * make admin a req in initializer * update tests with admin * fix fmt * fix comment * undo changes * add no admin initializer test --------- Co-authored-by: Eric Nordelo <[email protected]> * fix fmt * bump scarb to 2.7.0-rc.4 (OpenZeppelin#1064) * bump scarb to 2.7.0-rc.4 * add changelog * bump scarb in installation page * fix fmt * feat: update workflow and fix warning (OpenZeppelin#1066) * bump scarb * add tmp usc install in ci * fix changelog --------- Co-authored-by: Eric Nordelo <[email protected]> Co-authored-by: ericnordelo <[email protected]> Co-authored-by: JChoy <[email protected]>

Co-authored-by: Andrew Fleming <[email protected]>

…orkspace-conversion

…tracts into workspace-conversion

…ontracts into workspace-conversion

andrew-fleming

LGTM! I just left a small question

andrew-fleming · 2024-08-01T16:24:20Z

.github/workflows/test.yml

-    branches:
-    - main


Should we put this back?

…orkspace-conversion

ericnordelo and others added 24 commits June 28, 2024 11:33

refacto repo into packages

a9b4eb3

fmt

890608e

Migrate erc1155 tests (OpenZeppelin#1037)

c3df288

* feat: update common module * feat: migrate dual modules * feat: finish component test migration * refactor: remove unnecessary imports * feat: apply review updates

Check ignored tests (OpenZeppelin#1049)

fbfb819

* test: check ignored tests and add reason * feat: apply review updates

feat: update ignored tests messages (OpenZeppelin#1056)

78aa934

Migrate erc1155 preset tests (OpenZeppelin#1057)

daff8e5

* feat: update tests * refactor: remove unnecessary import

Migrate cryptography and UDC tests (OpenZeppelin#1059)

c34d4d0

* fix import name * migrate cryptography tests * migrate udc tests * fix fmt * fix impl name * fix event assertions * re-add class hash helper

Migrate AccessControl Tests (OpenZeppelin#1044)

a794ca0

* Migrate AccessControl tests * Migrate AccessControl Dual Dispatcher tests * Fix imports * Address review comments * Update error messages * Bring back separator line * Fix ignore reasons in access module * Fix review issues

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

9e9adf9

…orkspace-conversion

feat: make contracts build

852c43b

feat: update packages Scarb.toml

b8d597a

refactor: remove gitmodules file

fddddbd

feat: refactor tests

8851d2b

ericnordelo mentioned this pull request Jul 26, 2024

Implement Scarb Workspaces and Modularize Codebase #1038

Closed

4 tasks

ericnordelo added 5 commits July 26, 2024 20:22

feat: update workflow

4ac1903

feat: test utils

094ab98

feat: add missing tests

6dcdad3

Merge branch 'snforge-migration' of github.com:OpenZeppelin/cairo-con…

b0be872

…tracts into workspace-conversion

fix: tests

d678419

feat: add entry to CHANGELOG and update README

0af0fff

ericnordelo marked this pull request as ready for review July 29, 2024 11:52

ericnordelo requested review from andrew-fleming and immrsd July 29, 2024 11:52

doc: update imports

15d5fcb

ericnordelo mentioned this pull request Jul 29, 2024

feat: add ERC2981 component #1043

Closed

4 tasks

ericnordelo mentioned this pull request Jul 31, 2024

feat: Add Merkle Proof Verifier #970

Closed

4 tasks

andrew-fleming reviewed Aug 1, 2024

View reviewed changes

andrew-fleming and others added 9 commits July 31, 2024 21:56

Update docs/modules/ROOT/pages/components.adoc

fc8b397

Co-authored-by: Andrew Fleming <[email protected]>

Update docs/modules/ROOT/pages/components.adoc

25c199b

Co-authored-by: Andrew Fleming <[email protected]>

feat: apply review updates

493b426

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

29b6e01

…orkspace-conversion

Merge branch 'snforge-migration' of github.com:OpenZeppelin/cairo-con…

fc929c3

…tracts into workspace-conversion

feat: update governance package

530b087

refactor: format files

66e6d2f

Merge branch 'workspace-conversion' of github.com:ericnordelo/cairo-c…

39cf6c1

…ontracts into workspace-conversion

ericnordelo requested a review from andrew-fleming August 1, 2024 12:35

refactor: remove unused files

72bd08a

andrew-fleming approved these changes Aug 1, 2024

View reviewed changes

ericnordelo added 4 commits August 1, 2024 18:35

fix: workflow

44492c7

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

d8b88eb

…orkspace-conversion

refactor: remove warnings

97b4cac

feat: remove old tests

d58c751

andrew-fleming mentioned this pull request Aug 1, 2024

ERC721 URI Storage #1031

Open

4 tasks

ericnordelo merged commit 4f1d539 into OpenZeppelin:main Aug 2, 2024
7 checks passed

ericnordelo deleted the workspace-conversion branch August 2, 2024 11:57

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Migrate to multiple packages (workspace) #1065

Migrate to multiple packages (workspace) #1065

ericnordelo commented Jul 26, 2024 •

edited

Loading

ericnordelo commented Jul 29, 2024

andrew-fleming left a comment

andrew-fleming Jul 29, 2024

andrew-fleming Aug 1, 2024

ericnordelo Aug 1, 2024

andrew-fleming left a comment

andrew-fleming Aug 1, 2024

Migrate to multiple packages (workspace) #1065

Migrate to multiple packages (workspace) #1065

Conversation

ericnordelo commented Jul 26, 2024 • edited Loading

PR Checklist

ericnordelo commented Jul 29, 2024

andrew-fleming left a comment

Choose a reason for hiding this comment

andrew-fleming Jul 29, 2024

Choose a reason for hiding this comment

andrew-fleming Aug 1, 2024

Choose a reason for hiding this comment

ericnordelo Aug 1, 2024

Choose a reason for hiding this comment

andrew-fleming left a comment

Choose a reason for hiding this comment

andrew-fleming Aug 1, 2024

Choose a reason for hiding this comment

ericnordelo commented Jul 26, 2024 •

edited

Loading