Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add AccessManager guide #4691

Merged
merged 34 commits into from
Nov 9, 2023
Merged

Add AccessManager guide #4691

merged 34 commits into from
Nov 9, 2023

Conversation

ernestognw
Copy link
Member

Added an Access Manager guide to the "Access Control" section.

PR Checklist

  • Tests
  • Documentation
  • Changeset entry (run npx changeset add)

@changeset-bot
Copy link

changeset-bot bot commented Oct 18, 2023 •
edited
Loading

⚠️ No Changeset found

Latest commit: de39ada

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ernestognw ernestognw requested a review from Amxx October 18, 2023 06:42
@ernestognw ernestognw requested a review from Amxx October 20, 2023 18:09
Amxx
Amxx reviewed Oct 26, 2023
View reviewed changes
ernestognw and others added 12 commits October 26, 2023 11:21
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
f737706 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update contracts/mocks/docs/access-control/AccessControlERC20MintMiss…
326e4f7 
…ing.sol

Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
d0290e2 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
2947618 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
584888f 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
a709051 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
d54983c 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
8c79f0b 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @Amxx
Update docs/modules/ROOT/pages/access-control.adoc
44f98c4 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw @ericglau
Add view modifier to proxyAdmin in TransparentUpgradeableProxy (O…
600cb0d 
…penZeppelin#4688)

Co-authored-by: Eric Lau <[email protected]>
@Amxx @ernestognw
Migrate Ownable tests (OpenZeppelin#4657)
da02c39 
Co-authored-by: ernestognw <[email protected]>
@Amxx @ernestognw
Migrate MerkleProof tests among other testing utilities (OpenZeppel…
1672d3a 
…in#4689)
@ernestognw ernestognw requested a review from ericglau November 6, 2023 14:54
ericglau
ericglau reviewed Nov 6, 2023
View reviewed changes
ericglau
ericglau previously approved these changes Nov 6, 2023
View reviewed changes
Copy link
Member

@ericglau ericglau left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Amxx
Amxx reviewed Nov 8, 2023
View reviewed changes
Copy link
Collaborator

@Amxx Amxx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Guide says:

this is demonstrated in the following Javascript code using Ethers.js

But we have { from: ... } in many places, which is the Web3.js way.

I suggested:

  • some minor wording things
  • changes to make the javascript part ethers.js → is that something we will want to migrate more widelly ?

@ernestognw @Amxx
Apply suggestions from code review
de39ada 
Co-authored-by: Hadrien Croubois <[email protected]>
@ernestognw
Copy link
Member Author

Guide says:

this is demonstrated in the following Javascript code using Ethers.js

But we have { from: ... } in many places, which is the Web3.js way.

Honestly I've been trying not to delay this PR being excessively strict with the Javascript code examples. They're somewhat messed up across all the docs.

changes to make the javascript part ethers.js → is that something we will want to migrate more widelly ?

We have a ticket for this in the list of pending documentation changes.

@ernestognw ernestognw merged commit cb1ef86 into OpenZeppelin:master Nov 9, 2023
ernestognw added a commit to ernestognw/openzeppelin-contracts that referenced this pull request Nov 9, 2023
@ernestognw @Amxx
@ericglau @zackrw
Add AccessManager guide (OpenZeppelin#4691)
6681676 
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Eric Lau <[email protected]>
Co-authored-by: Zack Reneau-Wedeen <[email protected]>
ernestognw added a commit that referenced this pull request Nov 9, 2023
@ernestognw @Amxx
@ericglau @zackrw
Add AccessManager guide (#4691) (#4724)
83330a6 
Co-authored-by: Hadrien Croubois <[email protected]>
Co-authored-by: Eric Lau <[email protected]>
Co-authored-by: Zack Reneau-Wedeen <[email protected]>
@ernestognw ernestognw mentioned this pull request Nov 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@zackrw zackrw zackrw left review comments

@Amxx Amxx Amxx approved these changes

@ericglau ericglau ericglau left review comments

Assignees
No one assigned
Labels
ignore-changeset
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@ernestognw @zackrw @Amxx @ericglau