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

feat: Protobufs for Tss Startup #16822

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

Conversation

Neeharika-Sompalli
Copy link
Member

@Neeharika-Sompalli Neeharika-Sompalli commented Nov 27, 2024

Fixes #16823
Related to #14751

Protobufs for TssEncryptionKeys and TssStatus

Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Copy link

codacy-production bot commented Nov 27, 2024

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation Diff coverage
+0.10% (target: -1.00%) 67.21%
Coverage variation details
Coverable lines Covered lines Coverage
Common ancestor commit (d43a749) 97522 63620 65.24%
Head commit (2c0b294) 97582 (+60) 63756 (+136) 65.34% (+0.10%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details
Coverable lines Covered lines Diff coverage
Pull request (#16822) 61 41 67.21%

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more

Copy link

codecov bot commented Nov 27, 2024

Codecov Report

Attention: Patch coverage is 63.93443% with 22 lines in your changes missing coverage. Please review.

Project coverage is 63.63%. Comparing base (d43a749) to head (2c0b294).
Report is 1 commits behind head on develop.

Files with missing lines Patch % Lines
...ra/node/app/blocks/impl/KVStateChangeListener.java 0.00% 15 Missing ⚠️
...e/app/blocks/impl/BoundaryStateChangeListener.java 0.00% 2 Missing ⚠️
...dera/node/app/workflows/handle/HandleWorkflow.java 0.00% 1 Missing and 1 partial ⚠️
.../src/main/java/com/hedera/hapi/util/HapiUtils.java 0.00% 1 Missing ⚠️
...va/com/hedera/node/app/tss/TssBaseServiceImpl.java 50.00% 1 Missing ⚠️
...edera/node/app/tss/schemas/V0570TssBaseSchema.java 93.33% 0 Missing and 1 partial ⚠️
Additional details and impacted files

Impacted file tree graph

@@              Coverage Diff              @@
##             develop   #16822      +/-   ##
=============================================
+ Coverage      63.53%   63.63%   +0.10%     
- Complexity     20371    20422      +51     
=============================================
  Files           2537     2538       +1     
  Lines          94757    94817      +60     
  Branches        9904     9905       +1     
=============================================
+ Hits           60203    60338     +135     
+ Misses         30948    30871      -77     
- Partials        3606     3608       +2     
Files with missing lines Coverage Δ
...om/hedera/node/app/blocks/impl/BlockImplUtils.java 79.82% <100.00%> (+0.36%) ⬆️
...n/java/com/hedera/node/app/tss/TssBaseService.java 40.00% <ø> (ø)
...m/hedera/node/app/tss/stores/ReadableTssStore.java 100.00% <ø> (ø)
...dera/node/app/tss/stores/ReadableTssStoreImpl.java 100.00% <100.00%> (+5.71%) ⬆️
...m/hedera/node/app/tss/stores/WritableTssStore.java 100.00% <100.00%> (+42.85%) ⬆️
...app/workflows/handle/steps/StakePeriodChanges.java 94.36% <100.00%> (+0.08%) ⬆️
...m/hedera/node/config/data/ApiPermissionConfig.java 100.00% <100.00%> (ø)
.../src/main/java/com/hedera/hapi/util/HapiUtils.java 60.89% <0.00%> (+0.78%) ⬆️
...va/com/hedera/node/app/tss/TssBaseServiceImpl.java 66.66% <50.00%> (-0.23%) ⬇️
...edera/node/app/tss/schemas/V0570TssBaseSchema.java 93.33% <93.33%> (ø)
... and 3 more

... and 16 files with indirect coverage changes

Impacted file tree graph

Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Copy link
Member

@jsync-swirlds jsync-swirlds left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple thoughts regarding the proto definitions and storing transaction body messages in state.

Also, several general style guidelines items.

Comment on lines 883 to 896
/**
* A TSS Encryption Key Transaction Body value.
*/
com.hedera.hapi.services.auxiliary.tss.TssEncryptionKeyTransactionBody tss_encryption_key_value = 20;

/**
* A TSS Encryption Key Transaction Body value.
*/
com.hedera.hapi.services.auxiliary.tss.TssMessageTransactionBody tss_message_value = 21;

/**
* A TSS Encryption Key Transaction Body value.
*/
com.hedera.hapi.services.auxiliary.tss.TssVoteTransactionBody tss_vote_value = 22;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We really should not be storing transaction bodies in state; it sets a bad pattern.
Ideally we would use an internal message for these, or base type (if there is only one field, as is the case for the encryption key).

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are the internal transaction bodies, submitted by Tss Service, not the user submitted transaction bodies. You could refer to the TssLedgerID proposal.

Copy link
Member

@jsync-swirlds jsync-swirlds Nov 27, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've read the proposal, repeatedly.
This usage is still a divergence from how everything else is stored in state (we don't store full transaction bodies for anything else) and is concerning in the block stream (where we work so hard to avoid any transaction data in other parts of the stream).

It just seems we're taking a shortcut here to avoid defining the state messages. If the team believes this is the best way to implement, then that's what it will be, I am just suggesting we reconsider if this really is good design.

com.hedera.hapi.services.auxiliary.tss.TssEncryptionKeyTransactionBody tss_encryption_key_value = 20;

/**
* A TSS Encryption Key Transaction Body value.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be good to include additional detail and requirements if we truly do need to store full transaction body messages in state, as it's a major divergence from everything else, and is highly likely to be confusing to anyone reading this next year.

hapi/hedera-protobufs/services/state/tss/tss_status.proto Outdated Show resolved Hide resolved
hapi/hedera-protobufs/services/state/tss/tss_status.proto Outdated Show resolved Hide resolved
hapi/hedera-protobufs/services/state/tss/tss_status.proto Outdated Show resolved Hide resolved
hapi/hedera-protobufs/services/state/tss/tss_status.proto Outdated Show resolved Hide resolved
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Signed-off-by: Neeharika-Sompalli <neeharika.sompalli@swirldslabs.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Neeharika Sompalli <52669918+Neeharika-Sompalli@users.noreply.github.com>
Co-authored-by: Joseph S. <121976561+jsync-swirlds@users.noreply.github.com>
Signed-off-by: Neeharika Sompalli <52669918+Neeharika-Sompalli@users.noreply.github.com>
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.

Add Tss startup protobufs
3 participants