Fix authorization docs for contract keys #3835
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This should hopefully match what we have actually implemented.
hurryabit
reviewed
Dec 12, 2019
| @@ -50,12 +50,11 @@ Use ``fetchByKey`` to fetch the ID and data of the contract with the specified k | |||
|
|
|||
| It returns a tuple of the ID and the contract object (containing all its data). | |||
|
|
|||
| You need authorization from **at least one** of the maintainers to run ``fetchByKey``. A maintainer can authorize by being a signatory, or by submitting the command/being a controller for the choice. | |||
| ``fetchByKey`` is authorized like ``fetch`` so you need to be a stakeholder to run ``fetchByKey``. | |||
There was a problem hiding this comment.
I'm not sure this conveys the correct meaning. In particular, it's not clear who is "you". The authorization context might contain multiple parties. In my understanding, the that context needs to contain at least one stakeholder for a fetchByKey to be well-authorized. There are no conditions on the submitter though.
@bame-da can you confirm?
|
That's my understanding as well
…On Thu, 12 Dec 2019, 18:47 Martin Huschenbett, ***@***.***> wrote:
***@***.**** commented on this pull request.
------------------------------
In docs/source/daml/reference/contract-keys.rst
<#3835 (comment)>:
> @@ -50,12 +50,11 @@ Use ``fetchByKey`` to fetch the ID and data of the contract with the specified k
It returns a tuple of the ID and the contract object (containing all its data).
-You need authorization from **at least one** of the maintainers to run ``fetchByKey``. A maintainer can authorize by being a signatory, or by submitting the command/being a controller for the choice.
+``fetchByKey`` is authorized like ``fetch`` so you need to be a stakeholder to run ``fetchByKey``.
I'm not sure this conveys the correct meaning. In particular, it's not
clear who is "you". The authorization context might contain multiple
parties. In my understanding, the that context needs to contain at least
one stakeholder for a fetchByKey to be well-authorized. There are no
conditions on the submitter though.
@bame-da <https://github.com/bame-da> can you confirm?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#3835?email_source=notifications&email_token=AJW7WQQZB3VBJP6KCEDUHG3QYJ2KJA5CNFSM4J2A27AKYY3PNVWWK3TUL52HS4DFWFIHK3DMKJSXC5LFON2FEZLWNFSXPKTDN5WW2ZLOORPWSZGOCPAOS4Q#pullrequestreview-331409778>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AJW7WQXTMP3LCFER4QRMYH3QYJ2KJANCNFSM4J2A27AA>
.
--
This message, and any attachments, is for the intended recipient(s) only,
may contain information that is privileged, confidential and/or proprietary
and subject to important terms and conditions available at
http://www.digitalasset.com/emaildisclaimer.html
<http://www.digitalasset.com/emaildisclaimer.html>. If you are not the
intended recipient, please delete this message.
|
|
I’ve changed the wording, let me know if that makes it more clear or if you have better suggestions. |
hurryabit
approved these changes
Dec 12, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This should hopefully match what we have actually implemented.
Pull Request Checklist
CHANGELOG_BEGINandCHANGELOG_ENDtags, if appropriateNOTE: CI is not automatically run on non-members pull-requests for security
reasons. The reviewer will have to comment with
/AzurePipelines runtotrigger the build.