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

bug: Proofs are serialized as strings - undocumented API break in 0.13.0 #3173

Closed
zvolin opened this issue Feb 9, 2024 · 7 comments · Fixed by #3204
Closed

bug: Proofs are serialized as strings - undocumented API break in 0.13.0 #3173

zvolin opened this issue Feb 9, 2024 · 7 comments · Fixed by #3204
Assignees
Labels
area:api Related to celestia-node API area:blob bug Something isn't working external Issues created by non node team members

Comments

@zvolin
Copy link
Contributor

zvolin commented Feb 9, 2024

Celestia Node version

0.13.0

OS

archlinux

Install tools

No response

Others

No response

Steps to reproduce it

In #3146 change, the Proof serialization changed from a list of proof objects to the list of stringified objects. This is a breaking change for the RPC clients. Is this new behavior expected and should clients like rust celestia-rpc align to it?

My 2 cents is that previous API is cleaner, the string serialization seems rather unnecessary

Expected result

.

Actual result

.

Relevant log output

No response

Notes

No response

@zvolin zvolin added the bug Something isn't working label Feb 9, 2024
@github-actions github-actions bot added the external Issues created by non node team members label Feb 9, 2024
@zvolin
Copy link
Contributor Author

zvolin commented Feb 9, 2024

@zvolin
Copy link
Contributor Author

zvolin commented Feb 9, 2024

I've just noticed that this also is inconsistent with other rpc methods, like GetSharesByNamespace which will still return the old proof representation (json object)

@ramin
Copy link
Contributor

ramin commented Feb 11, 2024

@zvolin yes i don't think this was intentional, let me chase and discuss with team and i think we'll have to change

@renaynay renaynay added area:api Related to celestia-node API area:blob labels Feb 23, 2024
@ramin
Copy link
Contributor

ramin commented Feb 23, 2024

@renaynay here is the culprit 625cdf3#diff-e0265c8a8ef591c5dac3ccd849803c7c79932ed3b87bff256fdf9f291611ace4R38

i believe we just need to remove this custom Marshall/Unmarshal and we'll be back to original behavior

@renaynay renaynay changed the title Proofs are serialized as strings - undocumented API break in 0.13.0 bug: Proofs are serialized as strings - undocumented API break in 0.13.0 Feb 23, 2024
@renaynay
Copy link
Member

@zvolin does #3204 revert proof marshalling to how it was done previously?

@zvolin
Copy link
Contributor Author

zvolin commented Mar 1, 2024

yup, all our tests passes on that

@renaynay
Copy link
Member

renaynay commented Mar 1, 2024

Perfect

renaynay added a commit that referenced this issue Mar 5, 2024
…#3204)

Reverts a change introduced in
#3146 that
unintentionally broke `blob.Proof` serialisation.

Resolves #3173
renaynay added a commit to renaynay/celestia-node that referenced this issue Apr 3, 2024
…celestiaorg#3204)

Reverts a change introduced in
celestiaorg#3146 that
unintentionally broke `blob.Proof` serialisation.

Resolves celestiaorg#3173
renaynay added a commit to renaynay/celestia-node that referenced this issue Apr 3, 2024
…celestiaorg#3204)

Reverts a change introduced in
celestiaorg#3146 that
unintentionally broke `blob.Proof` serialisation.

Resolves celestiaorg#3173
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:api Related to celestia-node API area:blob bug Something isn't working external Issues created by non node team members
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants