docs: evolve spec #3
Conversation
asiaziola
requested review from
ppedziwiatr,
andreespirela,
jakub-wojciechowski and
littledivy
README.md
Outdated
| 5. `evolve` interaction MUST be called with the evolved contract source id indicated as the input `value`, an example of correct interaction: | ||
|
|
||
| ```js | ||
| await contract.writeInteraction({ function: 'evolve', value: 'OFh9ImnAauPjW49IHzaVq7hI-S0yswV0Nh7bTUQxdtc }); |
There was a problem hiding this comment.
I would remove the await contract.writeInteraction( - as this is our SDK - specific. JSON itself should be enough.
Also - maybe it would be worth noting, that value is the tx.id from the point 4.
README.md
Outdated
| await contract.writeInteraction({ function: 'evolve', value: 'OFh9ImnAauPjW49IHzaVq7hI-S0yswV0Nh7bTUQxdtc }); | ||
| ``` | ||
|
|
||
| Evolved contract source is then referred instead of the original contract source when performing any interactions. The state is evaluated based on all contract sources linked to the contract. There is no limitation for number of evolved contract sources associated to one contract. |
There was a problem hiding this comment.
I believe we need to be more specific here, e.g. when performing any interactions after the "evolve" interaction
README.md
Outdated
|
|
||
| 1. `canEvolve` property set to `true` MUST be added to the initial state. | ||
| 2. `evolve` interaction MUST be added to the original contract source, it MUST set the `evolve` property in the state to `action.input.value` - new contract source transaction id. | ||
| 3. `evolve` interaction MUST be conditioned to the owner of the contract. |
There was a problem hiding this comment.
I think we should leave this up to the developer, which is why we would use canEvolve so that the developer can handle when it's allowed to evolve.
There was a problem hiding this comment.
hmm, so - if I understand correctly - you would like to add a function, that will switch on/off the canEvolve flag?
Who should be allowed to switch value of this flag? only contract owner?
There was a problem hiding this comment.
@ppedziwiatr So the state already has a property called canEvolve. If canEvolve is false and there's evolve present, then it doesn't evolve. The developer should programatically set canEvolve to true or false during the evaluation of the interaction so that the executor can know whether the evolve requested was allowed.
There was a problem hiding this comment.
Hmm, since canEvolve is a part of the contract's state, it should be IMHO only modified by interacting with the contract - i.e. by creating an interaction transaction with a contract - so that anyone, who's willing to evaluate the state, will get the exactly same result.
"The developer should programatically set canEvolve to true or false during the evaluation of the interaction" - how exactly this "programatically setting" would work in this case..? You would like to change the value of this flag without interacting with the contract?
Sorry for all the questions, I just want to fully understand your idea.
|
|
||
| Evolving contract is a way of updating contract source. In order to properly evolve the contract following steps need to be reproduced: | ||
|
|
||
| 1. `canEvolve` property set to `true` MUST be added to the initial state (defaults to `false`, cannot evolve without setting it explicitly). |
There was a problem hiding this comment.
i've changed this sentence, so one needs to set canEvolve to true explicitly.
No description provided.