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.

Sign up for GitHub

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

Jump to bottom

Create TeleporterMessenger ABI Go binding #41

Merged
merged 29 commits into from
Oct 4, 2023
Merged

Create TeleporterMessenger ABI Go binding #41

merged 29 commits into from
Oct 4, 2023

Conversation

gwen917
Copy link
Contributor

@gwen917 gwen917 commented Sep 26, 2023 •
edited
Loading

Why this should be merged

  • Generate TeleporterMessenger ABI Go bindings.
    • ./scripts/abi_go_bindings.sh
    • The script build the contracts to generate ABI files, and then generate TeleporterMessenger ABI Go bindings using abigen.
  • The abi_go_bindings_checker github action checks if the generated Go bindings are from the latest contracts

How this was tested

  • CI

@gwen917 gwen917 marked this pull request as draft September 26, 2023 19:33
@gwen917 gwen917 linked an issue Sep 26, 2023 that may be closed by this pull request
Add TeleporterMessenger Go binding #39
Closed
@gwen917 gwen917 marked this pull request as ready for review September 26, 2023 22:06
@geoff-vball
Copy link
Contributor

Can we make abi_go_bindings.sh generic, so it takes in a file with a list of .abi.json files, (and maybe also the desired package name), and then iterates and produces the .go abi files for all of them?

@gwen917
Copy link
Contributor Author

gwen917 commented Sep 29, 2023

Can we make abi_go_bindings.sh generic, so it takes in a file with a list of .abi.json files, (and maybe also the desired package name), and then iterates and produces the .go abi files for all of them?

I want to build the contract first, then use the generated files in the out dir. In this way, if the contract is changed, we just need one step to generate the go files instead of build and then run the script. What if we give a list of contract name, then generate the go files of these contracts?

@geoff-vball
Copy link
Contributor

Yeah, that'll work!

cam-schultz
cam-schultz reviewed Oct 3, 2023
View reviewed changes
abis/TeleporterMessenger/TeleporterMessenger.abi.json Outdated Show resolved Hide resolved
.github/workflows/check_clean_branch.sh Outdated Show resolved Hide resolved
.github/workflows/check_clean_branch.sh Outdated Show resolved Hide resolved
.github/workflows/abi_go_bindings_checker.yml Outdated Show resolved Hide resolved
.github/workflows/abi_go_bindings_checker.yml Outdated
Comment on lines 4 to 6
push:
branches:
- main
Copy link
Contributor

Choose a reason for hiding this comment

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

We may only want to do this on pull requests, since the CI job works by (potentially) modifying the branch. I'm sure it's highly unlikely to cause issues, but I'd prefer if we didn't do that on main in any automated fashion.

Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding is that every workflow should be run in it's own environment. I don't think this test is really only important in PRs though, so I'm fine with this either way.

.github/workflows/abi_go_bindings_checker.yml Outdated Show resolved Hide resolved
scripts/abi_go_bindings.sh Outdated
cd .. && pwd
)

DEFAULT_CONTRACT_LIST="TeleporterMessenger"
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we add the cross-chain apps to this list, and add the resulting Go bindings to this PR?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added the cross-chain apps. Could you check if I missed anything?

minghinmatthewlam
minghinmatthewlam reviewed Oct 3, 2023
View reviewed changes
.github/workflows/abi_go_bindings_checker.yml
on:
pull_request:
branches:
- "*"
Copy link

Choose a reason for hiding this comment

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

do we need need to add on push to main?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

based on Cam's comments, we may not want to run this on main in automated fashion

geoff-vball
geoff-vball reviewed Oct 4, 2023
View reviewed changes
Copy link
Contributor

@geoff-vball geoff-vball left a comment

Choose a reason for hiding this comment

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

Just one small comment here. Otherwise everything looks great.

scripts/abi_go_bindings.sh Outdated Show resolved Hide resolved
.github/workflows/abi_go_bindings_checker.yml Outdated
Comment on lines 4 to 6
push:
branches:
- main
Copy link
Contributor

Choose a reason for hiding this comment

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

My understanding is that every workflow should be run in it's own environment. I don't think this test is really only important in PRs though, so I'm fine with this either way.

geoff-vball
geoff-vball previously approved these changes Oct 4, 2023
View reviewed changes
Copy link
Contributor

@geoff-vball geoff-vball left a comment

Choose a reason for hiding this comment

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

LGTM!

cam-schultz
cam-schultz reviewed Oct 4, 2023
View reviewed changes
Copy link
Contributor

@cam-schultz cam-schultz left a comment

Choose a reason for hiding this comment

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

Let's include bindings for BridgeToken.sol. Otherwise LGTM

scripts/abi_go_bindings.sh Outdated Show resolved Hide resolved
@gwen917 gwen917 requested a review from geoff-vball October 4, 2023 17:09
cam-schultz
cam-schultz approved these changes Oct 4, 2023
View reviewed changes
Copy link
Contributor

@cam-schultz cam-schultz left a comment

Choose a reason for hiding this comment

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

LGTM!

@gwen917 gwen917 merged commit 8e8f16b into main Oct 4, 2023
10 of 11 checks passed
@gwen917 gwen917 deleted the abi-go-binding branch October 4, 2023 17:27
minghinmatthewlam pushed a commit that referenced this pull request Oct 1, 2024
Bump github.com/onsi/ginkgo/v2 from 2.16.0 to 2.17.0 (#41)
4bf46c4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@cam-schultz cam-schultz cam-schultz approved these changes

@geoff-vball geoff-vball geoff-vball approved these changes

@michaelkaplan13 michaelkaplan13 Awaiting requested review from michaelkaplan13

@bernard-avalabs bernard-avalabs Awaiting requested review from bernard-avalabs

@minghinmatthewlam minghinmatthewlam Awaiting requested review from minghinmatthewlam

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add TeleporterMessenger Go binding
4 participants
@gwen917 @geoff-vball @minghinmatthewlam @cam-schultz