Upgrade Guide

DAML Package Upgrade Guide

Quick reference for upgrading DAML packages.

This repository (open-captable-protocol-daml)

Multi-package

multi-package.yaml lists OpenCapTable-v35 and Test.

Commands

Major version (new folder, e.g. OpenCapTable-v34 → OpenCapTable-v35):

npm run upgrade-package -- --package OpenCapTable --type major

The script resolves OpenCapTable to the versioned folder OpenCapTable-vNN (highest NN).

Minor version (patch bump in OpenCapTable-v35/daml.yaml):

npm run upgrade-package -- --package OpenCapTable --type minor

What gets changed

Major

• Folder renamed (e.g. OpenCapTable-v34/ → OpenCapTable-v35/)
• daml.yaml name and version updated
• Search/replace of version strings across the repo (per scripts/upgrade-package.ts)

Minor

• daml.yaml patch version in the package folder
• References to OpenCapTable-v35-x.y.z DAR strings updated where present

Workflow

1. Run the upgrade script (or edit daml.yaml for a one-off patch).
2. git diff / review.
3. npm run build && npm run test (and npm run codegen / npm run verify-package if you publish JS).
4. If an npm publish is needed: bump the root package.json version, merge to main, then push a package-scoped release tag per Package-Tag-Release-Process (e.g. OpenCapTable-v35-v0.0.1).

Script details

See scripts/upgrade-package.ts.

---

Other Fairmint DAML (fairmint/daml)

Upgrades for Shared, Reports, NFT, CantonPayments, equity certificate, CouponMinter, etc. happen in fairmint/daml — not in this tree (after #216).