Skip to content

[#57] Update upgradeability doc

Roman Melnikov requested to merge rvem/#57-update-upgradeability-doc into master

Description

Problem: upgradeableConctracts.md was added quite a while ago and hasn't been updated much since the creation. Now were refer to "Administrator-forced upgrades" section in the upgradeable contract autodoc, so it's time to update thi doc.

Solution: What was updated:

  • Parameter and storage definitions in the doc to reflect the current state of the upgradeable contract.
  • Entrypoint-wise section moved from appendix to the main part of doc. It was done because now we actually use entrypoint-wise approach nearly everywhere.
  • Update type safe storage migration section with an actual example of upgradeable counter upgrade from V1 to V2.

Related issue(s)

Resolves #57 (closed)

Checklist for your Merge Request

Related changes (conditional)

  • Tests (see short guidelines)

    • If I added new functionality, I added tests covering it.
    • If I fixed a bug, I added a regression test to prevent the bug from silently reappearing again.
  • Documentation

    • I checked whether I should update the docs and did so if necessary:
    • I updated the changelog if my changes are externally visible.

Stylistic guide (mandatory)

Edited by Ivan Gromakovskii

Merge request reports