Document ResultNeedUpgradeVerification differences between submission and reinterpretation (#17277)

This commit is contained in:
Simon Maxen 2023-08-30 14:04:18 +01:00 committed by GitHub
parent e27c240521
commit 8b92c9294b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -195,6 +195,10 @@ final case class ResultNeedAuthority[A](
* The ledger will callback `resume` with `None` if everything is fine, or callback with
* `Some(helpfulErrorInfo)` otherwise.
*
* During submission this callback should only be called where the target template id is different
* from the contract template id. During reinterpretation this callback is also used for model conformance
* so should be called once for all used contracts even if they are not being upgraded.
*
* TODO: https://github.com/digital-asset/daml/issues/17082
* - The engine must be extended to call `ResultNeedUpgradeVerification`
*/