dusk-network / dusk-hamt Goto Github PK

Do a doc run and writeup on the HAMT structure.

The map is intended to be used in contract environments.

For this reason, the library should be no-std

The last version, 0.3.2, had to be yanked since it included a breaking change but the semver wasn't respecting that.

So need to re-publish the same code, but as 0.4.0.

Describe what you want implemented
The cargo manifest should not pull in the default features of microkelvin

Describe "Why" this is needed
When compiling for webassembly, we need to not pull in std-only dependencies.

Describe alternatives you've considered
N/A

The annotation is an internal requirement of Microkelvin and should not reflect the API as a requirement. In dusk example, we have both dusk-kelvin-map and dusk-poseidon tree that provides default implementations without generic annotation.

The maps should also provide a simplified K -> V data structure instead of relying in annotation implementations as a requirement.

Proposed solution

• rename Hamt to KelvinHamt
• create a type alias Hamt<K, V> = KelvinHamt<K, V, ()>

Describe what you want implemented
After the introduction of RKYV in Microkelvin, the most important data-structures need to be migrated as well.

Describe "Why" this is needed
The old version of Microkelvin is incompatible with the new one and therefore dusk-hamt should be ported to the new version.

Describe alternatives you've considered
N/A

Additional context
This entails a simple dependency update of the library. This should be low risk

Some basic documentation should be added explaining the tradeoffs, internals and add some examples to the usage