Skip to content

Commit

Permalink
Migrate AccessControl to component (#770)
Browse files Browse the repository at this point in the history 
* fix: link (#545)

* add submodule

* update cairo

* add Cargo and Makefile

* update cairo

* add deps in cairo_project, create lib

* add presets

* add base lib

* add tests

* remove old cairo lib and interface

* remove unused import

* fix vars

* change external funcs to snake case

* remove unused import

* update cairo

* add tests for externals

* add bool assertions

* update cairo

* remove preset mods

* add IERC20 trait

* update cairo

* clean up test

* remove assertion

* update cairo

* simplify max_u256

* clarify error msg

* add erc165 + tests

* kickstart account module

* clean up python project. ready for rust/cairo1

* re-structure project

* re-structure project

* re-structure project

* update makefile

* bump submodule

* Update erc20 migration branch (#586)

* Change the spelling of "StarkNet" to "Starknet" (#557)

* fix: link (#545)

* change StarkNet to Starknet

---------

Co-authored-by: Eric Nordelo <[email protected]>

* add Cargo and Makefile

* add deps in cairo_project, create lib

* add presets

* add base lib

* add tests

* remove old cairo lib and interface

* remove unused import

* fix vars

* change external funcs to snake case

* remove unused import

* add tests for externals

* add bool assertions

* remove preset mods

* add IERC20 trait

* clean up test

* remove assertion

* simplify max_u256

* clarify error msg

* clean up python project. ready for rust/cairo1

* add erc165 + tests

* kickstart account module

* re-structure project

* re-structure project

* re-structure project

* update makefile

* re-structure project

* update to felt252, add use ContractAddress

* formatting

* remove colons from storage, remove _mint from initializer

* add constructor test

* add comments

* fix format

* check error msg in tests

* set max_u256 as func

* update cairo

* update cargo

* revert doc commit

* remove __init__

* refix link

---------

Co-authored-by: kongtaoxing <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Migrate security/initializable (#592)

* update cairo

* fix path

* add security mod

* add initializable

* add tests

* Update src/openzeppelin/security/initializable.cairo

Co-authored-by: Martín Triay <[email protected]>

* remove underscore

* add internal macros

---------

Co-authored-by: Martín Triay <[email protected]>

* Use zeroable::zero() instead of contract_address_const::<0>() (#598)

* use zeroable for address

* cleanup import

* Migrate security/pausable (#593)

* fix path

* add security mod

* add pausable

* add mock

* add tests

* add security mod

* update cargo

* update cairo

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* remove underscore from _paused

* remove unused imports

* add test assertion for is_paused

* move mocks inside tests crate

* remove underscore

* add blank line

---------

Co-authored-by: Martín Triay <[email protected]>

* add utils and constants

* Revert "add utils and constants"

This reverts commit e86bcd2107b052e13c58a9af7907e1f82e427a60.

* Migrate ERC165 (#582)

* Apply suggestions from code review

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

* apply review suggestions

* remove unused import

* add internal macro

* add deregister

---------

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

* Migrate constants (#611)

* add utils and constants

* simplify role val

* add context comments for interface ids

* Set up new CI (#599)

* add lint and test

* fix name

* add md linter

* add header

* remove extra line

* add blank line

* remove env

* change name

* fix on condition

* change name

* fix formatting

* remove trailing comma in storage

* fix formatting (#613)

* Normalize error message style (#606)

* normalize error msg

* update cairo

* update Cargo

* fix test command

* update should_panic syntax

* use super for interface import

* Add `BoundedInt` and internal macros, update cairo (#600)

* update cairo

* update Cargo

* remove path flag

* refactor _spend_allowance with BoundedInt

* add BoundedInt for u256_max

* add internal macros

* update cairo

* update cairo

* update Cargo

* remove import

* update expected syntax

* remove redundant maxu256 fn

* update expected syntax

* Update src/openzeppelin/tests/test_erc20.cairo

Co-authored-by: Hadrien Croubois <[email protected]>

* use into trait

* use address zeroable in mod

* set cairo to alpha7

* update Cargo

---------

Co-authored-by: Hadrien Croubois <[email protected]>

* Migrate ownable (#604)

* add ownable

* add ownable tests

* simplify renounce

* fix formatting

* add internal macros

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* add test_transfer_ownership_from_zero

* update cairo to alpha7

* update Cargo

* fix expected syntax

* update cairo to rc0

* update Cargo

* fix import

* simplify imports

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* Update src/openzeppelin/token/erc20.cairo

Co-authored-by: Eric Nordelo <[email protected]>

* fix set_caller_address

---------

Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>

* Migrate security/reentrancyguard (#590)

* add reentrancyguard

* update Cargo

* remove mytest

* add reentrancy mocks

* add utils

* finish tests

* remove unused func

* add comments

* clean up code

* clean up code

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* remove underscore

* remove constructor in mock

* update interface name

* change count_this_recursive to count_external_recursive

* move mocks inside tests dir

* remove underscore

* update cairo to alpha7

* update Cargo

* add withdraw_gas

* fix formatting

* update cairo to rc0

* update Cargo

* fix import

* simplify imports

* remove duplicate import

* rename mod

* add mock interface

* finish tests

* update cairo

* add new line

* Update src/openzeppelin/tests/mocks/reentrancy_mock.cairo

Co-authored-by: Eric Nordelo <[email protected]>

* import dispatchers

* fix formatting

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* add deploy fn to utils

* use deploy from utils

---------

Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>

* Migrate access control (#605)

* add accesscontrol

* add accesscontrol tests

* remove mock, add impl to contract

* fix formatting

* remove accesscontrol mock

* formatting, remove unused imports

* integrate erc165

* fix typo

* update cairo to alpha7

* update Cargo

* update expected syntax

* update expected syntax

* update cairo to rc0

* update Cargo

* fix import

* simplify imports

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* fix storage mapping name

* rename impl

* add warning

* fix comment

* remove constructor, setup test constructor in setup

* fix format

* fix import format

* add test for granting already granted role

* add clarity to revoke role test

* add test for revoking already revoked role

* add test for renouncing already renounced role

* add test for revoked admin role losing privileges

* fix test_role_admin_cycle

* add target func as comment

* add default admin tests

* refactor tests, rename actors

* add tests for has_role and set_role_admin

* tidy up tests

* add general doc for events

* fix assert_only_role test

* remove redundant test

* remove unnecessary assertion

* remove duplicate test

* Update src/openzeppelin/access/accesscontrol.cairo

Co-authored-by: Martín Triay <[email protected]>

* fix imports, define constants locally

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* fix test name

* bump cairo

* fix formatting

---------

Co-authored-by: Martín Triay <[email protected]>

* Migrate account (#620)

* continue account implementation

* add missing account interface functions

* tidy up module

* fix validate

* bump cairo + account changes

* fix __execute__, add serde, rename felt>felt252

* tidy up code

* add account tests

* complete account implementation

* Apply suggestions from code review

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

* apply review suggestions

* remove unused import

* clarify __execute__ guard

* add account tests

* add internals

* tidy up

* add internal macro

* add internal macro

* add deregister

* update erc165

* feat: refactor account and add validate_transaction test

* feat: work on span serde

* feat: add test for validate

* refactor: remove unnecessary imports

* refactor: tests

* feat: implement test_execute

* Update src/openzeppelin/tests/test_account.cairo

Co-authored-by: Martín Triay <[email protected]>

* Update src/openzeppelin/tests/test_account.cairo

Co-authored-by: Martín Triay <[email protected]>

* feat: update from review

* feat: format files

* feat: SpanSerde compiling version

* feat: update tests and interface

* feat: format file

* feat: add test for multicall

* feat: add more tests

* test: remove unused function

* refactor: update ERC20 interface and module

* feat: add impl again

* refactor: apply review comments

* test: execute out of gas

* refactor: is valid signature because of lack of short circuit condicionals

* refactor: apply updates from reviews

* feat: add SpanSerde implementation

* refactor: remove span_to_array

* Update src/openzeppelin/tests/test_account.cairo

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

* Update src/openzeppelin/account.cairo

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

* test: update from review

* feat: splitting account interface and abi

* feat: add new account files

* remove underscore on mod api methods

* remove comment

* remove underscore

* move erc1271 id to interface

* remove unused import

* integrate deploy util

* add comments for validate dummy params

* add initializer

* change error msg

* add empty sig tests

* move test

* replace dummy args, fix comments

* fix formatting

* tidy up code

* add erc20 transfer call in execute test

* tidy up imports

* remove unused const

---------

Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>

* Migrate ERC721 (#619)

* continue account implementation

* add missing account interface functions

* tidy up module

* fix validate

* bump cairo + account changes

* fix __execute__, add serde, rename felt>felt252

* tidy up code

* WIP ERC721

* make format

* fix dispatcher call

* clean

* working on tests

* replace match with `is_some()` and `is_none()` for readeability

* erc721 tests

* use Option.expect

* add account tests

* check panic reason

* rename _owner() to _owner_of()

* spacing

* complete account implementation

* apply recommandation for PR

* Apply suggestions from code review

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

* check low level ownership int

* prefix test function with test_

* Apply suggestions from code review

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

* apply review suggestions

* remove unused import

* clarify __execute__ guard

* add account tests

* add internals

* tidy up

* update ERC165 ids to u32

* apply sugestions from code review

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* update & expand tests

* update lock

* add internal macro

* add internal macro

* add deregister

* update erc165

* wip (dispatched issue)

* fix abi

* start array→span transition

* minimise account dependency

* add SpanSerde in utils

* add dual interfaces

* update test message. fix linter

* split interfaces from preset module

* fix linter

* rename metadata id var

* add camelCase to traits

* fully implement dual interface traits

* simplify _owner_of

* add constructor and getter tests

* add token_uri tests

* remove conflictive test

* add erc721receiver. add IERC721ABI

* add safe_transfer_from tests

* add safe_mint tests

* Update src/openzeppelin/token/erc721/interface.cairo

Co-authored-by: Eric Nordelo <[email protected]>

* move erc721 abi next to module

* address review comments

---------

Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>

* Dual interface dispatcher for ERC721 (#623)

* add dual interface dispatcher draft

* complete dual721 implementation

* fix format

* add felt252 <> bool casts

* simplify Felt252IntoBool

* make felt252 into -> try_into

* add base test suite

* implement most tests

* add mocks

* add tests for panic cases

* fix some tests

* fix format

* fix more tests

* fix tests

* apply review feedback

* normalize mock names

* add token_uri tests

* rename non implementing mock

* move comment

* upgrade to cairo 1.1.1

* Update src/openzeppelin/utils.cairo

Co-authored-by: Eric Nordelo <[email protected]>

* address review comments

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Replace ERC-165 with SRC-5 (Update Interface Ids) (#637)

* feat: add src5 module

* refactor: interface ids and account standard interface

* refactor: naming convention

* refactor: separate interfaces

* feat: apply last SNIP update

* fix: account interface signature

* feat: apply updates from review

* fix: accesscontrol interface id

* Update src/openzeppelin/account/account.cairo

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

* feat: apply update from review

---------

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

* Fix conflicts from the dual721 and src5 merge (#641)

* add abi to interfaces

* change u32 to felt

* Add camel support for ownable (#625)

* add camel support

* add camel tests

* nest ownable into dir

* move interface

* add dual ownable

* add const selectors

* add try_selector_with_fallback and bool impl

* nest access tests in test dirs

* move accesscontrol and ownable test mods

* move tests

* move tests

* add mocks

* add dual ownable tests

* add panic traits

* tidy up tests

* fix formatting

* remove comments

* fix hierarchy

* remove import comments

* remove comment

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* remove unused import

* fix camel dispatcher

* normalize assert error msg

* fix formatting

* remove redundant assertion

* change selector casing

* remove unused import

* fix comments, add ref for ignored tests

* fix comments

* remove panic trait

* bump to cairo v1.1.1

* update Cargo

* remove ignore from tests

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* remove selectors from constants

* add selectors to selectors.cairo

* remove selector bindings

* fix comment

* remove/fix comments

* fix conflicts

* Update src/openzeppelin/utils/selectors.cairo

Co-authored-by: Eric Nordelo <[email protected]>

---------

Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: Eric Nordelo <[email protected]>

* Add camel support for access control (#626)

* add camel support

* add camel tests

* move accesscontrol into dir

* separate interface

* add try_selector_with_fallback and bool impl

* add const selectors

* add dual accesscontrol

* move access tests

* add panic trait

* add accesscontrol mocks

* add dual accesscontrol tests

* fix formatting

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* add comment to supportsInterface

* add tests for supports_interface

* remove comments

* alphabetize use clauses

* remove util panic trait

* remove unused imports

* remove unused imports

* remove unused import

* update selector casings

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* fix casing on target calls

* add space to comments

* remove comments, add ref with ignored tests

* remove unused imports

* remove selectors from constants

* add selectors to selectors mod

* fix formatting

* reorder selectors

* fix comment

* update interface id

* replace erc165 with src5

* fix conflicts

* replace u32 with felt

* add abi to interfaces

* remove ignore from tests

* fix formatting

* fix comment

* remove camel supportsInterface

* fix comment consistency

* Update src/openzeppelin/tests/access/test_dual_accesscontrol.cairo

Co-authored-by: Eric Nordelo <[email protected]>

* add append_serde

* change append to append_serde

* remove unused import

* remove bindings

---------

Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* erc20 dual dispatcher (#622)

* add camel methods

* update erc20 dispatcher path

* refactor tests, add tests for camel methods

* fix formatting

* add try_selector_with_fallback and bool impl

* add erc20 selectors

* add abi to traits

* add dual20 mocks

* add panic trait

* add dual20 mocks

* add dual20

* add dual20

* add dual20 tests

* tidy up tests

* move tests to token dir

* fix formatting

* clean up tests

* restructure token tests

* remove panic trait

* reorder imports

* remove unused imports

* fix comments

* update const selector casings

* remove comments

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* change target member to contract_address

* fix formatting

* fix dispatcher calls

* change dispatcher to dual_dispatcher

* reorder use clauses

* move selectors to selectors mod

* fix formatting

* reorder selectors

* remove duplicate selectors

* remove ignore

* simplify dispatcher vars

* fix comment

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix test constants

* add SerializedAppend trait

* integrate append_serde

* integrate append_serde and utils selector

* change u256 fns to constants

* change u256 fns to constants

* move dual721 test to token/, apply append_serde, change u256 fn to constant

* fix formatting

* add append_serde

* move append_serde to serde

* update append_serde path

* change dispatcher to IERC20

* remove unnecessary into()

* remove bindings

* add binding to empty arrays

* fix formatting

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Add `UnwrapAndCast` trait (#644)

* add unwrap_and_cast trait and impls

* use unwrap_and_cast

* tidy up code

* add UnwrapAndCastU8 impl

* reorder use clauses

* use unwrap_and_cast on view fns

* add test_dual721 mod (#648)

* Update account interface (#646)

* feat: update interface and ids

* refactor: format files

* feat: update from reviews

* Update src/openzeppelin/account/account.cairo

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

---------

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

* Add camel support for Account (#647)

* feat: update interface and ids

* refactor: format files

* feat: update from reviews

* feat: add dual interface to account

* fix: tests

* feat: add tests

* feat: add more tests

* feat: apply review suggestions

* feat: apply review updates

* Update src/openzeppelin/tests/account/test_dual_account.cairo

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

---------

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

* Add src5 dual dispatcher (#659)

* add dual src5

* add dual src5 tests and mocks

* add felt impl

* remove unused imports, integrate unwrap_and_cast for felts

* add supports_interface to interface

* add supports_interface to erc721 interface

* add camelCase supportsInterface test

* add dual supports_interface to mocks

* add dual supports_interface tests

* add dual supports_interface to tests

* add comment

* fix formatting

* clean up test

* add comments

* remove unused imports

* fix interface

* fix src5 impl

* apply review suggestion

* Add dual case erc721 receiver (#649)

* add 721 holder

* add 721 receiver selectors

* add abis

* add dual receiver

* add dual receiver mocks

* add dual 721 receiver and holder mods

* add dual 721 receiver tests

* integrate dual case receiver

* remove camel supportsInterface

* add isrc5 impl

* add isrc5 impl

* fix formatting

* change receiver import

* remove unused mod

* add isrc5 impl

* remove mod

* fix formatting

* remove conflict

* add felt impl to UnwrapAndCast

* clean up mocks

* add camelCase ISRC5 impl

* add camelCase tests for safe methods

* fix test

* remove unused imports

* remove unused imports

* remove unused imports

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* add transferFrom and safeTransferFrom tests

* fix comments

* fix comments

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Add owner param to ownable initializer (#660)

* feat: add owner param to ownable initializer

* feat: apply review updates

* fix: remove unnecessary mut

* Update src/openzeppelin/tests/access/test_dual_ownable.cairo

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

---------

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

* Migrate SRC5 to Cairo 2 (#664)

* feat: migrate files

* feat: add interface.cairo

* feat: apply review updates

* refactor: improve readability

* Migrate initializable to cairo2 (#661)

* bump to cairo v2.0.2

* update Cargo

* comment out mods

* update initializable syntax

* move security tests

* update initializable tests

* fix formatting

* update cairo

* update Cargo

* simplify and clarify tests

* fix formatting

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix tests

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Migrate Account to Cairo 2 (#666)

* feat: migrate files

* feat: add interface.cairo

* feat: apply review updates

* refactor: improve readability

* fix: dual account tests

* fix: account tests

* feat: apply review updates

* Migrate pausable to cairo2 (#662)

* bump to cairo v2.0.2

* update Cargo

* comment out mods

* update initializable syntax

* move security tests

* update initializable tests

* fix formatting

* update pausable syntax

* update pausable tests

* update cairo

* update Cargo

* simplify and clarify tests

* fix formatting

* simplify and clarify tests

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix tests

* change StorageTrait to InternalTrait

* use InternalImpl

* add external pausable impl

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Migrate reentrancyguard to cairo2 (#663)

* bump to cairo v2.0.2

* update Cargo

* comment out mods

* update initializable syntax

* move security tests

* update initializable tests

* fix formatting

* remove SpanSerde

* update reentrancyguard syntax

* add reentrancyguard mocks

* update reentrancyguard tests

* update cairo

* update Cargo

* simplify and clarify tests

* fix formatting

* simplify and clarify tests

* fix formatting

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix tests

* change StorageTrait to InternalTrait

* remove internal is_entered

* use internal contract state

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix import order

* change generic state to TState

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Migrate ERC721 to Cairo2 (#667)

* feat: migrate files

* feat: add interface.cairo

* feat: apply review updates

* refactor: improve readability

* fix: dual account tests

* fix: account tests

* fix: mocks

* fix: dual721 tests

* fix: erc721 tests

* feat: apply review updates

* feat: apply review suggestions

* Migrate ownable to cairo2 (#665)

* bump to cairo v2.0.2

* update Cargo

* comment out mods

* update initializable syntax

* move security tests

* update initializable tests

* fix formatting

* remove SpanSerde

* update ownable syntax

* add ownable_camel impl

* update syntax in ownable mocks

* update ownable tests

* fix formatting

* update cairo

* update Cargo

* simplify and clarify tests

* fix formatting

* simplify internal fns

* add initializer

* fix constructor, tidy up code

* fix tests

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix tests

* change StorageTrait to InternalTrait

* start refactor

* change impls to external fns

* use IOwnableCamelOnly

* fix tests

* remove unneeded mut

* remove unneeded mut

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* change to TState

* fix formatting

* remove Ownable prefix in fn calls

* remove internal owner fn

* use internal state trait to read owner

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Migrate ERC20 to Cairo 2 (#669)

* feat: fix tests

* feat: apply review updates

* Migrate access control to cairo2 (#668)

* bump to cairo v2.0.2

* update Cargo

* comment out mods

* update initializable syntax

* move security tests

* update initializable tests

* fix formatting

* remove SpanSerde

* update ownable syntax

* add ownable_camel impl

* update syntax in ownable mocks

* update ownable tests

* fix formatting

* update cairo

* update Cargo

* simplify and clarify tests

* fix formatting

* simplify internal fns

* add initializer

* fix constructor, tidy up code

* fix tests

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* fix tests

* change StorageTrait to InternalTrait

* update syntax

* update mocks

* start updating tests

* start refactor

* change impls to external fns

* use IOwnableCamelOnly

* fix tests

* remove unneeded mut

* remove unneeded mut

* fix mocks

* simplify events

* change array syntax

* update syntax in tests

* fix formatting

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* add space between events

* fix generic state

* add space between events

* fix formatting

---------

Co-authored-by: Eric Nordelo <[email protected]>

* Migrate to Scarb for cairo-2 (#671)

* Migrate to Scarb

* Hide tests module behind cfg

* Add spdx (#684)

* add spdx

* add spdx

* feat: sort imports (#679)

* Migrate upgrades (#603)

* add upgrades to lib

* add proxy mod

* update cairo

* update Cargo

* fix test command

* add upgrades

* fix spelling

* add upgrade test

* fix spelling

* add upgrade_and_call

* update cairo

* update Cargo

* add events

* tidy up code

* fix format

* update cairo to alpha7

* update Cargo

* fix expected syntax

* fix conflict

* update expected syntax

* formatting

* update cairo to rc0

* update Cargo

* fix import

* refactor mocks

* start test refactor

* simplify upgrades, add upgrade_and_call

* refactor mocks

* refactor upgrades

* refactor tests

* fix imports, add impl

* fix imports

* fix formatting

* add abis to mocks

* refactor tests with dispatchers

* fix formatting

* start migration

* update syntax

* update syntax in mocks

* fix tests

* add line

* remove line

* add upgradeable trait

* replace interface impl with trait impl

* fix formatting

* add assertion

* add tests for events

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* move logic to internal impl

* add interface

* update paths

* fix formatting

* simplify imports

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* Apply suggestions from code review

Co-authored-by: Martín Triay <[email protected]>

* remove upgrade_and_call, test event in separate test

* remove upgrade_and_call

* remove unused import

* reorder imports, tidy up code

---------

Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Add testing for Ownable events (#675)

* feat: add tests for ownable events

* feat: improve tests

* Update src/tests/utils.cairo

Co-authored-by: Martín Triay <[email protected]>

---------

Co-authored-by: Martín Triay <[email protected]>

* Add account events (#687)

* feat: add tests for ownable events

* define account events

* add event to set_public_key

* add event test

* change param name

* fix event emit param

* fix formatting

* add tests for events

* add default checks in tests

* feat: improve tests

* Apply suggestions from code review

Co-authored-by: Eric Nordelo <[email protected]>

* reorder imports, remove Account prefix

* fix events

* fix formatting

* Update src/tests/utils.cairo

Co-authored-by: Martín Triay <[email protected]>

* add event checks, use ZERO from constants

* fix formatting

---------

Co-authored-by: Eric Nordelo <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Add testing for AccessControl events (#674)

* feat: add testing for events

* feat: add tests for ownable events

* feat: improve tests

* feat: apply review updates

* Add testing for Pausable events (#676)

* feat: add testing for events

* feat: add tests for ownable events

* feat: add tests for pausable events

* Update src/openzeppelin/tests/security/test_pausable.cairo

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

* feat: improve tests

* feat: apply review updates

* feat: apply review updates

---------

Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Add testing for ERC20 events (#677)

* feat: add testing for events

* feat: add tests for ownable events

* feat: add tests for pausable events

* feat: add tests for erc20 events

* Update src/openzeppelin/tests/security/test_pausable.cairo

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

* feat: apply review updates

* feat: improve tests

* feat: apply review updates

* feat: apply review updates

* feat: apply review updates

---------

Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Add mint to erc721 preset constructor (#700)

* add _mint to constructor

* add constructor assertions

* fix formatting

* Add testing for ERC721 events (#678)

* feat: add testing for events

* feat: add tests for ownable events

* feat: add tests for pausable events

* feat: add tests for erc20 events

* feat: add tests for erc721 events

* Update src/openzeppelin/tests/security/test_pausable.cairo

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

* feat: apply review updates

* feat: add test helper for events

* feat: improve tests

* feat: apply review updates

* feat: apply review updates

* feat: apply review updates

* feat: apply review updates

* feat: apply review updates

---------

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

* Update README and fix scarb package (#688)

* update README to cairo-2 and scarb usage. bump scarb package version

* update readme

fix linter issues

fix linter issues

fix linter issues

update readme

* add main to CI

* update readme

* update readme

* rename starknet

* fix linter

* update readme

* Update README.md

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

* Update README.md

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

* update CONTRIBUTING

* fix linting

* Update CONTRIBUTING.md

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

* Update CONTRIBUTING.md

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

* apply review changes

* fix linter

* fix typo

---------

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

* Bump scarb and fix dual721 test context (#703)

* bump scarb and cairo version

* fix testing context

---------

Co-authored-by: Martín Triay <[email protected]>

* add rc version (#708)

* remove unused imports (#707)

* Upgrade Cairo version and Scarb version to latest releases (#712)

* 👽️ Update code due to breaking changes

* ⬆️ Upgrade scarb and cairo versions

* 💄 Code format

* bump antora (#715)

* Add selector inline macro/fix `tokenURI` (#724)

* update selectors

* use inline selector

* remove selectors file

* remove import

* fix camel tokenURI

* fix formatting

* re-add selectors mod

* import from selectors mod

* fix formatting

* import selector

* fix: naming convention (#732)

* feat: add Errors modules (#691)

* Update account docs (#709)

* feat: update format and add api

* fix: typo

* feat: add counterfactual deployment doc

* feat: add API entries

* feat: add events

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* feat: update from reviews

* feat: apply review updates

* feat: update docs

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply review updates

* fix: account casing

* feat: add headers

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: add link

* feat: move API

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* refactor: update wording

* Update docs/antora.yml

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

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply update reviews

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* refactor: UI

* fix: UI

* feat: focus on SRC6

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply review updates

---------

Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* Add Interface & Dispatchers docs (#730)

* feat: update format and add api

* fix: typo

* feat: add counterfactual deployment doc

* feat: add API entries

* feat: add events

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* feat: update from reviews

* feat: apply review updates

* feat: update docs

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply review updates

* fix: account casing

* feat: add headers

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: add link

* feat: move API

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* refactor: update wording

* Update docs/antora.yml

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

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply update reviews

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* refactor: UI

* fix: UI

* feat: focus on SRC6

* add interface & dispatchers docs

* apply review feedback

* address feedback comments

---------

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

* Update overview docs (#735)

* feat: update format and add api

* fix: typo

* feat: add counterfactual deployment doc

* feat: add API entries

* feat: add events

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* Update docs/modules/ROOT/pages/guides/deployment.adoc

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

* feat: update from reviews

* feat: apply review updates

* feat: update docs

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/guides/deployment.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply review updates

* fix: account casing

* feat: add headers

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: add link

* feat: move API

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* Update docs/modules/ROOT/pages/accounts.adoc

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

* refactor: update wording

* Update docs/antora.yml

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

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply update reviews

* Update docs/modules/ROOT/pages/api/account.adoc

Co-authored-by: Martín Triay <[email protected]>

* refactor: UI

* fix: UI

* feat: focus on SRC6

* Update docs/modules/ROOT/pages/accounts.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: update overview

* feat: apply review updates

* Update docs/modules/ROOT/pages/index.adoc

Co-authored-by: Martín Triay <[email protected]>

* feat: apply review updates

* Update docs/modules/ROOT/pages/index.adoc

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

* feat: apply review updates

* Update docs/modules/ROOT/pages/index.adoc

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

---------

Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: Martín Triay <[email protected]>

* remove underscore from name_ and symbol_ (#738)

* Add prefixes to storage members (#743)

* feat: add prefixes

* Update src/access/accesscontrol/accesscontrol.cairo

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

---------

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

* Sanitizing for release. (#736)

* refactor: sanitizing

* feat: sanitizing

* feat: apply review updates

* feat: apply review updates

* feat: migrate logic

* feat: update workflow

* feat: update logic

* fix: docs

* feat: add main logic with dependencies

* feat: apply review updates

* feat: remove unnecesary imports

* feat: add in-code comments

* feat: apply review updates

* refactor: remove unnecessary trait

* feat: apply update reviews

* refactor: remove imports

* Update src/access/ownable/ownable.cairo

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

* feat: apply review updates

* feat: add comments to camelCase functions

* fix: comment

* Update docs/modules/ROOT/pages/api/access.adoc

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

* feat: apply review updates

* feat: update docs

* docs: add in-code documentation

* feat: update comments

* feat: apply review

* docs: update access page

* docs: update api

* feat: apply review updates

---------

Co-authored-by: Andrew <[email protected]>
Co-authored-by: Martín Triay <[email protected]>
Co-authored-by: kongtaoxing <[email protected]>
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Andrew Fleming <[email protected]>
Co-authored-by: maciektr <[email protected]>
Co-authored-by: Bal7hazar @ Carbonable <[email protected]>
  • Loading branch information
@ericnordelo @andrew-fleming
@martriay @kongtaoxing @Amxx @maciektr @bal7hazar
8 people authored Oct 18, 2023
1 parent d55661a commit 5439350
Show file tree
Hide file tree
Showing 11 changed files with 587 additions and 465 deletions.
167 changes: 93 additions & 74 deletions docs/modules/ROOT/pages/access.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -132,18 +132,40 @@ and sets a 'minter' role:

[,javascript]
----
const MINTER_ROLE: felt252 = selector!('MINTER_ROLE');
const MINTER_ROLE: felt252 = selector!("MINTER_ROLE");
#[starknet::contract]
mod MyContract {
use openzeppelin::access::accesscontrol::AccessControl::InternalImpl::assert_only_role;
use openzeppelin::access::accesscontrol::AccessControl;
use openzeppelin::access::accesscontrol::AccessControl as accesscontrol_component;
use openzeppelin::introspection::src5::SRC5 as src5_component;
use openzeppelin::token::erc20::ERC20;
use starknet::ContractAddress;
use super::MINTER_ROLE;
component!(path: accesscontrol_component, storage: accesscontrol, event: AccessControlEvent);
component!(path: src5_component, storage: src5, event: SRC5Event);
#[abi(embed_v0)]
impl AccessControlImpl =
accesscontrol_component::AccessControlImpl<ContractState>;
#[abi(embed_v0)]
impl SRC5Impl = src5_component::SRC5Impl<ContractState>;
impl AccessControlInternalImpl = accesscontrol_component::InternalImpl<ContractState>;
#[storage]
struct Storage {}
struct Storage {
#[substorage(v0)]
accesscontrol: accesscontrol_component::Storage,
#[substorage(v0)]
src5: src5_component::Storage,
}
#[event]
#[derive(Drop, starknet::Event)]
enum Event {
AccessControlEvent: accesscontrol_component::Event,
SRC5Event: src5_component::Event
}
#[constructor]
fn constructor(
Expand All @@ -160,22 +182,16 @@ mod MyContract {
ERC20::InternalImpl::_mint(ref erc20_state, recipient, initial_supply);
// AccessControl related initialization
let mut access_state = AccessControl::unsafe_new_contract_state();
AccessControl::InternalImpl::initializer(ref access_state);
AccessControl::InternalImpl::_grant_role(
ref access_state,
MINTER_ROLE,
minter
);
self.accesscontrol.initializer();
self.accesscontrol._grant_role(MINTER_ROLE, minter);
}
// This function can only be called by a minter
/// This function can only be called by a minter.
#[external(v0)]
fn mint(ref self: ContractState, recipient: ContractAddress, amount: u256) {
let access_state = AccessControl::unsafe_new_contract_state();
assert_only_role(@access_state, MINTER_ROLE);
self.accesscontrol.assert_only_role(MINTER_ROLE);
let mut erc20_state = AccessControl::unsafe_new_contract_state();
let mut erc20_state = ERC20::unsafe_new_contract_state();
ERC20::InternalImpl::_mint(ref erc20_state, recipient, amount);
}
}
Expand All @@ -192,19 +208,41 @@ Let's augment our ERC20 token example by also defining a 'burner' role, which le

[,javascript]
----
const MINTER_ROLE: felt252 = selector!('MINTER_ROLE');
const BURNER_ROLE: felt252 = selector!('BURNER_ROLE');
const MINTER_ROLE: felt252 = selector!("MINTER_ROLE");
const BURNER_ROLE: felt252 = selector!("BURNER_ROLE");
#[starknet::contract]
mod MyContract {
use openzeppelin::access::accesscontrol::AccessControl::InternalImpl::assert_only_role;
use openzeppelin::access::accesscontrol::AccessControl;
use openzeppelin::access::accesscontrol::AccessControl as accesscontrol_component;
use openzeppelin::introspection::src5::SRC5 as src5_component;
use openzeppelin::token::erc20::ERC20;
use starknet::ContractAddress;
use super::{MINTER_ROLE, BURNER_ROLE};
component!(path: accesscontrol_component, storage: accesscontrol, event: AccessControlEvent);
component!(path: src5_component, storage: src5, event: SRC5Event);
#[abi(embed_v0)]
impl AccessControlImpl =
accesscontrol_component::AccessControlImpl<ContractState>;
#[abi(embed_v0)]
impl SRC5Impl = src5_component::SRC5Impl<ContractState>;
impl AccessControlInternalImpl = accesscontrol_component::InternalImpl<ContractState>;
#[storage]
struct Storage {}
struct Storage {
#[substorage(v0)]
accesscontrol: accesscontrol_component::Storage,
#[substorage(v0)]
src5: src5_component::Storage,
}
#[event]
#[derive(Drop, starknet::Event)]
enum Event {
AccessControlEvent: accesscontrol_component::Event,
SRC5Event: src5_component::Event
}
#[constructor]
fn constructor(
Expand All @@ -222,38 +260,26 @@ mod MyContract {
ERC20::InternalImpl::_mint(ref erc20_state, recipient, initial_supply);
// AccessControl related initialization
let mut access_state = AccessControl::unsafe_new_contract_state();
AccessControl::InternalImpl::initializer(ref access_state);
AccessControl::InternalImpl::_grant_role(
ref access_state,
MINTER_ROLE,
minter
);
AccessControl::InternalImpl::_grant_role(
ref access_state,
BURNER_ROLE,
burner
);
self.accesscontrol.initializer();
self.accesscontrol._grant_role(MINTER_ROLE, minter);
self.accesscontrol._grant_role(BURNER_ROLE, burner);
}
// This function can only be called by a minter
/// This function can only be called by a minter.
#[external(v0)]
fn mint(ref self: ContractState, recipient: ContractAddress, amount: u256) {
let access_state = AccessControl::unsafe_new_contract_state();
assert_only_role(@access_state, MINTER_ROLE);
self.accesscontrol.assert_only_role(MINTER_ROLE);
let mut erc20_state = AccessControl::unsafe_new_contract_state();
let mut erc20_state = ERC20::unsafe_new_contract_state();
ERC20::InternalImpl::_mint(ref erc20_state, recipient, amount);
}
// This function can only be called by a burner
/// This function can only be called by a burner.
#[external(v0)]
fn burn(ref self: ContractState, account: ContractAddress, amount: u256) {
let access_state = AccessControl::unsafe_new_contract_state();
assert_only_role(@access_state, BURNER_ROLE);
self.accesscontrol.assert_only_role(BURNER_ROLE);
let mut erc20_state = AccessControl::unsafe_new_contract_state();
let mut erc20_state = ERC20::unsafe_new_contract_state();
ERC20::InternalImpl::_burn(ref erc20_state, account, amount);
}
}
Expand Down Expand Up @@ -292,20 +318,29 @@ Let's take a look at the ERC20 token example, this time taking advantage of the

[,javascript]
----
const MINTER_ROLE: felt252 = selector!('MINTER_ROLE');
const BURNER_ROLE: felt252 = selector!('BURNER_ROLE');
const MINTER_ROLE: felt252 = selector!("MINTER_ROLE");
const BURNER_ROLE: felt252 = selector!("BURNER_ROLE");
#[starknet::contract]
mod MyContract {
use openzeppelin::access::accesscontrol::AccessControl::InternalImpl::assert_only_role;
use openzeppelin::access::accesscontrol::AccessControl;
use openzeppelin::access::accesscontrol::AccessControl as accesscontrol_component;
use openzeppelin::access::accesscontrol::DEFAULT_ADMIN_ROLE;
use openzeppelin::introspection::src5::SRC5 as src5_component;
use openzeppelin::token::erc20::ERC20;
use starknet::ContractAddress;
use super::{MINTER_ROLE, BURNER_ROLE};
#[storage]
struct Storage {}
component!(path: accesscontrol_component, storage: accesscontrol, event: AccessControlEvent);
component!(path: src5_component, storage: src5, event: SRC5Event);
#[abi(embed_v0)]
impl AccessControlImpl =
accesscontrol_component::AccessControlImpl<ContractState>;
#[abi(embed_v0)]
impl SRC5Impl = src5_component::SRC5Impl<ContractState>;
impl AccessControlInternalImpl = accesscontrol_component::InternalImpl<ContractState>;
(...)
#[constructor]
fn constructor(
Expand All @@ -322,49 +357,33 @@ mod MyContract {
ERC20::InternalImpl::_mint(ref erc20_state, recipient, initial_supply);
// AccessControl related initialization
let mut access_state = AccessControl::unsafe_new_contract_state();
AccessControl::InternalImpl::initializer(ref access_state);
AccessControl::InternalImpl::_grant_role(
ref access_state,
DEFAULT_ADMIN_ROLE,
admin
);
self.accesscontrol.initializer();
self.accesscontrol._grant_role(DEFAULT_ADMIN_ROLE, admin);
}
// This function can only be called by a minter
/// This function can only be called by a minter.
#[external(v0)]
fn mint(ref self: ContractState, recipient: ContractAddress, amount: u256) {
let access_state = AccessControl::unsafe_new_contract_state();
assert_only_role(@access_state, MINTER_ROLE);
self.accesscontrol.assert_only_role(MINTER_ROLE);
let mut erc20_state = AccessControl::unsafe_new_contract_state();
let mut erc20_state = ERC20::unsafe_new_contract_state();
ERC20::InternalImpl::_mint(ref erc20_state, recipient, amount);
}
// This function can only be called by a burner
/// This function can only be called by a burner.
#[external(v0)]
fn burn(ref self: ContractState, account: ContractAddress, amount: u256) {
let access_state = AccessControl::unsafe_new_contract_state();
assert_only_role(@access_state, BURNER_ROLE);
self.accesscontrol.assert_only_role(BURNER_ROLE);
let mut erc20_state = AccessControl::unsafe_new_contract_state();
let mut erc20_state = ERC20::unsafe_new_contract_state();
ERC20::InternalImpl::_burn(ref erc20_state, account, amount);
}
// These function can only be called by the roles' admin
#[external(v0)]
fn grant_role(ref self: ContractState, role: felt252, account: ContractAddress) {
let mut unsafe_state = AccessControl::unsafe_new_contract_state();
AccessControl::AccessControlImpl::grant_role(ref unsafe_state, role, account);
}
#[external(v0)]
fn revoke_role(ref self: ContractState, role: felt252, account: ContractAddress) {
let mut unsafe_state = AccessControl::unsafe_new_contract_state();
AccessControl::AccessControlImpl::revoke_role(ref unsafe_state, role, account);
}
}
----

TIP: The `grant_role` and `revoke_role` functions are automatically exposed as `external` functions
from the `AccessControlImpl` by leveraging the `#[abi(embed_v0)]` annotation.

Note that, unlike the previous examples, no accounts are granted the 'minter' or 'burner' roles.
However, because those roles' admin role is the default admin role, and that role was granted to the 'admin', that
same account can call `grant_role` to give minting or burning permission, and `revoke_role` to remove it.
Expand Down
Loading

0 comments on commit 5439350

Please sign in to comment.