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(connector-quorum): make Web3BlockHeader.receiptRoot optional #2555

Open
petermetz opened this issue Jul 16, 2023 · 0 comments
Open
Assignees
Labels
Breaking_V1 Changes that can only be made with the release of v2 due to them being breaking changes. bug Something isn't working Developer_Experience P1 Priority 1: Highest Quorum

Comments

@petermetz
Copy link
Contributor

THIS IS A BREAKING CHANGE

Our own OpenAPI spec types and the Web3 library's own types have diverged because
they made a breaking change between v1.5.2 and v1.6.1 (haven't checked where exactly).

We need to sync up with their typings but we cannot do that unless we make a breaking
API change on our side as well so this should be done as part of the v2.0.0
release.

Relevant spec file:

packages/cactus-plugin-ledger-connector-besu/src/main/json/openapi.json

Relevant source code file:
packages/cactus-plugin-ledger-connector-besu/src/main/typescript/web-services/watch-blocks-v1-endpoint.ts

// Cast needed because somewhere between Web3 v1.5.2 and v1.6.1 they
// made the receiptRoot property of the BlockHeader type optional.
// This could be accopmanied by a breaking change in their code or
// it could've been just a mistake in their typings that they corrected.
// Either way, with the next major release, we need to make it optional
// in our API specs as well so that they match up.

@petermetz petermetz added Breaking_V1 Changes that can only be made with the release of v2 due to them being breaking changes. bug Something isn't working Developer_Experience Quorum labels Jul 16, 2023
@petermetz petermetz self-assigned this Jul 16, 2023
@petermetz petermetz added the P1 Priority 1: Highest label Jul 16, 2023
petermetz added a commit to micoferdinand98/cactus that referenced this issue Jul 16, 2023
Update from Peter: I needed to do an unsafe cast because that was the least
bad option (other option was to make a breaking change in the quourm
connector's API).

The issue opened for tracking a proper resolution to this is titled as:
refactor(connector-quorum): make Web3BlockHeader.receiptRoot optional hyperledger-cacti#2555
and the link to it on GitHub is https://github.com/hyperledger/cacti/issues/2555

Fixes hyperledger-cacti#2332

Co-authored-by: Peter Somogyvari <peter.somogyvari@accenture.com>
Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
petermetz added a commit that referenced this issue Jul 17, 2023
Update from Peter: I needed to do an unsafe cast because that was the least
bad option (other option was to make a breaking change in the quourm
connector's API).

The issue opened for tracking a proper resolution to this is titled as:
refactor(connector-quorum): make Web3BlockHeader.receiptRoot optional #2555
and the link to it on GitHub is https://github.com/hyperledger/cacti/issues/2555

Fixes #2332

Co-authored-by: Peter Somogyvari <peter.somogyvari@accenture.com>
Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
sandeepnRES pushed a commit to sandeepnRES/cacti that referenced this issue Dec 21, 2023
Update from Peter: I needed to do an unsafe cast because that was the least
bad option (other option was to make a breaking change in the quourm
connector's API).

The issue opened for tracking a proper resolution to this is titled as:
refactor(connector-quorum): make Web3BlockHeader.receiptRoot optional hyperledger-cacti#2555
and the link to it on GitHub is https://github.com/hyperledger/cacti/issues/2555

Fixes hyperledger-cacti#2332

Co-authored-by: Peter Somogyvari <peter.somogyvari@accenture.com>
Signed-off-by: Peter Somogyvari <peter.somogyvari@accenture.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking_V1 Changes that can only be made with the release of v2 due to them being breaking changes. bug Something isn't working Developer_Experience P1 Priority 1: Highest Quorum
Projects
None yet
Development

No branches or pull requests

1 participant