Quickstart tutorial #802

TheChronicMonster · 2024-09-25T15:39:16Z

The single-domain quickstart tutorial to guide enterprise developers through an introduction of the daml-app-template.

carrielaben-da

Just a few small changes. Thanks!

carrielaben-da · 2024-09-27T14:02:51Z

docs/2.10.0/docs/single-domain/build-backend.rst

+
+   *Ignore these substeps if Gradle builds successfully.*
+
+   If you possess a Daml enterprise license and the output returns errors such as:


Suggested change

If you possess a Daml enterprise license and the output returns errors such as:

If you have a Daml enterprise license and the output returns errors like:

carrielaben-da · 2024-09-27T14:03:19Z

docs/2.10.0/docs/single-domain/build-backend.rst

+      Forbidden for user.
+      Could not resolve all files for configuration.
+
+   Then email [email protected] with your Artifactory username and the error message.


Suggested change

Then email [email protected] with your Artifactory username and the error message.

Email [email protected] with your Artifactory username and the error message.

carrielaben-da · 2024-09-27T14:53:30Z

docs/2.10.0/docs/single-domain/build-backend.rst

+   .. image:: images/daml-scribe-assemble-gradlew-error.png
+      :alt: Gradle could not get resource example
+
+   You can verify your Artifactory username and password have been correctly integrated into the app with a credential request command:


Suggested change

You can verify your Artifactory username and password have been correctly integrated into the app with a credential request command:

You can verify that your Artifactory username and password have been correctly integrated into the app with a credential request command:

carrielaben-da · 2024-09-27T14:54:27Z

docs/2.10.0/docs/single-domain/build-backend.rst

+      .. image:: images/failed-to-connect-messages.png
+         :alt: Bootrun running output
+
+The backend is now operational! You're ready to build the frontend!


Suggested change

The backend is now operational! You're ready to build the frontend!

The backend is now operational! You are ready to build the frontend!

carrielaben-da · 2024-09-27T15:59:16Z

docs/2.10.0/docs/single-domain/demo.rst

+   .. note::
+      Incognito mode is recommended to avoid browser caching issues.
+
+   For convenience, split the browsers side by side, either horizontally or vertically, based on your preference.


Suggested change

For convenience, split the browsers side by side, either horizontally or vertically, based on your preference.

Split the browsers side by side, horizontally or vertically, for convenience.

carrielaben-da · 2024-09-27T19:43:18Z

docs/2.10.0/docs/single-domain/extend-frontend.rst

+    import { ContractId } from '@daml/types';
+    import useLedgerApiClient from '../queries/useLedgerApiClient';
+
+The ``useLedgerApiClient`` import calls the query hook by the same name to access the Daml ledger API client. The client enables the React hook to update the Daml :doc:`ledger state </getting-started/app-architecture>`. In this event, to exercise the ``RejectWithReason`` choice in the Daml model.


Suggested change

The ``useLedgerApiClient`` import calls the query hook by the same name to access the Daml ledger API client. The client enables the React hook to update the Daml :doc:`ledger state </getting-started/app-architecture>`. In this event, to exercise the ``RejectWithReason`` choice in the Daml model.

The ``useLedgerApiClient`` import calls the query hook by the same name to access the Daml ledger API client. The client enables the React hook to update the Daml :doc:`ledger state </getting-started/app-architecture>` - in this event, to exercise the ``RejectWithReason`` choice in the Daml model.

carrielaben-da · 2024-09-27T20:25:06Z

docs/2.10.0/docs/single-domain/extend-model.rst

+   daml-app-template ~ % daml studio
+
+.. note::
+   ``daml studio`` should automatically install the :doc:`Daml Studio </daml/daml-studio>` extension in Visual Studio. The extension assists Daml app development. You can double-check that the extension is installed by opening the extension menu and searching for "Daml studio."


Suggested change

``daml studio`` should automatically install the :doc:`Daml Studio </daml/daml-studio>` extension in Visual Studio. The extension assists Daml app development. You can double-check that the extension is installed by opening the extension menu and searching for "Daml studio."

``daml studio`` should automatically install the :doc:`Daml Studio </daml/daml-studio>` extension in Visual Studio. The extension assists Daml app development. You can double-check that the extension is installed by opening the extension menu and searching for "Daml Studio."

carrielaben-da · 2024-09-27T22:40:35Z

docs/2.10.0/docs/single-domain/extend-model.rst

+            unlockedCid <- unlockAndRemoveObservers (S.fromList [provider, sender]) receiver lockedTransferableCid
+            return (rejectedOfferCid, unlockedCid)
+
+   This choice takes a reason for the rejection, and ensures that the receiver controls the choice and that the transfer offer contract has not expired. When the choice is exercised a new "RejectedTransferOffer" contract is created that subsequently unlocks the assets that were to be transferred, and removes the provider and sender as observers. This choice contains a handful of interesting Daml-specific items:


Suggested change

This choice takes a reason for the rejection, and ensures that the receiver controls the choice and that the transfer offer contract has not expired. When the choice is exercised a new "RejectedTransferOffer" contract is created that subsequently unlocks the assets that were to be transferred, and removes the provider and sender as observers. This choice contains a handful of interesting Daml-specific items:

This choice takes a reason for the rejection and ensures that the receiver controls the choice and that the transfer offer contract has not expired. When the choice is exercised a new "RejectedTransferOffer" contract is created that then unlocks the assets that were to be transferred and removes the provider and sender as observers. This choice contains a handful of Daml-specific items:

carrielaben-da · 2024-09-28T00:21:09Z

docs/2.10.0/docs/single-domain/extend-overview.rst

+Extend the Application
+======================
+
+Alice can accept a transfer offer from the provider. However, it's possible that Alice, or any other user, may want to reject a transfer offer. For example, the provider may offer an incorrect amount, or the user may decide to reject the transfer for another reason. The remainder of this guide demonstrates how to extend the single-domain Daml application using an example scenario.


Suggested change

Alice can accept a transfer offer from the provider. However, it's possible that Alice, or any other user, may want to reject a transfer offer. For example, the provider may offer an incorrect amount, or the user may decide to reject the transfer for another reason. The remainder of this guide demonstrates how to extend the single-domain Daml application using an example scenario.

Alice can accept a transfer offer from the provider. However, Alice, or any other user, may want to reject a transfer offer. For example, the provider may offer an incorrect amount, or the user may reject the transfer for another reason. The remainder of this guide demonstrates how to extend the single-domain Daml application to reject a transfer offer and record the reason for the rejection.

carrielaben-da · 2024-09-28T00:27:49Z

docs/2.10.0/docs/single-domain/install.rst

+   .. image:: images/DAML_SDK_RELEASE_VERSION.png
+      :alt: Daml SDK version example
+
+2. After installation, add Daml to your PATH in your shell configuration file (``.zshrc`` or ``.bashrc`` depending on your system) if it wasn't added automatically:


Suggested change

2. After installation, add Daml to your PATH in your shell configuration file (``.zshrc`` or ``.bashrc`` depending on your system) if it wasn't added automatically:

2. After installation, add Daml to your PATH in your shell configuration file (``.zshrc`` or ``.bashrc`` depending on your system) if it was not added automatically:

yves-da · 2024-10-18T06:40:35Z

Hi @TheChronicMonster
Can you please merge your PR, if it's done? Thanks!

hrischuk-da · 2024-10-25T12:35:01Z

This needs to be released when the ref app template goes public. Working through the OSS checklist. Could use some help :)

TheChronicMonster added 2 commits September 20, 2024 10:25

feat: quick tutorial

4dce7a3

feat: single-domain quickstart guide

760e755

TheChronicMonster requested a review from carrielaben-da September 25, 2024 15:39

TheChronicMonster assigned carrielaben-da Sep 25, 2024

TheChronicMonster requested review from a team as code owners September 25, 2024 15:39

fix: code block line numbers

eee88d6

carrielaben-da approved these changes Sep 28, 2024

View reviewed changes

edit: minor copy revisions

ac70b8a

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quickstart tutorial #802

Quickstart tutorial #802

TheChronicMonster commented Sep 25, 2024

carrielaben-da left a comment

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 27, 2024

carrielaben-da Sep 28, 2024

carrielaben-da Sep 28, 2024

yves-da commented Oct 18, 2024

hrischuk-da commented Oct 25, 2024


		Ignore these substeps if Gradle builds successfully.

		If you possess a Daml enterprise license and the output returns errors such as:

	If you possess a Daml enterprise license and the output returns errors such as:
	If you have a Daml enterprise license and the output returns errors like:

	Then email [email protected] with your Artifactory username and the error message.
	Email [email protected] with your Artifactory username and the error message.

	You can verify your Artifactory username and password have been correctly integrated into the app with a credential request command:
	You can verify that your Artifactory username and password have been correctly integrated into the app with a credential request command:

	The backend is now operational! You're ready to build the frontend!
	The backend is now operational! You are ready to build the frontend!

	For convenience, split the browsers side by side, either horizontally or vertically, based on your preference.
	Split the browsers side by side, horizontally or vertically, for convenience.

	The ``useLedgerApiClient`` import calls the query hook by the same name to access the Daml ledger API client. The client enables the React hook to update the Daml :doc:`ledger state </getting-started/app-architecture>`. In this event, to exercise the ``RejectWithReason`` choice in the Daml model.
	The ``useLedgerApiClient`` import calls the query hook by the same name to access the Daml ledger API client. The client enables the React hook to update the Daml :doc:`ledger state </getting-started/app-architecture>` - in this event, to exercise the ``RejectWithReason`` choice in the Daml model.

	``daml studio`` should automatically install the :doc:`Daml Studio </daml/daml-studio>` extension in Visual Studio. The extension assists Daml app development. You can double-check that the extension is installed by opening the extension menu and searching for "Daml studio."
	``daml studio`` should automatically install the :doc:`Daml Studio </daml/daml-studio>` extension in Visual Studio. The extension assists Daml app development. You can double-check that the extension is installed by opening the extension menu and searching for "Daml Studio."

	Alice can accept a transfer offer from the provider. However, it's possible that Alice, or any other user, may want to reject a transfer offer. For example, the provider may offer an incorrect amount, or the user may decide to reject the transfer for another reason. The remainder of this guide demonstrates how to extend the single-domain Daml application using an example scenario.
	Alice can accept a transfer offer from the provider. However, Alice, or any other user, may want to reject a transfer offer. For example, the provider may offer an incorrect amount, or the user may reject the transfer for another reason. The remainder of this guide demonstrates how to extend the single-domain Daml application to reject a transfer offer and record the reason for the rejection.

	2. After installation, add Daml to your PATH in your shell configuration file (``.zshrc`` or ``.bashrc`` depending on your system) if it wasn't added automatically:
	2. After installation, add Daml to your PATH in your shell configuration file (``.zshrc`` or ``.bashrc`` depending on your system) if it was not added automatically:

Quickstart tutorial #802

Are you sure you want to change the base?

Quickstart tutorial #802

Conversation

TheChronicMonster commented Sep 25, 2024

carrielaben-da left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yves-da commented Oct 18, 2024

hrischuk-da commented Oct 25, 2024