feat: Use addresses from mangrove-deployments and context-addresses packages #651
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
espendk
force-pushed
the
feat/move-addresses-to-mangrove-deployments
branch
3 times, most recently
from
2af89e4 to
53958cd
Compare
espendk
changed the title
espendk
force-pushed
the
feat/move-addresses-to-mangrove-deployments
branch
2 times, most recently
from
0329fae to
e587525
Compare
…kage This is a first version that simply copies the latest primary addresses to the addressses/deployed folder.
By default, query for deployments matching patches of the package version.
This is a first version that simply copies the addresses to the addressses/context folder.
Instead of the ambiguous token symbols use the instance ID's assigned by context-addresses. This makes all token instances available and enforces clarity on which ERC20 instance on is interacting with. To ease the transition, the default instances are still available using just the token symbol as identifier. However, use of this is deprecated.
espendk
force-pushed
the
feat/move-addresses-to-mangrove-deployments
branch
from
59c4bcb to
f5f64d2
Compare
dontrolle
suggested changes
Nov 15, 2023
espendk
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a first improvement to the deployment process: It moves context and deployment addresses out of this repo to these new repos/npm packages:
This enables better management of deployments, incl. matching deployments to contract versions. Furthermore, it removes the need to publish new versions of this package due to deployments; This in turn allow us to use the package SemVer for contract versioning.
Similar considerations apply to extracting the context addresses.
Later PR's will address other remaining aspects re. the deployment process such as:
Brief solution overview
The existing file-based address infrastructure is retained: Addresses are still read from files in the
addressesfolder using the same code and directory&file structures as before.The change is that, instead of having the addresses files in git, they are generated in a new build step by copying addresses from
addresses/deployedaddresses/contextThis is handled by two new scripts:
copyDeploymentAddresses.jscopyContextAddresses.js.These scripts have a few configuration parameters in
config.js. See that file for details and documentation.Also, the CI file guard that guarded against unintended changes to addresses has been removed, since addresses are no longer in this repo.
Versioning and deployments
When querying
mangrove-deploymentsfor deployment addresses, one must specify the contract version and whether the deployment is of a "released" version.By default,
copyDeploymentAddresses.jsqueries for contract versions matching patches of the current package version, regardless of whether it's released. Both defaults can be changed inconfig.js; In that case, the user is responsible for specifying a version that is compatible with the current version of the governance scripts.