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.

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

chore: Initial shape of centralized place for all Deployed contract addresses #165

Merged
merged 6 commits into from
Jan 24, 2024

Conversation

wdinau
Copy link
Contributor

@wdinau wdinau commented Jan 19, 2024

Problems to solve:
We would like one centralized place, publicly expose key contract addresses, so that we provide both confidence, trust and convenience to the builders and users in the community.
Currently, Immutable teams use Confluence or other alternatives to track deployed and verified contract addresses. They may or may not be up to date. No community members can see them from our public Docs. If they go to our chain exploer, since we deployed same thing multiple times, it's also not easy to see which ones are official.

Solution

  • 1 json starts with most basic information about each contract that are useful in our ecosystem.
  • Merge and publish this list ahead of Mainnet announcement.
  • Short term will duplicate this information to a table on docs.immutable.com ZKevm Overview page.
  • Long term, will automate pump this json info to where we need. Including potentially make an endpoint for this json to be available. Develop history tracking for it, and automation related to deployment.

Reviewers please:

  • give feedback to the schema of this json. Keep it simple and powerful, did it miss any critical info?
  • add, remove, modify Contracts that your team is responsible for --- instead of updating address in your team's Confluence, use here as source of truth.

@wdinau wdinau requested review from a team January 19, 2024 01:46
contract_address.json Outdated Show resolved Hide resolved
contract_address.json Outdated Show resolved Hide resolved
"Tags": ["traders"]
},
{
"Contract Name": "Read Only Order Validator",
Copy link
Contributor

Choose a reason for hiding this comment

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

There's a few auxiliary contracts that do not have public facing/orderbook facing interfaces, and are only used by contracts through internal transactions, not sure how useful it is to make these public. Thoughts @immutable/traders ?

@wdinau wdinau requested review from a team and removed request for a team January 23, 2024 00:51
@wdinau wdinau changed the title DO NOT MERGE YET. Initial shape of centralized place for all Deployed contract addresses. chore: Initial shape of centralized place for all Deployed contract addresses Jan 24, 2024
@wdinau wdinau removed the request for review from a team January 24, 2024 03:13
@wdinau wdinau merged commit 3001244 into main Jan 24, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants