Public Merkle API

[poulok]

The main goal of this epic is turn state-related code into a library that can later be used by the Block Node. Besides that we need to change our Merkle Tree structure and standardize the Platform state nodes into one of three types:

• singleton
• queue
• key-value storage

Merkle Tree Cleanup

Beta Give feedback

1. Delete com.hedera.node.app.state.merkle.adapters #11770
   +0
   
2. Remove Platform state classes that are no longer in use #11767
   +0
   
3. Move HAPI module to platform-sdk #12277
   +0
   
4. Migrate com.hedera.node.app.state package to swirlds-platform-core module #11765
   Improvement Platform Data Structures +2
   
5. Refactor AddressBook #11772
   +0
   
6. Refactor Service and move it to platform-sdk #13084
   Platform +1
   
7. Create a design document for the Public Merkle API project #13690
   Design Platform +2
   
8. Refactor MerkleHederaState to make it interchangable with State #13691
   Platform +1
   
9. Create the PlatformState protobuf #13124
   Platform +1
   
10. Refactor PlatformState into a singleton #11771
    Platform +1
11. Move the location of PlatformState to a different place in the Merkle Tree #11773
    Improvement Platform Platform Data Structures +3
12. Merkle tree serialization to protobuf #13692
    Platform Platform Data Structures +2
    
13. Move Merkle state related to swirlds-state-api module #13270
    Platform +1
14. Refactor HederaState to MerkleState #13274
    Platform +1
15. Design proposal for merkle tree serialization to protobuf #13764
    Platform +1
    
16. Create a class that represents KV node in the Merkle tree #13781
    Platform +1
17. Make MerkleRoot and SwirldState usage more consistent #13802
    Platform Platform Data Structures +2
    
18. Create a design proposal for making the merkle tree binary #13891
    Platform +1
    

States API

Beta Give feedback

1. Add a draft title or issue reference here
2. Introduce PBJ schema for singletons, queues and KV storage #11774
   Platform +1
   
3. Create/gather documentation for the new States API and update to include any platform considerations #13125
   +0
4. Add support for map to PBJ #13240
   +0
5. Extract RosterMap from PlatformState #13241
   +0
6. Delete unused fields from PlatformState #13242
   +0
7. Add in-memory mode to VirtualMap for smaller number of entries #13246
   +0
8. Determine how to handle hashing for the FCQueue considering the state proof use case
9. Create QueueNode backed by VirtualMap instead of FCQueue
10. Design Proposal for new Merkle Proof API #13765
    Platform +1

[imalygin]

@cody-littley proposed to do a refactoring of PlatformState - https://www.notion.so/swirldslabs/Proposed-Platform-State-Structure-d37ae2c018f94b81ac884745ca4ee022

I'm going to update this epic accordingly