Extract contract addresses from artifacts #3086
Merged
Conversation
This file contains hidden or 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
We want to resolve the package to download with `npm view` as it checks the registry for the current package that is tagged. When `npm pack` was used it used cached version of the tagged package and wasn't downloading the latest one.
We already download artifacts of deployed contracts from NPM registry. Here we add support of extracting addresses of contracts from the artifacts. The address is extracted and stored in `_address/<CONTRACT>` file and then embeded into the go code. This solution is intended to be used for clients building for specific environment. For example if we set `CONTRACTS_NPM_PACKAGE_TAG` environment variable to `goerli`. It will download a package of contracts deployed on Goerli network and extract addresses from it. The client will be build specific for Goerli network, without a need of configuring the addresses in a config file. There will be a possibility to overwrite the addresses with a configuration file or environment variables. Addresses extraction will happen on `go generate ./...` command execution along with the go bindings generation. To test the solution for Goerli please run: `CONTRACTS_NPM_PACKAGE_TAG=goerli go generate./...` Please note that for `development` which is a default tag the addresses will be replaced with zeros, as the contracts artifacts that are published with `development` tags are intended only for ABIs generation, as the contracts are deployed locally in CI, and won't be accessible anywhere.
We cleanup always before running bindings generation as current configuration of make doesn't work well with source artifacts that are extracted from tar archive.
Added a json artifact reference as a prerequisite for binding generation.
`jq` is required by go generator command.
The files are required to exist by gosec.
pdyraga
reviewed
Jul 13, 2022
Member
|
I am having problems testing it locally. Anything extra I should do? |
Member
Author
For goerli only threshold network and random beacon generation will work. We need to publish contracts first. I suggest in this PR we test just the |
Member
OK, this is fine. I tested with just |
pdyraga
reviewed
Jul 13, 2022
The directory no longer exist.
The directories have missing `_address/*` files so gosec fails. We could put the files into repo or generate them, but also just exclude the directories.
pdyraga
approved these changes
Jul 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
We already download artifacts of deployed contracts from the NPM registry.
Here we add support for extracting addresses of contracts from the
artifacts. The address is extracted and stored in
_address/<CONTRACT>file and then embedded into the go code.
This solution is intended to be used for clients building for a specific environment. For example, if we set
CONTRACTS_NPM_PACKAGE_TAGenvironment variable togoerli. It will download a package of contracts deployed on the Goerli network and extract addresses from it. The client will be built specifically for the Goerli network, without the need of configuring the addresses in a config file.There will be a possibility to overwrite the addresses with a configuration file or environment variables.
Addresses extraction will happen on
go generate ./...command execution along with the go bindings generation.To test the solution for Goerli please run:
CONTRACTS_NPM_PACKAGE_TAG=goerli go generate./...Please note that for
developmentwhich is a default tag the addresses will be replaced with zeros, as the contracts artifacts that are published withdevelopmenttags are intended only for ABIs generation, as the contracts are deployed locally in CI, and won't be accessible anywhere.In a follow-up PR we will resolve contract addresses to initialize the chain handle.