BoxesResponse: Fold names into top-level object

[michaeldiamant]

Due to algorand/generator#36, it's not possible to generate working Java and Go SDK changes prior to the PR (see algorand/go-algorand-sdk#340 as an example).

Consequently, the PR proposes re-defining the response for /v2/applications/{application-id}/boxes to be compatible with as-is generator capabilities.

Notes:

• Since a Box definition exists (returning name + value), the PR proposes a new definition: BoxDescriptor. I'm open to different names. The intent is to use a name that may be extended with new fields in the future.
• Alternatives considered:
  • Keep PR as is and return array of box names rather than array of BoxDescriptor. The approach is a better fit for today's model. However, if we later modify the response type, it'll introduce a backwards incompatible change.
  • Close PR and instead modify generator templates to produce expected changes. The approach feels more error prone than the PR's approach.

[codecov]

Codecov Report

Merging #4249 (3421bd3) into feature/avm-box (f394799) will decrease coverage by 0.00%.
The diff coverage is 0.00%.

@@                 Coverage Diff                 @@
##           feature/avm-box    #4249      +/-   ##
===================================================
- Coverage            54.58%   54.57%   -0.01%     
===================================================
  Files                  393      393              
  Lines                49283    49284       +1     
===================================================
- Hits                 26899    26898       -1     
- Misses               20115    20117       +2     
  Partials              2269     2269              

Impacted Files	Coverage Δ
daemon/algod/api/server/v2/handlers.go	0.00% <0.00%> (ø)
ledger/blockqueue.go	82.18% <0.00%> (-2.88%)	⬇️
data/abi/abi_type.go	87.67% <0.00%> (-0.95%)	⬇️
network/wsPeer.go	67.67% <0.00%> (-0.55%)	⬇️
network/wsNetwork.go	65.17% <0.00%> (+0.28%)	⬆️
ledger/acctupdates.go	65.60% <0.00%> (+0.56%)	⬆️

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f394799...3421bd3. Read the comment docs.

[ahangsu]

seems a reasonable change, I am not tagged to review so I just comment here.

It just surprise me that the generated model cannot handle response type of array of strings, and I wrote most of the code here, so I kinda feel guilty about it.

[michaeldiamant]

I wrote most of the code here, so I kinda feel guilty about it.

@ahangsu No worries and no need to feel guilty! It's an unexpected outcome and the SDKs are outside the scope of #4154.

[algochoi]

Looks good to me, as discussed off line

[algochoi]

[ahangsu]

free approval

[algoidurovic]

LGTM