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

refactor: renaming abi as artifact #2756

Merged
merged 17 commits into from
Oct 11, 2023
Merged

Conversation

benesjan
Copy link
Contributor

@benesjan benesjan commented Oct 10, 2023

Fixes #2101

Note: In some places it made sense to use the ABI term because it really referred to what ABI means in the Ethereum world (function name, args, return types and no bytecode and verification key). Given this I renamed FunctionAbiHeader as FunctionAbi and what was FunctionAbi is now FunctionArtifact.

Checklist:

Remove the checklist to signal you've completed it. Enable auto-merge if the PR is ready to merge.

  • If the pull request requires a cryptography review (e.g. cryptographic algorithm implementations) I have added the 'crypto' tag.
  • I have reviewed my diff in github, line by line and removed unexpected formatting changes, testing logs, or commented-out code.
  • Every change is related to the PR description.
  • I have linked this pull request to relevant issues (if any exist).

@benesjan benesjan changed the title refactor: renamed user facing ABI names refactor: renaming abi as artifact Oct 10, 2023
Copy link
Member

Choose a reason for hiding this comment

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

Doesn't look like anything's changed here, still see ABI on the copy if that was the intention

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You are right. Updated the diagram in 3a56231

Copy link
Member

Choose a reason for hiding this comment

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

Do we want to keep the directory as foundation/abi if all other references related to this are now called artifact?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I would rename it but I think it makes sense to do it in a separate PR because moving files and renaming their contents can result in ugly conflicts.

@benesjan benesjan merged commit c0abcfd into master Oct 11, 2023
80 checks passed
@benesjan benesjan deleted the janb/artifact-insted-of-abi branch October 11, 2023 07:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Use "artifact" instead of "abi" to refer to the JSON file that the contract compiler spits out
2 participants