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

fix: simplified contract artifacts (#692) #693

Closed
wants to merge 6 commits into from

Conversation

quiet-node
Copy link
Member

@quiet-node quiet-node commented Mar 4, 2024

Description:
This PR streamlines contract artifacts by adopting ABI-only artifacts, replacing the default artifact files that include various attributes (_contractName, sourceName, abi, bytecode, deployedBytecode, linkReferences, deployedLinkReferences). Previously, all artifact files were committed to the repository, but now only ABI-only artifacts are included. Default artifacts continue to be generated post-compilation alongside ABI-only artifacts, but they are no longer committed to the repository.

Tasks done:

  • tweaked the .gitignore file to drop the artifacts folder except for the necessary contracts required for the System Contract DApp
  • installed hardhat-abi-exporter plugin to generate ABI-only artifacts
  • configured hardhat-abi-exporter in the hardhat.config.js file to allow custom output path and run on every compilation
  • added the folder contains ABI-only artifacts to the commit tree

Related issue(s):

Fixes #692

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@quiet-node quiet-node added enhancement New feature or request Tooling tooling labels Mar 4, 2024
@quiet-node quiet-node self-assigned this Mar 4, 2024
@quiet-node quiet-node requested a review from a team as a code owner March 4, 2024 18:04
@quiet-node quiet-node linked an issue Mar 4, 2024 that may be closed by this pull request
@quiet-node quiet-node changed the title 692 simplifying contract artifacts fix: simplified contract artifacts (#692) Mar 4, 2024
@quiet-node quiet-node marked this pull request as draft March 4, 2024 18:09
Copy link

github-actions bot commented Mar 4, 2024

Test Results

242 tests  ±0   236 ✔️ +2   7m 42s ⏱️ +24s
  72 suites ±0       6 💤 ±0 
  14 files   ±0       0  - 2 

Results for commit 9f34fe3. ± Comparison against base commit b7224a1.

♻️ This comment has been updated with latest results.

@quiet-node quiet-node force-pushed the 692-simplifying-contract-artifacts branch 4 times, most recently from 99c286c to 5abe6ce Compare March 4, 2024 19:24
@quiet-node quiet-node force-pushed the 692-simplifying-contract-artifacts branch from 5abe6ce to 9f34fe3 Compare March 4, 2024 19:28
@quiet-node quiet-node marked this pull request as ready for review March 4, 2024 19:46
Copy link
Collaborator

@Nana-EC Nana-EC left a comment

Choose a reason for hiding this comment

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

Good change but too large a PR.
Please break this up

@Nana-EC Nana-EC requested review from ebadiere, acuarica, natanasow and AlfredoG87 and removed request for david-bakin-sl March 5, 2024 15:25
Copy link
Contributor

@ebadiere ebadiere left a comment

Choose a reason for hiding this comment

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

LG.

@quiet-node quiet-node closed this Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Tooling tooling
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Simplifying Contract Artifacts
3 participants