Explore the Canton Network Application Quickstart demo¶

Contents¶

Exploring the demo

Prerequisites

Walkthrough

Next Steps

Exploring the demo¶

Explore the demo is intended to help you become familiar with a Canton Network (CN) business operation within the CN App Quickstart. The App Quickstart application is intended to be incrementally extended by your team to meet your business needs. When you are familiar with the App Quickstart, review the technology choices and application design to determine what changes are needed. Technology and design decisions are ultimately up to you.

As a result, the CN App Quickstart guides may be a little out of step with the application. If you find errors or other inconsistencies, please contact your representative at Digital Asset.

This section works through a complete business operation within the CN App Quickstart.

Prerequisites¶

You should have successfully installed the CN App Quickstart before beginning this demonstration.

If you need support accessing the JFrog Artifactory, [contact us](https://www.digitalasset.com/contact-us?comments=I%27m%20requesting%20access%20to%20jFrog).

The CN App Quickstart is a Dockerized application and requires Docker Desktop. It is recommended to allocate 8 GB of memory to properly run the required Docker containers. If you witness unhealthy containers, please consider allocating additional resources, if possible.

Walkthrough¶

The CN App Quickstart can run with or without authorization, based on your business needs. Toggle authorization with the make setup command in the quickstart subdirectory. make setup asks to enable Observability, OAUTH2, and specify a party hint. In this demo, we use the default party hint, and we show OAUTH2 as enabled and disabled. When OAUTH2 makes a difference, we display both paths one after the other. You can follow your path and ignore the other. You may enable Observability, but it is not required for this demo.

Choose your adventure:

make setup without OAUTH2:

make setup with OAUTH2:

Build and start App Quickstart:

make build; make start

Open an incognito browser.

Navigate to:

app-provider.localhost:3000

Alternatively, in the terminal, from quickstart/ run:

``make open-app-ui``

OAUTH2 disabled

When OAUTH2 is disabled, the homepage presents a simple login field. Begin by logging in as the AppProvider by entering “app-provider” in the User field.

CN App Quickstart Login screen without Auth

OAUTH2 enabled

When OAUTH2 is enabled, the homepage prompts to login with Keycloak’s OAuth 2.0 portal:

CN App Quickstart Login screen with Auth

Make a mental note that AppProvider’s username is “app-provider” and the password is “abc123” (all lowercase).

Fill in the login credentials: username: app-provider, password: abc123

The App Installs Menu

Once you are logged in select “AppInstalls” in the menu.

Open a terminal to create an app install request.

From /quickstart/ run:

``make create-app-install-request``

This command creates an App Installation Request on behalf of the Participant.

Note

If your machine is not powerful enough to host LocalNet or if the docker containers are not responsive then the response may show a failure with status code 404 or 000 (as shown in the image below). Increasing Docker memory limit to at least 8 GB should allow the LocalNet containers to operate properly.

Return to the browser.

The install request appears in the list.

Click “Accept”.

The AppInstallRequest is Accepted.

The actions update to Cancel and Create license.

Click Create License. The license is created and the “# Licenses” field is updated.

Next, navigate to the Licenses menu and select Renewals.

A “License Renewal Request” modal opens with an option to renew a license.

Click the button labeled as New to open the “Renew License” modal.

In the modal, set the number of days to renew the license, the fee, time to prepare the license, and time to settle the license. You must add a description to proceed.

“Prepare in” is an indication for the sender (app-user) that they are expected to accept allocation before that time. “Settle in” is a time that the provider has to completeRenewal. After that, the allocation will be expired.

Click Issue License Renewal Request to proceed.

Per the Daml contract, licenses are created in an expired state. To activate the license, a renewal payment request must be issued.

To make payment, navigate to the Canton Wallet at http://wallet.localhost:2000/. You can find the wallet’s location by navigating to the App Provider’s “Tenants” menu.

You should be logged in as the App-User in the Canton Wallet. Find the “Allocations” menu and accept the “Allocation Request” before the “Allocate before” time expires.

If the allocation request is accepted, a new “Allocations” section appears. This section shows the licenseFeePayment.

Return to the Quickstart as the AppProvider. In the Licenses menu, select Renewals. This opens the License Renewals Request modal. Click the green Complete Renewal button.

A confirmation appears that the license renewal completed successfully.

Log out from the AppProvider and log in as AppUser.

OAUTH2 disabled

If OAUTH2 is disabled, simply log in as app-user.

OAUTH2 enabled

When OAUTH2 is enabled, you log in using the app-user username and password.

The AppInstall now shows as accepted.

The license shows as active.

Congratulations. You’ve successfully created and activated a license with a payment allocation in Canton wallet!

Canton Console¶

The Canton Console connects to the running application ledger. The console allows a developer to bypass the UI to interact with the CN in a more direct manner. For example, in Canton Console you can connect to the Participant to see the location of the Participant and their synchronizer domain.

Activate the Canton Console in a terminal from the quickstart/ directory. Run:

make canton-console

After the console initiates, run the participants and participants.all commands, respectively.

participants

Returns a detailed categorization of participants.

participants.all

Shows a list of all participant references.

health.status

Is a diagnostic tool that displays the health of Canton Network participants.

Daml Shell¶

The Daml Shell connects to the running PQS database of the application provider’s Participant. In the Shell, the assets and their details are available in real time.

Run the shell from quickstart/ in the terminal with:

make shell

Run the following commands to see the data:

active

Shows unique identifiers and the asset count

active quickstart-licensing:Licensing.License:License

List the license details.

active quickstart-licensing:Licensing.License:LicenseRenewalRequest

Displays license renewal request details.

archives quickstart-licensing:Licensing.AppInstall:AppInstallRequest

Shows any archived license(s).

Canton Coin Scan¶

Explore the CC Scan Web UI at http://scan.localhost:4000/.

The default activity view shows the total CC balance and the Validator rewards.

Select the Network Info menu to view SV identification.

The Validators menu shows that the local validator has been registered with the SV.

Observability Dashboard¶

Note

Observability may no longer work while App Quickstart is under revisions.

In a web browser, navigate to http://localhost:3030/dashboards to view the observability dashboards. Select “Quickstart - consolidated logs”.

The default view shows a running stream of all services.

Change the services filter from “All” to “participant” to view participant logs. Select any log entry to view its details.

SV UIs¶

Navigate to http://sv.localhost:4000/ for the SV Web UI. The SV view displays data directly from the validator in a GUI that is straightforward to navigate.

The UI shows information about the SV and lists the active SVs.

The Validator Onboarding menu allows for the creation of validator onboarding secrets.

Next steps¶

You’ve completed a business operation in the CN App Quickstart and have been introduced to the basics of the Canton Console and Daml Shell.

Learn more about Daml Shell and the project structure in the Project Structure guide.