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

Eliminate tech debt from foundation/src/serialize #2593

Closed
2 tasks
benesjan opened this issue Sep 29, 2023 · 0 comments · Fixed by #2722
Closed
2 tasks

Eliminate tech debt from foundation/src/serialize #2593

benesjan opened this issue Sep 29, 2023 · 0 comments · Fixed by #2722
Assignees
@benesjan

Comments

@benesjan
Copy link
Contributor

benesjan commented Sep 29, 2023 •
edited
Loading

There are a few issues with the serialize functionality of the foundation package.

The main one is that vector means a different thing in free_funcs.ts and in buffer_reader.ts.
In free_funcs.ts it is used to describe a blob of data prefixed with its byte length and in buffer_reader.ts it is describes a blob of data prefixed with number of elements inside the vector (number of objects in the vector and not individual bytes).

Another issue is that most of the functionality in the package is unused.

  • Rename the functions in free_funcs.ts to not use the term vector for byte_length prefixed blobs of data.
  • Nuke the the unused functionality (we mostly just use buffer_reader.ts).
@github-project-automation github-project-automation bot moved this to Todo in A3 Sep 29, 2023
@benesjan benesjan self-assigned this Oct 6, 2023
@benesjan benesjan moved this from Todo to In Progress in A3 Oct 6, 2023
@benesjan benesjan mentioned this issue Oct 6, 2023
Merged
4 tasks
benesjan added a commit that referenced this issue Oct 6, 2023
@benesjan
chore: foundation/src/serialization tech debt (#2722)
e92154b 
Fixes #2593 

I marked the `deserializeArrayFromVector` as deprecated because we only
use it in `SiblingPath` and everywhere else we use `BufferReader`.
@github-project-automation github-project-automation bot moved this from In Progress to Done in A3 Oct 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@benesjan benesjan

Labels
None yet
Projects
A3
Archived in project
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: foundation/src/serialization tech debt AztecProtocol/aztec-packages
1 participant
@benesjan