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 - Bincode 2 (usages) #48

Open
wants to merge 20 commits into
base: develop
Choose a base branch
from

Conversation

DaMatrix
Copy link

@DaMatrix DaMatrix commented Aug 2, 2024

Description

This PR depends on #47 (bincode-2) and #45 (crypto).

This implements the new Bincode 2 Encode/Decode traits on virtually every relevant type.

Note that this simply uses the default trait derivations, the exact encoding of objects will come in a subsequent PR.

Changelog

  • Derived Encode and Decode for all types which could be contained in a Transaction

Type of Change

Please mark the appropriate option by putting an "x" inside the brackets:

  • Bug fix
  • New feature
  • Enhancement or optimization
  • Documentation update
  • Other (please specify)

Checklist

Put an "x" in the boxes that apply. If you're unsure about any of these, don't hesitate to ask. We're here to help!

  • I have tested the changes locally and they work as expected.
  • I have added necessary documentation or updated existing documentation.
  • My code follows the project's coding standards and style guidelines.
  • I have added/updated relevant tests to ensure the changes are properly covered.
  • I have checked for and resolved any merge conflicts.
  • My commits have clear and descriptive messages.

Screenshots (if applicable)

If the changes affect the UI or have visual effects, please provide screenshots or GIFs showcasing the changes.

Additional Context (if applicable)

Add any additional context or information about the changes that may be helpful in understanding the pull request.

Related Issues (if applicable)

If this pull request is related to any existing issues, please list them here.

Requested Reviewers

Mention any specific individuals or teams you would like to request a review from.

DaMatrix added 19 commits June 26, 2024 10:26
This allows other structs which wrap a fixed-length byte array to simply use it as a field, and not have to deal with any of the details of formatting or JSON hex (de)serialization.
this makes it clear which serialization format is being used where, as we are going to be changing this up soon
This will enable us to keep JSON serialization separate from the binary encoding, and also be much more explicit about the exact binary representation of objects.
Also implemented PlaceholderIndexed for all crypto structs
@DaMatrix DaMatrix requested a review from a team as a code owner August 2, 2024 13:08
…-2-usages

# Conflicts:
#	src/primitives/asset.rs
@BHouwens
Copy link
Contributor

BHouwens commented Aug 4, 2024

@DaMatrix I will stop here, as this is dealing with bincode serialization I'd prefer to have this released and tagged as a new version on tw_chain before I continue. That way we can test against Network and isolate better if we run into any issues (although I don't think we'll have any looking at the code 👍)

I'll leave comments on the other PRs, even if it's just to tacitly approve. Once the new release is out and tested in a dev environment, I'll carry on with official approvals

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.

2 participants