feat!: removes the Tree method from the NMT wrapper and introduces the ProveRange API

[staheri14]

Overview

While reviewing the NMT wrapper implementation and attempting to write its specs, came across a contradiction in the wrapper's design. On one hand, the wrapper is intended to encapsulate an instance of NMT and re-define/modify some of its APIs, specifically the Push method. On the other hand, the wrapper also exposes the Tree() method, which returns a pointer to the underlying NMT tree and thus allows direct access to the tree and enables arbitrary manipulation of the underlying tree outside of the intended control of the wrapper. For instance, one can bypass the NMT wrapper Push method and directly call the Push method of the underlying tree using .Tree().Push(). This not only widens the error surface but also violates the initial objective of the wrapper.

To address this issue, the Tree() API has been removed, and all necessary methods of the underlying NMT are now exposed through the wrapper directly.

Checklist

• New and updated code has appropriate documentation
• New and updated code has new and/or updated testing
• Required CI checks are passing
• Visual proof for any user facing features like CLI or documentation updates
• Linked issues closed with keywords

[codecov-commenter]

Codecov Report

Merging #1438 (523fac5) into main (651b1cf) will decrease coverage by 0.05%.
The diff coverage is 33.33%.

@@            Coverage Diff             @@
##             main    #1438      +/-   ##
==========================================
- Coverage   49.22%   49.18%   -0.05%     
==========================================
  Files          79       79              
  Lines        4477     4477              
==========================================
- Hits         2204     2202       -2     
- Misses       2089     2091       +2     
  Partials      184      184              

Impacted Files	Coverage Δ
pkg/wrapper/nmt_wrapper.go	77.50% <0.00%> (-5.00%)	⬇️
pkg/proof/proof.go	67.46% <100.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[rootulp]

LGTM!

[evan-forbes]

hmmm I couldn't find anywhere where this is used, and I don't remember why this was added in the first place, so it makes sense to remove it to me!

good find!

[staheri14]

hmmm I couldn't find anywhere where this is used, and I don't remember why this was added in the first place, so it makes sense to remove it to me!

Indeed! there was no significant use case for it. It was only utilized here to invoke the ProveRange method of the underlying NMT. However, it could have been defined directly as a method for the NMT wrapper, which has been implemented as part of this pull request.