getLockedAmuletsForParty

getLockedAmuletsForParty calls validatorClient.getAmulets(), walks locked_amulets, parses nested amulet / lock payload fields into LockedAmulet, then filters where owner matches ownerPartyId case-insensitively.

Use this when coordinating custody locks or liquidity tooling that lives behind validator-enriched wallet snapshots rather than plain ACS reads.

Setup

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

const canton = new Canton({
  network: 'NETWORK_NAME',
  partyId: 'PARTY_ID',
});

Minimal example

const locked = await getLockedAmuletsForParty(canton.validator, 'OWNER_PARTY_ID');
console.log(locked.map((entry) => entry.contractId));

Parameters

validatorClient (required, ValidatorApiClient) — Authenticated validator client (canton.validator).
ownerPartyId (required, string) — Party whose LockedAmulet rows should survive filtering.

Returns

Promise<LockedAmulet[]> — Structured rows with contractId, templateId, owner, holders, lockExpiresAt, effectiveAmount, domainId, createdEventBlob.

Errors

Throws ValidationError when mandatory nested strings are missing or effective_amount fails numeric validation during normalization.

Auth and party

Requires validator credentials sufficient for getAmulets. Filtering uses your supplied ownerPartyId, independent of the SDK acting party unless you align them deliberately.

Source

src/utils/amulet/get-locked-amulets.ts