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

improve(deployments): Update README with more instructions on proxy vs implementation addresses #597

Merged
merged 4 commits into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions deployments/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,10 @@
# Across Mainnet Deployment Addresses

All of the SpokePool addresses listed here are [upgradeable proxy](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/2d081f24cac1a867f6f73d512f2022e1fa987854/contracts/proxy/utils/UUPSUpgradeable.sol) contract addresses. If you want to get implementation contract information (ABI, bytecode, addresses) then go to the relevant folder in this directory for the contract and chain you are looking for. You can read more about the proxy upgradeability pattern we use [here](https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable/blob/2d081f24cac1a867f6f73d512f2022e1fa987854/contracts/proxy/README.adoc)

The [`deployments.json`](./deployments.json) file also maintains the most up to date **proxy (i.e.not implementation)** addresses and you should view it as the source of truth in case it differs from this `README`.
This is because this `deployments.json` file is used by bots in [`@across-protocol/relayer`](https://github.com/across-protocol/relayer) and [`@across-protocol/sdk`](https://github.com/across-protocol/sdk) to programmatically load the latest contract addresses. This `README` is not a dependency in those repositories so it is more likely to be out of sync with the latest addresses.

## Mainnet (1)

| Contract Name | Address |
Expand Down
Loading