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

Deployment artifacts preparation #18

Closed
cygnusv opened this issue Feb 17, 2022 · 3 comments
Closed

Deployment artifacts preparation #18

cygnusv opened this issue Feb 17, 2022 · 3 comments
Assignees

Comments

@cygnusv
Copy link
Member

cygnusv commented Feb 17, 2022

When contracts are deployed, information about the deployment such as addresses and ABIs are stored in the build/deployments directory (see https://eth-brownie.readthedocs.io/en/stable/build-folder.html#the-build-folder).

For release purposes, we want this information to be structured in a more amenable way, potentially similar to how we're already doing manually, which is as individual JSON files on the artifacts directory (this is useful for when our repo is published as an NPM package and consumed by others). There are many open questions/tasks here:

  • Decide on a structure to organize deployment artifacts (e.g., under the artifacts directory)
  • Create tooling that automatically organizes deployment data generated by Brownie into the artifacts structure that we decide
  • How to deal with our multichain setting? Most contracts are on Ethereum, but some contracts will start to live on Matic. How about non-EVM compatible networks (e.g. Polkadot, Solana, etc)?

We can consider this as a meta-issue that will probably branch out to new more concrete issues

@theref
Copy link
Contributor

theref commented May 3, 2022

do we want to use the built in release functionality provided by github? similar to nucypher/

we can dump all json/abi etc into the artifacts directory and then tag it

@cygnusv
Copy link
Member Author

cygnusv commented Sep 19, 2023

Latest ideas @KPrasch and I just discussed:

  • Extend ape deployment scripts to obtain the newly deployed addresses and ABIs and track these internally somehow (TBD, potentially a simple JSON file that's written locally)
  • Create a script that process the JSON file and produces:
    • a new nucypher-style registry
    • a new NPM package

@KPrasch
Copy link
Member

KPrasch commented Oct 31, 2023

Closed by #119

@KPrasch KPrasch closed this as completed Oct 31, 2023
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

No branches or pull requests

6 participants