Update release testing instructions to include DPM (#21990)

DPM releases aren't weekly automated, so there is no consistent version
string, or PR to comment on.
For these instructions, part of the work is to find/ensure a relevant
DPM version exists.
Success notes will be on the Daml PR for now.

The weekly testing now covers multi-package functionality, by building a
multi-package project, running the multi-ide, altering project structure
and jumping across bounds.
DPM testing uses `dpm sandbox --dar ...` over `daml sandbox`, which
requires building explicitly first. This is a small regression that
we're aware of.
Codegen commands are slightly different (`daml codegen java` vs `dpm
codegen-java`)

Author: samuel-williams-da

sdk/release/RELEASE.md

@@ -77,12 +77,9 @@ using the steps in the previous section.
 This testing procedure starts once the release is listed on the [releases
 page]. That is, _after_ the [assembly] step has finished.
 
-In the following notes, we assume that `$VERSION` contains the full version tag
-for the release you are testing - in other words, the full version as recorded
-on the Slack `#team-daml` message that is generated by the assembly repo.
-Remember that these steps are for testing the SDK within a Daml release.
+### Windows (Daml Assistant)
 
-### Windows
+1. Set $VERSION as the release version listed in the PR you approved, and in the `#team-daml` slack message.
 
 > ## Tips for Windows testing in an ad-hoc machine
 >
@@ -132,11 +129,6 @@ windows` inside the `daml-language-ad-hoc` project. This command prints IP
 > it is fully initialized; initialization is finished when the Firefox icon
 > appears on the Desktop.
 >
-> Once the Windows machine is up and running, use Firefox (in Windows) to
-> download and install `daml-sdk-$VERSION-windows.exe` from the [releases
->
-> > page] (please ensure `$VERSION` is expanded correctly!.
->
 > Ad-hoc machines come with VSCode and OpenJDK preinstalled.
 >
 > NOTE 2: After logging in, **it takes some time for the machine to be
@@ -162,27 +154,95 @@ windows` inside the `daml-language-ad-hoc` project. This command prints IP
 1. Run `daml version --assistant=yes` and verify that the new version is
    selected as the assistant version and the default version for new projects.
 
-1. Run `daml new myproject` to create a new project and switch to it using
-   `cd myproject`.
+1. Run `daml new myproject --template multi-package-example` to create a new project and switch to its main package using
+   `cd myproject/main`.
 
 1. Run `daml start`. Wait for the yellow message confirming the sandbox is ready for use.
 
 1. Kill `daml start` with `Ctrl-C` (followed by "y" because Windows).
 
-1. Run `daml studio --replace=always` and open `daml/Main.daml`. Verify that
-   there is a `Script results` link on top of the script, click on it, and
+1. Build all packages by moving out of the main package (`cd ..`) and running `daml build --all`.
+   (The first line should say `Running multi-package build of all packages in <location>`)
+
+1. Run `daml studio --replace=always` and open `test/daml/Test.daml`. Verify that there is a `Script results` link above `main` (in the code), click on it, and
    verify that the script result appears within 30 seconds.
 
-1. Add `+` at the end of line 26 after `(PartyIdHint "Alice")` and verify that
-   you get an error on line 27.
+1. Add `+` at the end of line 11 after `allocateParty "Alice"`, verify that
+   you get an error on line 12, then remove the `+`.
+
+1. Right click `IOU` in `... createCmd Main.IOU with ...` on line 12 and click Go to definition.
+  1. Verify you are taken to main/daml/Main.daml (and not somewhere in a `.daml` directory)
+
+1. Close the `Main.daml` tab, open `multi-package.yaml`, remove `- ./main`, save the file, then go to definition on IOU again as per previous instruction.
+  1. Verify that now (after a small delay), you are taken to a copy of `Main.daml` in a `.daml` directory at the root of the workspace.
+
+1. Close VSCode and delete the `myproject` directory ready for DPM testing using:
+  `cd .. && rmdir /S /Q myproject`
+
+1. On the [assembly] PR, add the comment:
+
+   > Manual tests passed on Windows using Daml Assistant.
+
+# Windows (DPM)
+
+You will now also need to test the release using DPM, please follow the instructions below (they look similar, but have small tweaks, don't reuse commands from the Daml Assistant section above).
+**ONLY RUN THESE STEPS FOR 3.4+ VERSIONS RELEASED AFTER 2025/09/22**
+
+1. DPM snapshots are usually published under a different name, and via a different mechanism. For weekly testing, you may not know what this different version string is.
+   Use the following to install the DPM sdk on windows.
+   If you do not know the version string, and are testing the weekly release, go to this URL for the latest SDK:
+   ```
+   https://get.digitalasset-staging.com/install/latest-windows.html
+   ```
+   If you do know the version string, interpolate it into this string as `${version}` and go to the resulting URL:
+   ```
+   https://get.digitalasset.com/install/windows/dpm-${version}-windows-amd64.exe
+
+   ```
+   If running `dpm` fails with a "cannot find command" error, inform the language team on #team-daml-language, and then proceed with testing by running `setx /M PATH "%PATH%;%APPDATA%\dpm\bin"` in an administrator command prompt and restarting your existing terminals.
+
+1. Run `dpm versions` and verify the (green) version is what you expect. If you used the latest-download URL to get DPM and thus don't know what version to expect, ensure it is less than a week old for weekly testing.
+
+1. Run `dpm versions` and verify the (green) version is what you expect. If you did not know what version to expect, ensure it is less than a week old for weekly testing.
+   (If it is too old, leave a message about this in #project-dpm and pause testing until you get a response. #project-dpm is US based so consider this for timezones.)
+
+1. On the [assembly] PR, add the comment (replacing $VERSION with the active DPM version string from above):
+
+   > Testing using DPM Version: $VERSION
+
+1. Run `dpm new myproject --template multi-package-example` to create a new project and switch to it
+   `cd myproject`.
+
+1. Build all packages by running `dpm build --all`.
+   (The first line should say `Running multi-package build of all packages in <location>`)
+
+1. Run `dpm sandbox --dar ./main/.daml/dist/myproject-main-1.0.0.dar`. Wait for "Canton sandbox is ready." (it may take up to around 2 minutes)
+
+1. Kill `dpm sandbox` with `Ctrl-C` (followed by "y" because Windows).
+
+1. Run `dpm studio --replace=always` and open `test/daml/Test.daml`. Verify that there is a `Script results` link above `main` (in the code), click on it, and
+   verify that the script result appears within 30 seconds.
+
+1. Add `+` at the end of line 11 after `allocateParty "Alice"`, verify that
+   you get an error on line 12, then remove the `+`.
+
+1. Right click `IOU` in `... createCmd Main.IOU with ...` on line 12 and click Go to definition.
+  1. Verify you are taken to main/daml/Main.daml (and not somewhere in a `.daml` directory)
+
+1. Close the `Main.daml` tab, open `multi-package.yaml`, remove `- ./main`, save the file, then go to definition on IOU again as per previous instruction
+  1. Verify that now (after a small delay), you are taken to a copy of `Main.daml` in a `.daml` directory at the root of the workspace.
+
+1. Close VSCode
 
 1. On the [assembly] PR, add the comment:
 
-   > Manual tests passed on Windows.
+   > Manual tests passed on Windows using DPM.
 
 1. Destroy your Windows VM.
 
-### Linux/macOS
+### Linux/macOS (Daml Assistant)
+
+1. Set $VERSION as the release version listed in the PR you approved, and in the `#team-daml` slack message.
 
 1. Run:
 
@@ -271,11 +331,21 @@ windows` inside the `daml-language-ad-hoc` project. This command prints IP
 
 1. Kill the processes running in Terminals 1 and 2 using CTRL-C.
 
+1. Delete the quickstart project, create a new project using
+  ```
+  daml new myproject --template multi-package-example
+  ```
+  then cd into it.
+
+1. Build it using `daml build --all`
+   (The first line should say `Running multi-package build of all packages in <location>`)
+
 1. Run `daml studio --replace=always`. This should open VSCode and trigger the
    Daml extension that's bundled with the new SDK version (the new VSCode
    extension will not be in the marketplace at this point). Verify by checking
    the version listed under "Installation" matches the version of the sdk bundled
-   in the snapshot.
+   in the snapshot (described in the description of the overall release 
+   here https://github.com/digital-asset/daml/releases).
 
    > Note: when running `daml studio --replace=always`, you force the installation
    > of the VSCode extension bundled with the Daml SDK, and _disable the
@@ -286,28 +356,166 @@ windows` inside the `daml-language-ad-hoc` project. This command prints IP
    > daml studio --replace=published
    > ```
 
-1. Open `daml/Main.daml`.
+1. Open `test/daml/Test.daml`.
 
-1. Click on `Script results` above `initialize` (in the code) and wait for the
+1. Click on `Script results` above the script and wait for the
    script results to appear.
 
-1. Add `+` at the end of line 14, after `(PartyIdHint "Alice")` and confirm you
-   get an error in line 15.
+1. Add `+` at the end of line 11 after `allocateParty "Alice"` and verify that
+   you get an error on line 12.
+
+1. Right click `IOU` in `... createCmd Main.IOU with ...` on line 12 and click Go to definition.
+  1. Verify you are taken to main/daml/Main.daml (and not somewhere in a `.daml` directory)
+
+1. Close the `Main.daml` tab, open `multi-package.yaml`, remove `- ./main`, save the file, then go to definition on IOU again as per previous instruction.
+  1. Verify that now (after a small delay), you are taken to a copy of `Main.daml` in a `.daml` directory at the root of the workspace.
+
+1. Close VSCode and delete the `myproject` directory ready for DPM testing using:
+  `cd .. && rm -rf myproject`
+
+1. On the [assembly] PR, add the comment:
+
+   > Manual tests passed on [Linux/macOS] using Daml Assistant.
+
+   specifying which platform you tested on.
+
+### Linux/macOS (DPM)
+
+You will now also need to test the release using DPM, please follow the instructions below (they look similar, but have small tweaks, don't reuse commands from the Daml Assistant section above).
+**ONLY RUN THESE STEPS FOR 3.4+ VERSIONS RELEASED AFTER 2025/09/22**
+
+1. DPM snapshots are usually published under a different name, and via a different mechanism. For weekly testing, you may not know what this different version string is.
+   Use the following to install the DPM sdk on windows.
+   If you do not know the version string, and are testing the weekly release, use this command to install the latest SDK
+   ```
+   curl -sSL https://get.digitalasset.com/install/install.sh
+   ```
+   If you do know the version string, interpolate it into this string as `$VERSION` and run the resulting command:
+   ```
+   curl -sSL https://get.digitalasset.com/install/install.sh | sh -s "$VERSION"
+   ```
+
+1. Make sure you have the prerequisites for running the tests:
+
+   - [Visual Studio Code, Java-SDK](https://docs.daml.com/getting-started/installation.html)
+   - [Maven](https://maven.apache.org)
+
+1. Run `dpm versions` and verify the (green) version is what you expect. If you did not know what version to expect, ensure it is less than a week old for weekly testing.
+   (If it is too old, leave a message about this in #project-dpm and pause testing until you get a response. #project-dpm is US based so consider this for timezones.)
+   (If the version you need is listed but not green, run `rm -rf ~/.dpm` then run the installation again)
+
+1. Create a new project with `dpm new quickstart --template quickstart-java`
+   and switch to it using `cd quickstart`.
+
+1. Verify the new version is specified in `daml.yaml` as the `sdk-version`.
+
+1. Build the package by running `dpm build`.
+
+1. In 3 separate terminals (each being in the `quickstart-java` project directory), run:
+
+   1. In Terminal 1, run:
+
+      ```sh
+      dpm sandbox --dar ./.daml/dist/quickstart-0.0.1.dar
+      ```
+      Wait for "Canton sandbox is ready."
+
+   1. In Terminal 2, run each of the following:
+
+      ```sh
+      dpm script --ledger-host localhost --ledger-port 6865 --dar .daml/dist/quickstart-0.0.1.dar --script-name Main:initialize --output-file output.json
+      ```
+
+      ```sh
+      dpm codegen-java && mvn compile exec:java@run-quickstart -Dparty=$(cat output.json | sed 's/\[\"//' | sed 's/".*//')
+      ```
+
+   1. In Terminal 3, run:
+
+      ```sh
+      cat output.json
+      ```
+
+      and verify that the output looks like this:
+
+      ```json
+      ["Alice::NAMESPACE", "EUR_Bank::NAMESPACE"]
+      ```
+
+      where `NAMESPACE` is some randomly generated series of hex digits.
+
+      Note that this step scrapes the `Alice::NAMESPACE` party name from the `output.json` produced in the previous steps.
+
+   1. Still in Terminal 3, run:
+
+      ```sh
+      curl http://localhost:8080/iou
+      ```
+
+      and verify that the output looks like:
+
+      ```json
+      {
+        "0": {
+          "issuer": "EUR_Bank::NAMESPACE",
+          "owner": "Alice::NAMESPACE",
+          "currency": "EUR",
+          "amount": 100.0,
+          "observers": []
+        }
+      }
+      ```
+
+      where NAMESPACE is the same series of hex digits as in the previous step.
+
+1. Kill the processes running in Terminals 1 and 2 using CTRL-C.
+
+1. Delete the quickstart project, create a new project using
+  ```
+  dpm new myproject --template multi-package-example
+  ```
+  then cd into it.
+
+1. Build it using `dpm build --all`
+   (The first line should say `Running multi-package build of all packages in <location>`)
+
+1. Run `dpm studio --replace=always`. This should open VSCode and trigger the
+   Daml extension that's bundled with the new SDK version (the new VSCode
+   extension will not be in the marketplace at this point). Verify by checking
+   the version listed under "Installation". It is difficult to find the exact
+   version string this should be, simply verify it is within a few days
+   of the SDK version you installed. (using the YYYYMMDD timestamp in the string)
+
+   > Note: when running `dpm studio --replace=always`, you force the installation
+   > of the VSCode extension bundled with the Daml SDK, and _disable the
+   > auto-upgrade mechanism in VSCode_. To instruct VSCode to go back to the
+   > published version of the extension, including auto-upgrades, you can run
+   >
+   > ```
+   > dpm studio --replace=published
+   > ```
+   > Also note that Studio will use `Daml` or `Dpm` based on the last studio command you ran
+   > If you want to switch your default assistant back to `Daml`, run `daml studio --replace=published`.
+
+1. Open `test/daml/Test.daml`.
+
+1. Click on `Script results` above the script and wait for the
+   script results to appear.
 
-1. Add `1` after the `+` and confirm you get a type error in line 14, which
-   says that `Script Party` does not match `Int`.
+1. Add `+` at the end of line 11 after `allocateParty "Alice"` and verify that
+   you get an error on line 12.
 
-1. Delete the `+1` and the `e` in `"Alice"` and verify that the
-   script results are updated to the misspelled name.
+1. Right click `IOU` in `... createCmd Main.IOU with ...` on line 12 and click Go to definition.
+  1. Verify you are taken to main/daml/Main.daml (and not somewhere in a `.daml` directory)
 
-1. Right click on `eurBank` in line 28 and verify that "Go to Definition" takes
-   you to the definition in line 17.
+1. Close the `Main.daml` tab, open `multi-package.yaml`, remove `- ./main`, save the file, then go to definition on IOU again as per previous instruction.
+  1. Verify that now (after a small delay), you are taken to a copy of `Main.daml` in a `.daml` directory at the root of the workspace.
 
-1. Close VS Code.
+1. Close VSCode.
 
 1. On the [assembly] PR, add the comment:
 
-   > Manual tests passed on [Linux/macOS].
+   > Manual tests passed on [Linux/macOS] using DPM.
 
    specifying which platform you tested on.
 

sdk/templates/multi-package-example/interfaces/daml.yaml.template

@@ -8,4 +8,4 @@ version: 1.0.0
 dependencies:
   - daml-prim
   - daml-stdlib
-  - daml-script-lts
+  - daml-script

sdk/templates/multi-package-example/main/daml.yaml.template

@@ -8,6 +8,6 @@ version: 1.0.0
 dependencies:
   - daml-prim
   - daml-stdlib
-  - daml-script-lts
+  - daml-script
 data-dependencies:
   - ../interfaces/.daml/dist/__PROJECT_NAME__-interfaces-1.0.0.dar

sdk/templates/multi-package-example/test/daml.yaml.template

@@ -8,7 +8,7 @@ version: 1.0.0
 dependencies:
   - daml-prim
   - daml-stdlib
-  - daml-script-lts
+  - daml-script
 data-dependencies:
   - ../interfaces/.daml/dist/__PROJECT_NAME__-interfaces-1.0.0.dar
   - ../main/.daml/dist/__PROJECT_NAME__-main-1.0.0.dar