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

Rename Binary=>Bytes, FixedBinary=>BytesN #394

Merged
merged 2 commits into from
Aug 2, 2022
Merged

Rename Binary=>Bytes, FixedBinary=>BytesN #394

merged 2 commits into from
Aug 2, 2022

Conversation

leighmcculloch
Copy link
Member

@leighmcculloch leighmcculloch commented Aug 2, 2022

What

Rename Binary=>Bytes and FixedBinary=>BytesN.

Why

Binary is a somewhat confusing term. When I see it in the docs it doesn't scream at me that this is the type for storing byte slices or byte arrays. Doing a quick survey of Ethereum, they use the term Bytes in both Solidity and Vyper. Thinking back to whenever I have explained Binary to others or in my head, I immediately reach for the term "bytes" or "byte slice".

This change helps others gracefully update their code because is still contains the Binary and FixedBinary types, with deprecated notices to encourage folks to switch to the new types.

Close #385

@leighmcculloch leighmcculloch requested a review from a team August 2, 2022 15:55
@leighmcculloch leighmcculloch marked this pull request as ready for review August 2, 2022 15:56
@leighmcculloch leighmcculloch requested review from jayz22 and jonjove and removed request for a team and jayz22 August 2, 2022 19:33
@jonjove
Copy link
Contributor

jonjove commented Aug 2, 2022

Skimmed it and it looks reasonable enough. Should the spec type names change too?

@leighmcculloch
Copy link
Member Author

Should the spec type names change too?

Good point. We should update the val XDR too. I created stellar/stellar-xdr#14 to do this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Rename Binary to Bytes
2 participants