mirror of
https://github.com/digital-asset/daml.git
synced 2024-11-10 00:35:25 +03:00
Rename more contract instance (#7557)
* Replace "contract instance" with "contract" in docs folder CHANGELOG_BEGIN CHANGELOG_END * remove contract instance in docs/source/concepts/glossary.rst * Remove contract instance explanation docs/source/concepts/glossary.rst * Update docs/source/concepts/glossary.rst * Replace contract-contract-instance label ref with contract * Remove redundant naming * remove more "contract instance" CHANGELOG_BEGIN CHANGELOG_END * fix comma in doc Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com> Co-authored-by: Bernhard Elsner <40762178+bame-da@users.noreply.github.com>
This commit is contained in:
parent
40c1cd5893
commit
3badccfb1f
@ -38,7 +38,7 @@ template body
|
||||
:ref:`signatories <daml-ref-signatories>`
|
||||
``signatory`` keyword
|
||||
|
||||
Required. The parties (see the :ref:`Party <daml-ref-built-in-types>` type) who must consent to the creation of an instance of this contract. You won't be able to create an instance of this contract until all of these parties have authorized it.
|
||||
Required. The parties (see the :ref:`Party <daml-ref-built-in-types>` type) who must consent to the creation of this contract. You won't be able to create this contract until all of these parties have authorized it.
|
||||
|
||||
:ref:`observers <daml-ref-observers>`
|
||||
``observer`` keyword
|
||||
@ -58,7 +58,7 @@ template body
|
||||
:ref:`a contract key <daml-ref-contract-keys>`
|
||||
``key`` keyword
|
||||
|
||||
Optional. Lets you specify a combination of a party and other data that uniquely identifies an instance of this contract template. See :doc:`/daml/reference/contract-keys`.
|
||||
Optional. Lets you specify a combination of a party and other data that uniquely identifies a contract of this template. See :doc:`/daml/reference/contract-keys`.
|
||||
|
||||
:ref:`maintainers <daml-ref-maintainers>`
|
||||
``maintainer`` keyword
|
||||
|
@ -64,7 +64,7 @@ Signatory parties
|
||||
:end-before: -- end template sigs snippet
|
||||
|
||||
- ``signatory`` keyword. After ``where``. Followed by at least one ``Party``.
|
||||
- Signatories are the parties (see the ``Party`` type) who must consent to the creation of an instance of this contract. They are the parties who would be put into an *obligable position* when this contract is created.
|
||||
- Signatories are the parties (see the ``Party`` type) who must consent to the creation of this contract. They are the parties who would be put into an *obligable position* when this contract is created.
|
||||
|
||||
DAML won't let you put someone into an obligable position without their consent. So if the contract will cause obligations for a party, they *must* be a signatory. **If they haven't authorized it, you won't be able to create the contract.** In this situation, you may see errors like:
|
||||
|
||||
@ -149,7 +149,7 @@ Contract keys and maintainers
|
||||
:end-before: -- end contract key snippet
|
||||
|
||||
- ``key`` and ``maintainer`` keywords.
|
||||
- This feature lets you specify a "key" that you can use to uniquely identify an instance of this contract template.
|
||||
- This feature lets you specify a "key" that you can use to uniquely identify this contract as an instance of this template.
|
||||
- If you specify a ``key``, you must also specify a ``maintainer``. This is a ``Party`` that will ensure the uniqueness of all the keys it is aware of.
|
||||
|
||||
Because of this, the ``key`` must include the ``maintainer`` ``Party`` or parties (for example, as part of a tuple or record), and the ``maintainer`` must be a signatory.
|
||||
|
@ -56,7 +56,7 @@ create
|
||||
create NameOfTemplate with exampleParameters
|
||||
|
||||
- ``create`` function.
|
||||
- Creates an instance of that contract on the ledger. When a contract is committed to the ledger, it is given a unique contract identifier of type ``ContractId <name of template>``.
|
||||
- Creates a contract on the ledger. When a contract is committed to the ledger, it is given a unique contract identifier of type ``ContractId <name of template>``.
|
||||
|
||||
Creating the contract returns that ``ContractId``.
|
||||
- Use ``with`` to specify the template parameters.
|
||||
|
@ -91,7 +91,7 @@ This example tests a contract that gives both parties an explicit opportunity to
|
||||
:language: daml
|
||||
:lines: 33-45
|
||||
|
||||
In the first transaction of the scenario, party ``bankOfEngland`` (created using ``getParty "Bank of England"``) creates an instance of the ``CallablePayout`` contract with ``alice`` as the receiver and ``bankOfEngland`` as the giver.
|
||||
In the first transaction of the scenario, party ``bankOfEngland`` (created using ``getParty "Bank of England"``) creates a ``CallablePayout`` contract with ``alice`` as the receiver and ``bankOfEngland`` as the giver.
|
||||
|
||||
When the contract is submitted to the ledger, it is given a unique contract identifier of type ``ContractId CallablePayout``. ``payAlice <-`` assigns that identifier to the variable ``payAlice``.
|
||||
|
||||
|
@ -44,7 +44,7 @@ In this case it is an identifier for the user and the list of users they are fol
|
||||
Both fields use the built-in ``Party`` type which lets us use them in the following clauses.
|
||||
|
||||
2. The signatories and observers of the contract.
|
||||
The signatories are the parties whose authorization is required to create or archive instances of the contract template, in this case the user herself.
|
||||
The signatories are the parties whose authorization is required to create or archive contracts, in this case the user herself.
|
||||
The observers are the parties who are able to view the contract on the ledger.
|
||||
In this case all users that a particular user is following are able to see the user contract.
|
||||
|
||||
|
@ -343,7 +343,7 @@ Examples
|
||||
Create a new Contract
|
||||
*********************
|
||||
|
||||
To create an instance of an ``Iou`` contract from the :doc:`Quickstart guide </app-dev/bindings-java/quickstart>`:
|
||||
To create an ``Iou`` contract from the :doc:`Quickstart guide </app-dev/bindings-java/quickstart>`:
|
||||
|
||||
.. literalinclude:: ../app-dev/bindings-java/quickstart/template-root/daml/Iou.daml
|
||||
:language: daml
|
||||
|
@ -88,7 +88,7 @@ Viewing templates or contracts
|
||||
|
||||
DAML *contract templates* are models that contain the agreement statement, all the applicable
|
||||
parameters, and the choices that can be made in acting on that data.
|
||||
They specify acceptable input and the resulting output. A contract template contains placeholders rather than actual names, amounts, dates, and so on. In a *contract instance,* the placeholders have been replaced with actual data.
|
||||
They specify acceptable input and the resulting output. A contract template contains placeholders rather than actual names, amounts, dates, and so on. In a *contract*, the placeholders have been replaced with actual data.
|
||||
|
||||
The Navigator allows you to list templates or contracts, view contracts based on a template, and view template and contract details.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user