Skip to content

fix: reorg for clear proxy usage#944

Merged
smartcontracts merged 4 commits intodevelopfrom
docs/add-note-on-proxies
May 25, 2021
Merged

fix: reorg for clear proxy usage#944
smartcontracts merged 4 commits intodevelopfrom
docs/add-note-on-proxies

Conversation

@platocrat
Copy link
Copy Markdown
Contributor

Description
Fixes #898 by adding a secondary table for proxied contracts and a note above the new table, for each network in the optimism/packages/contracts/deployments/README.md

@changeset-bot
Copy link
Copy Markdown

changeset-bot bot commented May 24, 2021

⚠️ No Changeset found

Latest commit: 7846ad0

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

@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented May 24, 2021

Codecov Report

Merging #944 (7846ad0) into develop (4e6c3f9) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff            @@
##           develop     #944   +/-   ##
========================================
  Coverage    82.21%   82.21%           
========================================
  Files           48       48           
  Lines         1895     1895           
  Branches       303      303           
========================================
  Hits          1558     1558           
  Misses         337      337           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4e6c3f9...7846ad0. Read the comment docs.

@tynes
Copy link
Copy Markdown
Contributor

tynes commented May 24, 2021

This file is autogenerated so it should not be edited manually. If you want to change it, you need to update the script that generates it

@smartcontracts
Copy link
Copy Markdown
Contributor

Copy link
Copy Markdown
Contributor

@smartcontracts smartcontracts left a comment

Choose a reason for hiding this comment

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

Change should be made by editing the script that generates this file, located here: https://github.com/ethereum-optimism/optimism/blob/develop/packages/contracts/scripts/generate-markdown.js

@platocrat platocrat closed this May 24, 2021
@platocrat platocrat force-pushed the docs/add-note-on-proxies branch from 89a640b to 467d6cb Compare May 24, 2021 22:01
@platocrat
Copy link
Copy Markdown
Contributor Author

woops, didn't mean to close this

@platocrat
Copy link
Copy Markdown
Contributor Author

I think we're good now

@smartcontracts
Copy link
Copy Markdown
Contributor

Hmmm. I think the following might be a bit easier to follow:

  1. Put the proxies back in the primary list
  2. Remove the implementation contracts from the primary list
  3. Put the implementation contracts inside of an html comment in the markdown so we can still see them but they aren't displayed publicly, like:
<!--
Implementation addresses. DO NOT use these addresses directly. Use their proxied counterparts seen above.

... addresses go here
-->

@platocrat platocrat closed this May 24, 2021
@platocrat platocrat force-pushed the docs/add-note-on-proxies branch from 0451a58 to 467d6cb Compare May 24, 2021 22:32
@platocrat platocrat reopened this May 24, 2021
@smartcontracts smartcontracts merged commit ba72b1d into develop May 25, 2021
@smartcontracts smartcontracts deleted the docs/add-note-on-proxies branch May 25, 2021 01:34
InoMurko pushed a commit to omgnetwork/optimism that referenced this pull request May 25, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Ensure addresses of implementation contracts are not published in documentation

4 participants