Add `AccessManager` guide #4691

ernestognw · 2023-10-18T06:42:11Z

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

PR Checklist

Tests
Documentation
Changeset entry (run npx changeset add)

changeset-bot · 2023-10-18T06:42:14Z

⚠️ 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

contracts/mocks/docs/access-control/AccessControlERC20MintBase.sol

contracts/mocks/docs/access-control/AccessControlERC20MintMissing.sol

contracts/mocks/docs/access-control/AccessManagedERC20MintBase.sol

….sol Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

contracts/mocks/docs/access-control/AccessControlERC20MintMissing.sol

docs/modules/ROOT/pages/access-control.adoc

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

…ing.sol Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

…penZeppelin#4688) Co-authored-by: Eric Lau <ericglau@outlook.com>

Co-authored-by: ernestognw <ernestognw@gmail.com>

…in#4689)

docs/modules/ROOT/pages/access-control.adoc

Co-authored-by: Zack Reneau-Wedeen <z.reneau.wedeen@gmail.com> Co-authored-by: Eric Lau <ericglau@outlook.com>

docs/modules/ROOT/pages/access-control.adoc

Co-authored-by: Eric Lau <ericglau@outlook.com>

ericglau

LGTM

Amxx

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 ?

docs/modules/ROOT/pages/access-control.adoc

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

ernestognw · 2023-11-08T20:05:57Z

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.

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Eric Lau <ericglau@outlook.com> Co-authored-by: Zack Reneau-Wedeen <z.reneau.wedeen@gmail.com>

Add AccessManager guide

419fc00

ernestognw requested a review from Amxx October 18, 2023 06:42

ernestognw added the ignore-changeset label Oct 18, 2023

ernestognw added 2 commits October 18, 2023 00:44

Codespell

4849dbb

Fix contract identifiers

aab6c32

Amxx reviewed Oct 20, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessControlERC20MintBase.sol Outdated Show resolved Hide resolved

Amxx reviewed Oct 20, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessControlERC20MintBase.sol Show resolved Hide resolved

Amxx reviewed Oct 20, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessControlERC20MintBase.sol Show resolved Hide resolved

Amxx reviewed Oct 20, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessControlERC20MintMissing.sol Outdated Show resolved Hide resolved

Amxx reviewed Oct 20, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessManagedERC20MintBase.sol Outdated Show resolved Hide resolved

ernestognw and others added 2 commits October 20, 2023 11:49

Update contracts/mocks/docs/access-control/AccessManagedERC20MintBase…

03437c7

….sol Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Corrections

1d72816

ernestognw requested a review from Amxx October 20, 2023 18:09

Update

f1c6b37

Amxx reviewed Oct 26, 2023

View reviewed changes

contracts/mocks/docs/access-control/AccessControlERC20MintMissing.sol Outdated Show resolved Hide resolved

Amxx reviewed Oct 26, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

Amxx reviewed Oct 26, 2023

View reviewed changes

ernestognw and others added 12 commits October 26, 2023 11:21

Update docs/modules/ROOT/pages/access-control.adoc

f737706

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update contracts/mocks/docs/access-control/AccessControlERC20MintMiss…

326e4f7

…ing.sol Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

d0290e2

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

2947618

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

584888f

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

a709051

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

d54983c

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

8c79f0b

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Update docs/modules/ROOT/pages/access-control.adoc

44f98c4

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Add view modifier to proxyAdmin in TransparentUpgradeableProxy (O…

600cb0d

…penZeppelin#4688) Co-authored-by: Eric Lau <ericglau@outlook.com>

Migrate Ownable tests (OpenZeppelin#4657)

da02c39

Co-authored-by: ernestognw <ernestognw@gmail.com>

Migrate MerkleProof tests among other testing utilities (OpenZeppel…

1672d3a

…in#4689)

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

zackrw reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

ernestognw and others added 7 commits November 6, 2023 13:37

Apply suggestions from code review

d01776c

Co-authored-by: Zack Reneau-Wedeen <z.reneau.wedeen@gmail.com> Co-authored-by: Eric Lau <ericglau@outlook.com>

Merge branch 'master' into docs/add-access-manager-guide

4b29fce

Apply more suggestions

b740f76

Apply more suggestions

75057a3

Access Manager -> AccessManager

f86742e

Access Manager -> AccessManager

abaab0d

Fix links and apply more suggestions

b95cda6

ernestognw requested a review from ericglau November 6, 2023 14:54

ericglau reviewed Nov 6, 2023

View reviewed changes

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

docs/modules/ROOT/pages/access-control.adoc Outdated Show resolved Hide resolved

Apply suggestions from code review

647a5e8

Co-authored-by: Eric Lau <ericglau@outlook.com>

ericglau previously approved these changes Nov 6, 2023

View reviewed changes

Merge

4b96759

ernestognw dismissed ericglau’s stale review via 4b96759 November 7, 2023 18:42

Format js code as Ethers

be6e909

Amxx reviewed Nov 8, 2023

View reviewed changes

Apply suggestions from code review

de39ada

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>

Amxx approved these changes Nov 9, 2023

View reviewed changes

ernestognw merged commit cb1ef86 into OpenZeppelin:master Nov 9, 2023
18 checks passed

ernestognw added a commit that referenced this pull request Nov 9, 2023

Add AccessManager guide (#4691) (#4724)

83330a6

Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com> Co-authored-by: Eric Lau <ericglau@outlook.com> Co-authored-by: Zack Reneau-Wedeen <z.reneau.wedeen@gmail.com>

ernestognw mentioned this pull request Nov 9, 2023

Close access-control.adoc code block #4726

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `AccessManager` guide #4691

Add `AccessManager` guide #4691

ernestognw commented Oct 18, 2023

changeset-bot bot commented Oct 18, 2023 •

edited

Loading

ericglau left a comment

Amxx left a comment

ernestognw commented Nov 8, 2023

Add AccessManager guide #4691

Add AccessManager guide #4691

Conversation

ernestognw commented Oct 18, 2023

PR Checklist

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

⚠️ No Changeset found

ericglau left a comment

Choose a reason for hiding this comment

Amxx left a comment

Choose a reason for hiding this comment

ernestognw commented Nov 8, 2023

Add `AccessManager` guide #4691

Add `AccessManager` guide #4691

changeset-bot bot commented Oct 18, 2023 •

edited

Loading