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

generate go bindings in one package per contract/library #270

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

generate go bindings in one package per contract/library #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,10 +62,11 @@ bindings-gen-go: build-contracts
continue; \
fi; \
type=$$(basename $$abi_file .abi.json); \
pkg=$$(basename $$abi_base .sol | tr "[:upper:]" "[:lower:]"); \
pkg=$$(basename $$type .sol | tr "[:upper:]" "[:lower:]"); \
Copy link

Choose a reason for hiding this comment

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

⚠️ Potential issue

Correct package name derivation

In the bindings-gen-go target, the package name is derived using a transformation that may not handle all cases correctly.

Update the package name derivation to handle contract names with uppercase letters correctly.

Apply this diff to fix the issue:

-	pkg=$$(basename $$type .sol | tr "[:upper:]" "[:lower:]"); \
+	pkg=$$(echo $$type | sed -E 's/([A-Z])/_\L\1/g' | sed 's/^_//'); \

This change converts CamelCase names to snake_case, which is more appropriate for Go package names.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
pkg=$$(basename $$type .sol | tr "[:upper:]" "[:lower:]"); \
pkg=$$(echo $$type | sed -E 's/([A-Z])/_\L\1/g' | sed 's/^_//'); \

mkdir -p ./bindings/go/$$pkg; \
abigen --abi $$abi_file --pkg $$pkg --type $$type --out ./bindings/go/$$pkg/$$type.go; \
done; \
go build ./... || exit 1; \
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: you need the || exit 1. If go build fails, the make target will fail too.

Copy link
Contributor

Choose a reason for hiding this comment

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

nit2: maybe add a message saying "running check sanity on bindings" or similar?

echo "Done."

bindings-gen-ts: build-contracts
Expand Down
2 changes: 1 addition & 1 deletion ...gs/go/iproofverifier/IAppStateVerifier.go → ...go/iappstateverifier/IAppStateVerifier.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ...ings/go/ibcdispatcher/IbcEventsEmitter.go → ...s/go/ibceventsemitter/IbcEventsEmitter.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/ibcdispatcher/IbcPacketSender.go → ...ngs/go/ibcpacketsender/IbcPacketSender.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/ilightclient/IClientUpdates.go → bindings/go/iclientupdates/IClientUpdates.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/mars/PanickingMars.go → bindings/go/panickingmars/PanickingMars.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/channel/ProtoChannel.go → bindings/go/protochannel/ProtoChannel.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/channel/ProtoCounterparty.go → ...go/protocounterparty/ProtoCounterparty.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/mars/RevertingBytesMars.go → .../revertingbytesmars/RevertingBytesMars.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/mars/RevertingEmptyMars.go → .../revertingemptymars/RevertingEmptyMars.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion ...o/mars/RevertingStringCloseChannelMars.go → ...elmars/RevertingStringCloseChannelMars.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bindings/go/mars/RevertingStringMars.go → ...evertingstringmars/RevertingStringMars.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading