ledger.interactiveSubmissionGetPreferredPackageVersion

Issues GET /v2/interactive-submission/preferred-package-version with package-name plus repeated parties query entries when vetting resolution spans participants.

Receiver: await canton.ledger.interactiveSubmissionGetPreferredPackageVersion

Setup

import { Canton } from '@fairmint/canton-node-sdk';

const canton = new Canton({
  network: 'devnet',
  provider: '5n',
  partyId: 'OWN_PARTY_ID',
});

Minimal example

const pref = await canton.ledger.interactiveSubmissionGetPreferredPackageVersion({
  packageName: 'my-package',
  parties: [canton.getPartyId()],
  synchronizerId: 'sync-id',
});

Parameters — `InteractiveSubmissionGetPreferredPackageVersionParams`

packageName (required)
parties (optional array) — appended repeatedly as parties query parameters.
vettingValidAt (optional string) — vetting_valid_at query param when pinning temporal vetting evaluation.
synchronizerId (optional string) — forwarded as synchronizer-id.

Returns — `GetPreferredPackageVersionResponse`

Preferred packageId information aligned with Canton vetting matrix.

Errors and pitfalls

When vetting incomplete Canton responds with actionable diagnostics—inspect ApiError message bodies.

Auth and party

Same bearer credentials used elsewhere.

Source

operations/v2/interactive-submission/get-preferred-package-version.ts