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

docs: 13690 Added a design doc for Ledger State API #13730

Merged
merged 24 commits into from
Jul 1, 2024
Merged

Conversation

imalygin
Copy link
Member

@imalygin imalygin commented Jun 6, 2024

Description:

This design doc is a compilation of the following Notion pages:

State Refactor for State Proofs

Public Specified Merkle Tree & State

Public Merkle Tree API

Merkle tree to protobuf

Proposed Platform State Structure

Fixes #13690

Notes for reviewer:

Checklist

  • Documented (Code comments, README, etc.)
  • Tested (unit, integration, etc.)

@imalygin imalygin added Design Issue/PR for feature design documents. Platform Tickets pertaining to the platform labels Jun 6, 2024
@imalygin imalygin self-assigned this Jun 6, 2024
@imalygin imalygin requested review from a team as code owners June 6, 2024 22:39
Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Crypto) Results

 24 files   24 suites   13m 27s ⏱️
362 tests 362 ✅ 0 💤 0 ❌
369 runs  369 ✅ 0 💤 0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Node Death Reconnect) Results

3 tests   3 ✅  6m 17s ⏱️
3 suites  0 💤
3 files    0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Misc) Results

 51 files   51 suites   21m 40s ⏱️
357 tests 357 ✅ 0 💤 0 ❌
375 runs  375 ✅ 0 💤 0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Smart Contract) Results

 73 files   73 suites   23m 52s ⏱️
623 tests 623 ✅ 0 💤 0 ❌
677 runs  677 ✅ 0 💤 0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Time Consuming) Results

19 tests   19 ✅  23m 28s ⏱️
 4 suites   0 💤
 4 files     0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Restart) Results

3 tests   3 ✅  7m 10s ⏱️
3 suites  0 💤
3 files    0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: Unit Test Results

  1 540 files    1 540 suites   2h 42m 17s ⏱️
110 064 tests 110 005 ✅ 59 💤 0 ❌
118 374 runs  118 315 ✅ 59 💤 0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

github-actions bot commented Jun 6, 2024

Node: HAPI Test (Token) Results

 20 files   20 suites   5m 59s ⏱️
266 tests 266 ✅ 0 💤 0 ❌
341 runs  341 ✅ 0 💤 0 ❌

Results for commit 34efbae.

♻️ This comment has been updated with latest results.

Copy link

codecov bot commented Jun 6, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 58.27%. Comparing base (9973fae) to head (06d6061).
Report is 83 commits behind head on develop.

Current head 06d6061 differs from pull request most recent head 34efbae

Please upload reports for the commit 34efbae to get more accurate results.

Additional details and impacted files
@@              Coverage Diff              @@
##             develop   #13730      +/-   ##
=============================================
- Coverage      67.58%   58.27%   -9.31%     
+ Complexity     36486    22080   -14406     
=============================================
  Files           3732     2883     -849     
  Lines         149767   109662   -40105     
  Branches       15571    11159    -4412     
=============================================
- Hits          101223    63910   -37313     
+ Misses         44179    42219    -1960     
+ Partials        4365     3533     -832     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@imalygin imalygin added this to the v0.52 milestone Jun 6, 2024
@imalygin imalygin changed the title doc: 13690 Added a design doc for Refactor for State Proofs docs: 13690 Added a design doc for Refactor for State Proofs Jun 6, 2024
@poulok poulok marked this pull request as draft June 7, 2024 14:17
@imalygin imalygin marked this pull request as ready for review June 11, 2024 15:27
litt3
litt3 previously approved these changes Jun 11, 2024
Copy link
Contributor

@litt3 litt3 left a comment

Choose a reason for hiding this comment

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

+1

Copy link
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

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

+1

@imalygin imalygin dismissed stale reviews from anthony-swirldslabs and litt3 via f96e394 June 11, 2024 19:26
Copy link
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

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

+1

@litt3 litt3 changed the title docs: 13690 Added a design doc for Public Merkle State API docs: 13690 Added a design doc for Ledger State API Jun 21, 2024
kfa-aguda
kfa-aguda previously approved these changes Jun 21, 2024
Copy link
Contributor

@kfa-aguda kfa-aguda left a comment

Choose a reason for hiding this comment

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

+1

rbair23
rbair23 previously approved these changes Jun 21, 2024
Copy link
Member

@rbair23 rbair23 left a comment

Choose a reason for hiding this comment

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

+1

Copy link
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

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

+1

Signed-off-by: Austin Littley <austin@swirldslabs.com>
Copy link
Contributor

@anthony-swirldslabs anthony-swirldslabs left a comment

Choose a reason for hiding this comment

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

+1

@litt3 litt3 requested review from rbair23 and kfa-aguda June 26, 2024 14:22
Copy link
Contributor

@edward-swirldslabs edward-swirldslabs left a comment

Choose a reason for hiding this comment

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

+0.99 - Do these changes need to be reflected in HIP anywhere?

@hendrikebbers
Copy link
Member

+0.9 the proposal is great but I do not have enough knowledge of the technical topic to do +1

Copy link
Contributor

@edward-swirldslabs edward-swirldslabs left a comment

Choose a reason for hiding this comment

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

+1 the hip I asked about would come through block-streams at the very latest.

@litt3 litt3 merged commit 4ddd52b into develop Jul 1, 2024
40 of 41 checks passed
@litt3 litt3 deleted the 13690-design-doc branch July 1, 2024 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Design Issue/PR for feature design documents. Platform Tickets pertaining to the platform
Projects
Status: Accepted
Development

Successfully merging this pull request may close these issues.

Create a design document for the Public Merkle API project
10 participants