♻️ Disallow creation of new Transactions with a non-empty UpdatedAddresses

[greymistcube]

This partially deprecates uses of Transaction.UpdatedAddresses property. It is no longer allowed to create a Transaction with non-empty UpdatedAddresses property through normal means.

As it is still possible to create a Transaction with a non-empty UpdatedAddresses (in particular, when unmarshalling a marshalled Transaction) most Transactions used in tests are left intact (especially those using fixtures) to keep the old behavior intact.

[riemannulus]

Could we talk about this deprecated schedule and update way? Can you make a discussion document about this?

I'm sure just disallowing the UpdatedAddresses field is not a big deal on the code side. But we have things to decide. Such as should we block the UpdatedAddresses field on the network level? as you mentioned.

[greymistcube]

@riemannulus
Figured it'd be better to deprecate/remove its use from the client side first.
If all goes well, this will not be used after v200110 is released (see here).

As mentioned above, this does not block Transactions with a non-empty UpdatedAddresses for now. As you have pointed out, that is a separate decision to be made after a discussion. This can be done at a later date and worked on separately. 😗

[pull-request-quantifier-deprecated]

This PR has 460 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!

---

Quantification details

Label      : Extra Large
Size       : +243 -217
Percentile : 82%

Total files changed: 26

Change summary by file extension:
.md : +5 -0
.cs : +238 -217

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

• Fast and predictable releases to production:
  • Optimal size changes are more likely to be reviewed faster with fewer
    iterations.
  • Similarity in low PR complexity drives similar review times.
• Review quality is likely higher as complexity is lower:
  • Bugs are more likely to be detected.
  • Code inconsistencies are more likely to be detected.
• Knowledge sharing is improved within the participants:
  • Small portions can be assimilated better.
• Better engineering practices are exercised:
  • Solving big problems by dividing them in well contained, smaller problems.
  • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

• Use the PullRequestQuantifier to quantify your PR accurately
  • Create a context profile for your repo using the context generator
  • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
  • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
  • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
• Change your engineering behaviors
  • For PRs that fall outside of the desired spectrum, review the details and check if:
    • Your PR could be split in smaller, self-contained PRs instead
    • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

• One line was added: +1 -0
• One line was deleted: +0 -1
• One line was modified: +1 -1 (git diff doesn't know about modified, it will
  interpret that line like one addition plus one deletion)
• Change percentiles: Change characteristics (addition, deletion, modification)
  of this PR in relation to all other PRs within the repository.

---

Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.

[codecov]

Codecov Report

Merging #3480 (7fd7327) into 3.8-maintenance (06d7357) will increase coverage by 0.02%.
The diff coverage is 90.90%.

Additional details and impacted files

@@                 Coverage Diff                 @@
##           3.8-maintenance    #3480      +/-   ##
===================================================
+ Coverage            79.14%   79.17%   +0.02%     
===================================================
  Files                  342      342              
  Lines                11822    11830       +8     
===================================================
+ Hits                  9357     9366       +9     
+ Misses                2465     2464       -1     

Files	Coverage Δ
Libplanet.Types/Tx/Transaction.cs	89.09% <ø> (ø)
Libplanet/Blockchain/BlockChain.cs	92.04% <ø> (ø)
Libplanet.Types/Tx/TxInvoice.cs	88.57% <90.90%> (+3.38%)	⬆️

... and 5 files with indirect coverage changes