docs: Add a doc with the decompile/disassembly of the token redirect/proxy …

[david-bakin-sl]

…contract

Description:

Add a doc with the decompile (into Solidity) and disassembly of the hexstring which is the token redirect/proxy contract.

Related issue(s):

Fixes #17064

Notes for reviewer:

Checklist

• Documented (Code comments, README, etc.)
• [N/A] Tested (unit, integration, etc.)

[Nana-EC]

This is good.
I think we can add a little overview section to give context to the token facade and it's usage in follow up from HIP 218.

[github-actions]

Node: E2E Test Results

    1 files      1 suites   20m 6s ⏱️
310 tests 310 ✔️ 0 💤 0 ❌
328 runs  328 ✔️ 0 💤 0 ❌

Results for commit c60fa31.

[github-actions]

Node: Unit Test Results

    2 200 files      2 200 suites   1h 25m 14s ⏱️
117 934 tests 117 898 ✔️ 36 💤 0 ❌
126 253 runs  126 217 ✔️ 36 💤 0 ❌

Results for commit c60fa31.

[github-actions]

Node: Integration Test Results

278 tests   277 ✔️  32m 17s ⏱️
    5 suites      0 💤
    5 files        1 ❌

Results for commit c60fa31.

[Nana-EC]

This is good.

I think just adding one section before the 3-address with an example of the E2E flow would complete the doc.
Basically having presented and explained the redirect what's an example.
It might look like when a developer creates an HTS token with address 0x0000..1 any an ERC20/ERC721 such as .name() could be called, which would then call the name system contract function name (tokenAddress).
Just an basic illustration would drive this home for a reader.

[david-bakin-sl]

I think just adding one section before the 3-address with an example of the E2E flow would complete the doc. Basically having presented and explained the redirect what's an example. It might look like when a developer creates an HTS token with address 0x0000..1 any an ERC20/ERC721 such as .name() could be called, which would then call the name system contract function name (tokenAddress). Just an basic illustration would drive this home for a reader.

Will add this.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.95%. Comparing base (650d911) to head (2907c2e).
Report is 19 commits behind head on main.

Additional details and impacted files

@@             Coverage Diff              @@
##               main    #5673      +/-   ##
============================================
+ Coverage     67.58%   67.95%   +0.36%     
- Complexity    22135    22344     +209     
============================================
  Files          2588     2606      +18     
  Lines         96667    96901     +234     
  Branches      10099    10098       -1     
============================================
+ Hits          65335    65848     +513     
+ Misses        27589    27293     -296     
- Partials       3743     3760      +17     

Files with missing lines	Coverage Δ
.../contract/impl/state/DispatchingEvmFrameState.java	89.47% <ø> (ø)

... and 115 files with indirect coverage changes

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.98% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (650d911)	96450	68926	71.46%
Head commit (2907c2e)	95262 (-1188)	69013 (+87)	72.45% (+0.98%)

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 (#5673)	0	0	∅ (not applicable)

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}

[Nana-EC]

@david-bakin-sl can we get this updated and rebased for a new round of reviews?

[Nana-EC]

Looking good, final minor change suggestions

[Nana-EC]

LG

[acuarica]

lg